mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-07-25 08:54:55 +00:00
Update CLIENT.md
This commit is contained in:
46
CLIENT.md
46
CLIENT.md
@@ -67,30 +67,10 @@ Example playbook to setup the IPA client(s) using principal and password from in
|
|||||||
Variables
|
Variables
|
||||||
---------
|
---------
|
||||||
|
|
||||||
The client role is configured with variables. The `ipaclient_ ` prefix is used for client specific settings and `ipaadmin_` prefix for admin user specific settings.
|
|
||||||
|
|
||||||
### `ipaservers`
|
|
||||||
|
|
||||||
The optional `ipaservers` group is a list of the IPA server full qualified host names. In a topology with a chain of servers and replicas, it is important to use the right server or replica as the server for the client. If there is a need to overwrite the setting for a client in the `ipaclients` group, please use the list `ipaclient_servers` explained below.
|
|
||||||
|
|
||||||
If no `ipaservers` group is defined than the installation preparation step will try to use DNS autodiscovery to identify the the IPA server using DNS txt records.
|
|
||||||
|
|
||||||
### `ipaclients`
|
### `ipaclients`
|
||||||
|
|
||||||
The mandatory `ipaclients` group is a list of the names of the IPA clients in FQDN form. All these clients will be installed or configured using the playbook.
|
The mandatory `ipaclients` group is a list of the names of the IPA clients in FQDN form. All these clients will be installed or configured using the playbook.
|
||||||
|
|
||||||
### `ipaadmin_keytab`
|
|
||||||
|
|
||||||
The `ipaadmin_keytab` variable enables the use of an admin keytab as an alternativce authentication method. The variable needs to contain the local path to the keytab file. If `ipaadmin_keytab` is used, then `ipaadmin_password` does not need to be set.
|
|
||||||
|
|
||||||
### `ipaadmin_principal`
|
|
||||||
|
|
||||||
The optional `ipaadmin_principal` variable only needs to be set if the name of the Kerberos admin principal is not "admin". If `ipaadmin_principal` is not set it will be set internally to "admin".
|
|
||||||
|
|
||||||
### `ipaadmin_password`
|
|
||||||
|
|
||||||
The `ipaadmin_password` variable contains the Kerberos password of the Kerberos admin principal. If `ipaadmin_keytab` is used, then `ipaadmin_password` does not need to be set.
|
|
||||||
|
|
||||||
### `ipaclient_domain`
|
### `ipaclient_domain`
|
||||||
|
|
||||||
The optional `ipaclient_domain` variable sets the DNS domain that will be used for client installation. Usually the DNS domain is a lower-cased name of the Kerberos realm.
|
The optional `ipaclient_domain` variable sets the DNS domain that will be used for client installation. Usually the DNS domain is a lower-cased name of the Kerberos realm.
|
||||||
@@ -136,8 +116,30 @@ The `ipaclient_no_ntp` bool value defines if NTP will not be configured and enab
|
|||||||
|
|
||||||
The `ipaclient_mkhomedir` bool value defines if PAM will be configured to create a users home directory if it does not exist. `ipaclient_mkhomedir` defaults to `no`.
|
The `ipaclient_mkhomedir` bool value defines if PAM will be configured to create a users home directory if it does not exist. `ipaclient_mkhomedir` defaults to `no`.
|
||||||
|
|
||||||
Topology Specific Variables
|
Server Variables
|
||||||
---------------------------
|
----------------
|
||||||
|
|
||||||
|
### `ipaservers`
|
||||||
|
|
||||||
|
The optional `ipaservers` group is a list of the IPA server full qualified host names. In a topology with a chain of servers and replicas, it is important to use the right server or replica as the server for the client. If there is a need to overwrite the setting for a client in the `ipaclients` group, please use the list `ipaclient_servers` explained below.
|
||||||
|
|
||||||
|
If no `ipaservers` group is defined than the installation preparation step will try to use DNS autodiscovery to identify the the IPA server using DNS txt records.
|
||||||
|
|
||||||
|
### `ipaadmin_keytab`
|
||||||
|
|
||||||
|
The `ipaadmin_keytab` variable enables the use of an admin keytab as an alternativce authentication method. The variable needs to contain the local path to the keytab file. If `ipaadmin_keytab` is used, then `ipaadmin_password` does not need to be set.
|
||||||
|
|
||||||
|
### `ipaadmin_principal`
|
||||||
|
|
||||||
|
The optional `ipaadmin_principal` variable only needs to be set if the name of the Kerberos admin principal is not "admin". If `ipaadmin_principal` is not set it will be set internally to "admin".
|
||||||
|
|
||||||
|
### `ipaadmin_password`
|
||||||
|
|
||||||
|
The `ipaadmin_password` variable contains the Kerberos password of the Kerberos admin principal. If `ipaadmin_keytab` is used, then `ipaadmin_password` does not need to be set.
|
||||||
|
|
||||||
|
|
||||||
|
Topology Variables
|
||||||
|
------------------
|
||||||
|
|
||||||
These variables can be used to define or change how clients are arranged within a cluster for example.
|
These variables can be used to define or change how clients are arranged within a cluster for example.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user