From 469fef1365b8e8b6529c3a4f88e5be979db15bc3 Mon Sep 17 00:00:00 2001 From: Rafael Guterres Jeffman <rjeffman@redhat.com> Date: Thu, 23 Sep 2021 16:09:55 -0300 Subject: [PATCH] Documentation: Update modules README with ldap_cache variable. This patch adds documentation for ldap_cache variable to all modules. --- README-automember.md | 1 + README-automountlocation.md | 1 + README-config.md | 1 + README-delegation.md | 1 + README-dnsconfig.md | 1 + README-dnsforwardzone.md | 1 + README-dnsrecord.md | 1 + README-dnszone.md | 1 + README-group.md | 1 + README-hbacrule.md | 1 + README-hbacsvc.md | 1 + README-hbacsvcgroup.md | 1 + README-host.md | 1 + README-hostgroup.md | 1 + README-location.md | 1 + README-permission.md | 1 + README-privilege.md | 1 + README-pwpolicy.md | 1 + README-role.md | 1 + README-selfservice.md | 1 + README-server.md | 1 + README-service.md | 1 + README-sudocmd.md | 1 + README-sudocmdgroup.md | 1 + README-sudorule.md | 1 + README-topology.md | 2 ++ README-trust.md | 1 + README-user.md | 1 + README-vault.md | 1 + 29 files changed, 30 insertions(+) diff --git a/README-automember.md b/README-automember.md index 0d2861e4..42fc4aca 100644 --- a/README-automember.md +++ b/README-automember.md @@ -123,6 +123,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` | Automember rule. | yes `description` | A description of this auto member rule. | no `automember_type` | Grouping to which the rule applies. It can be one of `group`, `hostgroup`. | yes diff --git a/README-automountlocation.md b/README-automountlocation.md index 42393bc1..6acb4f5b 100644 --- a/README-automountlocation.md +++ b/README-automountlocation.md @@ -105,6 +105,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` \| `location` | List of one or more automountlocation names. | yes `state` | The state to ensure. It can be one of `present`, or `absent`, default: `present`. | no diff --git a/README-config.md b/README-config.md index a756f67b..5f05fd9d 100644 --- a/README-config.md +++ b/README-config.md @@ -92,6 +92,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `maxusername` \| `ipamaxusernamelength` | Set the maximum username length (1 to 255) | no `maxhostname` \| `ipamaxhostnamelength` | Set the maximum hostname length between 64-255. Only usable with IPA versions 4.8.0 and up. | no `homedirectory` \| `ipahomesrootdir` | Set the default location of home directories | no diff --git a/README-delegation.md b/README-delegation.md index 00d84388..643a1633 100644 --- a/README-delegation.md +++ b/README-delegation.md @@ -143,6 +143,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `aciname` | The list of delegation name strings. | yes `permission` \| `permissions` | The permission to grant `read`, `read,write`, `write`]. Default is `write`. | no `attribute` \| `attrs` | The attribute list to which the delegation applies. | no diff --git a/README-dnsconfig.md b/README-dnsconfig.md index f7e733fb..33ed76f5 100644 --- a/README-dnsconfig.md +++ b/README-dnsconfig.md @@ -127,6 +127,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `forwarders` | The list of forwarders dicts. Each `forwarders` dict entry has:| no | `ip_address` - The IPv4 or IPv6 address of the DNS server. | yes | `port` - The custom port that should be used on this server. | no diff --git a/README-dnsforwardzone.md b/README-dnsforwardzone.md index cd5b5cc5..e1ff1db0 100644 --- a/README-dnsforwardzone.md +++ b/README-dnsforwardzone.md @@ -108,6 +108,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` | Zone name (FQDN). | yes if `state` == `present` `forwarders` \| `idnsforwarders` | Per-zone forwarders. A custom port can be specified for each forwarder. Options | no | `ip_address`: The forwarder IP address. | yes diff --git a/README-dnsrecord.md b/README-dnsrecord.md index 35c3614c..99beffbb 100644 --- a/README-dnsrecord.md +++ b/README-dnsrecord.md @@ -250,6 +250,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `zone_name` \| `dnszone` | The DNS zone name to which DNS record needs to be managed. You can use one global zone name for multiple records. | no required: true `records` | The list of dns records dicts. Each `records` dict entry can contain **record variables**. | no diff --git a/README-dnszone.md b/README-dnszone.md index 544b86ef..4118a97a 100644 --- a/README-dnszone.md +++ b/README-dnszone.md @@ -203,6 +203,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `zone_name` | The zone name string or list of strings. | no `name_from_ip` | Derive zone name from reverse of IP (PTR). Can only be used with `state: present`. | no `forwarders` | The list of forwarders dicts. Each `forwarders` dict entry has:| no diff --git a/README-group.md b/README-group.md index 662fcd01..c3a27002 100644 --- a/README-group.md +++ b/README-group.md @@ -155,6 +155,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` | The list of group name strings. | no `description` | The group description string. | no `gid` \| `gidnumber` | The GID integer. | no diff --git a/README-hbacrule.md b/README-hbacrule.md index fee62820..d246c8c9 100644 --- a/README-hbacrule.md +++ b/README-hbacrule.md @@ -137,6 +137,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` | The list of hbacrule name strings. | yes `description` | The hbacrule description string. | no `usercategory` \| `usercat` | User category the rule applies to. Choices: ["all", ""] | no diff --git a/README-hbacsvc.md b/README-hbacsvc.md index 49644b8f..21d0f735 100644 --- a/README-hbacsvc.md +++ b/README-hbacsvc.md @@ -99,6 +99,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` \| `service` | The list of hbacsvc name strings. | no `description` | The hbacsvc description string. | no `state` | The state to ensure. It can be one of `present` or `absent`, default: `present`. | no diff --git a/README-hbacsvcgroup.md b/README-hbacsvcgroup.md index c2beae41..4c9cb118 100644 --- a/README-hbacsvcgroup.md +++ b/README-hbacsvcgroup.md @@ -137,6 +137,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` | The list of hbacsvcgroup name strings. | no `description` | The hbacsvcgroup description string. | no `nomembers` | Suppress processing of membership attributes. (bool) | no diff --git a/README-host.md b/README-host.md index 32a0c018..064b2478 100644 --- a/README-host.md +++ b/README-host.md @@ -321,6 +321,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `fqdn` | The list of host name strings. `name` with *host variables* or `hosts` containing *host variables* need to be used. | no **Host variables** | Only used with `name` variable in the first level. | no `hosts` | The list of host dicts. Each `hosts` dict entry can contain **host variables**.<br>There is one required option in the `hosts` dict:| no diff --git a/README-hostgroup.md b/README-hostgroup.md index e97136ca..9c50a271 100644 --- a/README-hostgroup.md +++ b/README-hostgroup.md @@ -151,6 +151,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` | The list of hostgroup name strings. | no `description` | The hostgroup description string. | no `nomembers` | Suppress processing of membership attributes. (bool) | no diff --git a/README-location.md b/README-location.md index 203ba254..f551632f 100644 --- a/README-location.md +++ b/README-location.md @@ -82,6 +82,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `idnsname` | The list of location name strings. | yes `description` | The IPA location string | false `state` | The state to ensure. It can be one of `present`, `absent`, default: `present`. | no diff --git a/README-permission.md b/README-permission.md index 950e6ff0..88f1c410 100644 --- a/README-permission.md +++ b/README-permission.md @@ -162,6 +162,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` | The permission name string. | yes `right` \| `ipapermright` | Rights to grant. It can be a list of one or more of `read`, `search`, `compare`, `write`, `add`, `delete`, and `all` default: `all` | no `attrs` | All attributes to which the permission applies. | no diff --git a/README-privilege.md b/README-privilege.md index 3b2537f8..ae02ff7a 100644 --- a/README-privilege.md +++ b/README-privilege.md @@ -134,6 +134,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin`. | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node. | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` | The list of privilege name strings. | yes `description` | Privilege description. | no `rename` \| `new_name` | Rename the privilege object. | no diff --git a/README-pwpolicy.md b/README-pwpolicy.md index 94811596..d3cf2642 100644 --- a/README-pwpolicy.md +++ b/README-pwpolicy.md @@ -99,6 +99,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` | The list of pwpolicy name strings. If name is not given, `global_policy` will be used automatically. | no `maxlife` \| `krbmaxpwdlife` | Maximum password lifetime in days. (int) | no `minlife` \| `krbminpwdlife` | Minimum password lifetime in hours. (int) | no diff --git a/README-role.md b/README-role.md index fc915c2b..fb9e2799 100644 --- a/README-role.md +++ b/README-role.md @@ -246,6 +246,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` | The list of role name strings. | yes `description` | A description for the role. | no `rename` \| `new_name` | Rename the role object. | no diff --git a/README-selfservice.md b/README-selfservice.md index 8bfa8352..87a83591 100644 --- a/README-selfservice.md +++ b/README-selfservice.md @@ -139,6 +139,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `aciname` | The list of selfservice name strings. | yes `permission` \| `permissions` | The permission to grant `read`, `read,write`, `write`]. Default is `write`. | no `attribute` \| `attrs` | The attribute list to which the selfservice applies. | no diff --git a/README-server.md b/README-server.md index 34d2edad..d1a4f78f 100644 --- a/README-server.md +++ b/README-server.md @@ -250,6 +250,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` | The list of server name strings. | yes `location` \| `ipalocation_location` | The server location string. Only in state: present. "" for location reset. | no `service_weight` \| `ipaserviceweight` | Weight for server services. Type Values 0 to 65535, -1 for weight reset. Only in state: present. (int) | no diff --git a/README-service.md b/README-service.md index 0cc6b879..f59b083f 100644 --- a/README-service.md +++ b/README-service.md @@ -292,6 +292,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `service` | The list of service name strings. | yes `certificate` \| `usercertificate` | Base-64 encoded service certificate. | no `pac_type` \| `ipakrbauthzdata` | Supported PAC type. It can be one of `MS-PAC`, `PAD`, or `NONE`. | no diff --git a/README-sudocmd.md b/README-sudocmd.md index 2c30ddbf..7c548f32 100644 --- a/README-sudocmd.md +++ b/README-sudocmd.md @@ -84,6 +84,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `sudocmd` | The sudo command strings. | yes `description` | The command description string. | no `nomembers` | Suppress processing of membership attributes. (bool) | no diff --git a/README-sudocmdgroup.md b/README-sudocmdgroup.md index e37f577a..0b1bd534 100644 --- a/README-sudocmdgroup.md +++ b/README-sudocmdgroup.md @@ -124,6 +124,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` | The list of sudocmdgroup name strings. | no `description` | The sudocmdgroup description string. | no `nomembers` | Suppress processing of membership attributes. (bool) | no diff --git a/README-sudorule.md b/README-sudorule.md index f7954489..28d8ab0b 100644 --- a/README-sudorule.md +++ b/README-sudorule.md @@ -121,6 +121,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` | The list of sudorule name strings. | yes `description` | The sudorule description string. | no `usercategory` \| `usercat` | User category the rule applies to. Choices: ["all", ""] | no diff --git a/README-topology.md b/README-topology.md index 9391356b..b9063eb9 100644 --- a/README-topology.md +++ b/README-topology.md @@ -160,6 +160,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `suffix` | The topology suffix to be used, this can either be `domain`, `ca` or `domain+ca` | yes `name` \| `cn` | The topology segment name (cn) is the unique identifier for a segment. | no `left` \| `leftnode` | The left replication node string - an IPA server | no @@ -178,6 +179,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `suffix` | The topology suffix to be used, this can either be `domain` or `ca` | yes `state` | The state to ensure. It can only be `verified` | yes diff --git a/README-trust.md b/README-trust.md index 603303e1..c182fa8c 100644 --- a/README-trust.md +++ b/README-trust.md @@ -102,6 +102,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `realm` | The realm name string. | yes `admin` | Active Directory domain administrator string. | no `password` | Active Directory domain administrator's password string. | no diff --git a/README-user.md b/README-user.md index 7b88f594..2f73d910 100644 --- a/README-user.md +++ b/README-user.md @@ -366,6 +366,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` | The list of user name strings. `name` with *user variables* or `users` containing *user variables* need to be used. | no **User variables** | Only used with `name` variable in the first level. | no `users` | The list of user dicts. Each `users` dict entry can contain **user variables**.<br>There is one required option in the `users` dict:| no diff --git a/README-vault.md b/README-vault.md index 545c343a..a18079f0 100644 --- a/README-vault.md +++ b/README-vault.md @@ -218,6 +218,7 @@ Variable | Description | Required `ipaadmin_principal` | The admin principal is a string and defaults to `admin` | no `ipaadmin_password` | The admin password is a string and is required if there is no admin ticket available on the node | no `ipaapi_context` | The context in which the module will execute. Currently only `client` is supported by this module, and use of `server` will raise a failure. | no +`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `name` \| `cn` | The list of vault name strings. | yes `description` | The vault description string. | no `password` \| `vault_password` \| `ipavaultpassword` \| `old_password`| Vault password. | no -- GitLab