Ansible Role infra.aap_configuration.gateway_role_user_assignments

Description

An Ansible Role to create/update/remove Role User Assignments on Ansible 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 ”” no Specify the timeout in seconds Ansible should use in requests to the Ansible Automation Platform host.  
gateway_role_user_assignments see below yes Data structure describing your role user assignments Described below.  

Enforcing defaults

The following Variables complement each other. If Both variables are not set, enforcing default values is not done. Enabling these variables enforce default values on options that are optional in the controller API. This should be enabled to enforce configuration and prevent configuration drift. It is recommended to be enabled, however it is not enforced by default.

Enabling this will enforce configuration without specifying every option in the configuration files.

‘gateway_role_user_assignments_enforce_defaults’ defaults to the value of ‘aap_configuration_enforce_defaults’ if it is not explicitly called. This allows for enforced defaults to be toggled for the entire suite of controller configuration roles with a single variable, or for the user to selectively use it.

Variable Name Default Value Required Description
gateway_role_user_assignments_enforce_defaults false no Whether or not to enforce default option values on only the role user assignments role
aap_configuration_enforce_defaults false no This variable enables enforced default values as well, but is shared globally.

Secure Logging Variables

The following Variables complement each other. If Both variables are not set, secure logging defaults to false. The role defaults to false as normally the add role user assignments task does not include sensitive information. gateway_role_user_assignments_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 gateway configuration roles with a single variable, or for the user to selectively use it.

Variable Name Default Value Required Description
gateway_role_user_assignments_secure_logging false no Whether or not to include the sensitive Role User Assignments 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_role_user_assignments_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_role_user_assignments_async_delay aap_configuration_async_delay no This sets the delay between retries for the role.
aap_configuration_loop_delay 0 no This variable sets the loop_delay for the role globally.
gateway_role_user_assignments_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

Role User Assignment Variables

WARNING! Some options only will work in AAP 2.6+ Options for the gateway_role_user_assignments variable:

Variable Name Default Value Required Type Description
object_ansible_id N/A no str UUID of the object(team/organization) this role applies to. Alternative to the object_id/object_ids field. This option is mutually exclusive with object_id and object_ids.
object_id N/A no int Primary key/Name of the object this assignment applies to. This option is deprecated and will be removed in a release after 2026-01-31. This option is mutually exclusive with object_ids and object_ansible_id.
object_ids N/A no list List of object IDs(Primary Key) or names this assignment applies to. This option is mutually exclusive with object_id and object_ansible_id.
role_definition N/A yes str The name or id of the role definition to assign to the user.
state present no str Desired state of the resource.
user N/A no str The name or id of the user to assign to the object. This option is mutually exclusive with user_ansible_id.
user_ansible_id N/A no str Resource id of the user who will receive permissions from this assignment. Alternative to user field. This option is mutually exclusive with user.

Unique value:

  • [user, object_id] (*_ansible_id alternatives can be provided)

Standard Role User Assignment Data Structure

Json Example 

{
  "gateway_role_user_assignments": [
    {
      "role_definition": "Organization Admin",
      "user": "Bob",
      "object_ids": "org1"
    }
  ]
}

Yaml Example

File name: data/gateway_role_user_assignments.yml

gateway_role_user_assignments:
  - role_definition: Organization Admin
    user: Bob
    object_ids: org1

License

GPL-3.0