Steampunk Ansible Documentation - shanemcd.awx.user (20.0.14) - module - create, update, or destroy Automation Platform Controller users.

Install collection

Install with ansible-galaxy collection install shanemcd.awx:==20.0.14

Add to requirements.yml

  collections:
    - name: shanemcd.awx
      version: 20.0.14

Description

Create, update, or destroy Automation Platform Controller users. See U(https://www.ansible.com/tower) for an overview.

Usage examples

Scanned by Steampunk Spotter

- name: Add user
  user:
    username: jdoe
    password: foobarbaz
    email: jdoe@example.org
    first_name: John
    last_name: Doe
    state: present
    controller_config_file: "~/tower_cli.cfg"

Scanned by Steampunk Spotter

- name: Add user as a system administrator
  user:
    username: jdoe
    password: foobarbaz
    email: jdoe@example.org
    superuser: yes
    state: present
    controller_config_file: "~/tower_cli.cfg"

Scanned by Steampunk Spotter

- name: Add user as a system auditor
  user:
    username: jdoe
    password: foobarbaz
    email: jdoe@example.org
    auditor: yes
    state: present
    controller_config_file: "~/tower_cli.cfg"

Scanned by Steampunk Spotter

- name: Add user as a member of an organization (permissions on the organization are required)
  user:
    username: jdoe
    password: foobarbaz
    email: jdoe@example.org
    organization: devopsorg
    state: present

Scanned by Steampunk Spotter

- name: Delete user
  user:
    username: jdoe
    email: jdoe@example.org
    state: absent
    controller_config_file: "~/tower_cli.cfg"

Inputs

email:
description:
- Email address of the user.
type: str

state:
choices:
- present
- absent
default: present
description:
- Desired state of the resource.
type: str

password:
description:
- Write-only field used to change the password.
type: str

username:
description:
- Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
required: true
type: str

last_name:
description:
- Last name of the user.
type: str

first_name:
description:
- First name of the user.
type: str

is_superuser:
aliases:
- superuser
default: false
description:
- Designates that this user has all permissions without explicitly assigning them.
type: bool

new_username:
description:
- Setting this option will change the existing username (looked up via the name field.
type: str

organization:
description:
- The user will be created as a member of that organization (needed for organization
admins to create new organization users).
type: str

update_secrets:
default: true
description:
- C(true) will always change password if user specifies password, even if API gives
$encrypted$ for password.
- C(false) will only set the password if other values change too.
type: bool

validate_certs:
aliases:
- tower_verify_ssl
description:
- Whether to allow insecure connections to AWX.
- If C(no), SSL certificates will not be validated.
- This should only be used on personally controlled sites using self-signed certificates.
- If value not set, will try environment variable C(CONTROLLER_VERIFY_SSL) and then
config files
type: bool

controller_host:
aliases:
- tower_host
description:
- URL to your Automation Platform Controller instance.
- If value not set, will try environment variable C(CONTROLLER_HOST) and then config
files
- If value not specified by any means, the value of C(127.0.0.1) will be used
type: str

is_system_auditor:
aliases:
- auditor
default: false
description:
- User is a system wide auditor.
type: bool

controller_password:
aliases:
- tower_password
description:
- Password for your controller instance.
- If value not set, will try environment variable C(CONTROLLER_PASSWORD) and then
config files
type: str

controller_username:
aliases:
- tower_username
description:
- Username for your controller instance.
- If value not set, will try environment variable C(CONTROLLER_USERNAME) and then
config files
type: str

controller_oauthtoken:
aliases:
- tower_oauthtoken
description:
- The OAuth token to use.
- This value can be in one of two formats.
- A string which is the token itself. (i.e. bqV5txm97wqJqtkxlMkhQz0pKhRMMX)
- A dictionary structure as returned by the token module.
- If value not set, will try environment variable C(CONTROLLER_OAUTH_TOKEN) and then
config files
type: raw
version_added: 3.7.0
version_added_collection: shanemcd.awx

controller_config_file:
aliases:
- tower_config_file
description:
- Path to the controller config file.
- If provided, the other locations for config files will not be considered.
type: path