Ansible Role infra.aap_configuration.users

Description

An Ansible Role to configure users on Ansible Automation gateway.

Variables

Variable Name	Default Value	Required	Description	Example
platform_state	“present”	no	The state all objects will take unless overridden by object default	‘absent’
aap_hostname	””	yes	URL to the Ansible Automation Platform Server.	127.0.0.1
aap_validate_certs	True	no	Whether or not to validate the Ansible Automation Platform Server’s SSL certificate.
aap_username	””	no	Admin User on the Ansible Automation Platform Server. Either username / password or oauthtoken need to be specified.
aap_password	””	no	Platform Admin User’s password on the Server. This should be stored in an Ansible Vault at vars/platform-secrets.yml or elsewhere and called from a parent playbook.
aap_token	””	no	Controller Admin User’s token on the Ansible Automation Platform Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.
aap_request_timeout	10	no	Specify the timeout in seconds Ansible should use in requests to the Ansible Automation Platform host.
aap_user_accounts	see below	yes	Data structure describing your users Described below.

Secure Logging Variables

The following Variables compliment each other. If Both variables are not set, secure logging defaults to false. The role defaults to False as normally the add ee_registry task does not include sensitive information. gateway_users_secure_logging defaults to the value of aap_configuration_secure_logging if it is not explicitly called. This allows for secure logging to be toggled for the entire suite of automation hub configuration roles with a single variable, or for the user to selectively use it.

Variable Name	Default Value	Required	Description
gateway_users_secure_logging	False	no	Whether or not to include the sensitive Registry role tasks in the log. Set this value to True if you will be providing your sensitive values from elsewhere.
aap_configuration_secure_logging	False	no	This variable enables secure logging as well, but is shared across multiple roles, see above.

Asynchronous Retry Variables

The following Variables set asynchronous retries for the role. If neither of the retries or delay or retries are set, they will default to their respective defaults. This allows for all items to be created, then checked that the task finishes successfully. This also speeds up the overall role.

Variable Name	Default Value	Required	Description
aap_configuration_async_retries	50	no	This variable sets the number of retries to attempt for the role globally.
gateway_users_async_retries	aap_configuration_async_retries	no	This variable sets the number of retries to attempt for the role.
aap_configuration_async_delay	1	no	This sets the delay between retries for the role globally.
gateway_users_async_delay	aap_configuration_async_delay	no	This sets the delay between retries for the role.
aap_configuration_loop_delay	1000	no	This variable sets the loop_delay for the role globally.
gateway_users_loop_delay	aap_configuration_loop_delay	no	This variable sets the loop_delay for the role.
aap_configuration_async_dir	null	no	Sets the directory to write the results file for async tasks. The default value is set to null which uses the Ansible Default of /root/.ansible_async/.

Data Structure

User Arguments

Options for the aap_user_accounts variable:

Variable Name	Default Value	Required	Type	Description
username	N/A	yes	str	The username of the user
password	””	no	str	The password of the user
email	N/A	yes	str	The email of the user
first_name	””	no	str	The first name of the user
last_name	””	no	str	The last name of the user
is_superuser	false	no	bool	Whether the user is a superuser
authenticators	N/A	no	list	List of authenticators this user is associated with
authenticator_uid	N/A	no	bool	UID coming from the authenticators the user is associated with
state	present	no	str	Desired state of the resource.
update_secrets	‘true’	no	bool	True will always change password if user specifies password, even if API gives $encrypted$ for password. False will only set the password if other values change too.

Unique value:

• username

Usage

Json Example

• Creates (or updates) 2 users, one with default password “changeme”.

{
  "users_default_password": "changeme",
  "aap_user_accounts": [
    {
      "username": "jsmith",
      "is_superuser": false,
      "password": "p4ssword",
      "email": "jsmith@example.com"
    },
    {
      "username": "jdoe",
      "email": "jdoe@example.com"
    }
  ]
}

Yaml Example

• Check that users exist

File name: data/gateway_users.yml

platform_state: exists
aap_user_accounts:
- username: jsmith
- username: jdoe
- username: admin

License

GPL-3.0