redhat_cop.ah_configuration.ah_user (0.9.2) — module

Install collection

Install with ansible-galaxy collection install redhat_cop.ah_configuration:==0.9.2

Add to requirements.yml

  collections:
    - name: redhat_cop.ah_configuration
      version: 0.9.2

Description

Create, delete, and update user accounts in private automation hub.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure the user exists
  redhat_cop.ah_configuration.ah_user:
    username: lvasquez
    first_name: Lena
    last_name: Vasquez
    email: lvasquez@example.com
    password: vs9mrD55NP
    groups:
      - operators
    state: present
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure the user is removed
  redhat_cop.ah_configuration.ah_user:
    username:  dwilde
    state: absent
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure the user only belongs to the operators and developers groups
  redhat_cop.ah_configuration.ah_user:
    username: qhazelrigg
    state: present
    groups:
      - operators
      - developers
    append: false
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure the user is added to the managers group
  redhat_cop.ah_configuration.ah_user:
    username: chorwitz
    state: present
    groups:
      - managers
    append: true
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure the password is changed
  redhat_cop.ah_configuration.ah_user:
    username: jziglar
    state: present
    password: bQtVeBUK2F
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure the user is a super user
  redhat_cop.ah_configuration.ah_user:
    username:  ekrob
    state: present
    is_superuser: true
    ah_host: hub.example.com
    ah_username: admin
    ah_password: Sup3r53cr3t

Inputs

    
email:
    description:
    - User's email address. That address must be correctly formed.
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - If C(absent), then the module deletes the user.
    - The module does not fail if the user does not exist because the state is already
      as expected.
    - If C(present), then the module creates the user if it does not already exist. If
      the user account already exists, then the module updates its state.
    type: str

append:
    default: true
    description:
    - If C(yes), then add the user to the groups specified in C(groups).
    - If C(no), then the module only adds the user to the groups specified in C(groups),
      removing them from all other groups.
    type: bool

groups:
    description:
    - List of the groups the user is added to. When not set or set to an empty list (C([])),
      the module removes the user from all groups.
    elements: str
    type: list

ah_host:
    aliases:
    - ah_hostname
    description:
    - URL to Ansible Galaxy or Automation Hub instance.
    - If value not set, will try environment variable C(AH_HOST)
    - If value not specified by any means, the value of C(127.0.0.1) will be used
    type: str

password:
    description:
    - User's password as a clear string. The password must contain at least 9 characters
      with numbers or special characters.
    type: str

username:
    description:
    - Name of the user to create, remove, or modify.
    required: true
    type: str

last_name:
    description:
    - User's last name.
    type: str

first_name:
    description:
    - User's first name.
    type: str

ah_password:
    description:
    - Password for your Ansible Galaxy or Automation Hub instance.
    - If value not set, will try environment variable C(AH_PASSWORD)
    type: str

ah_username:
    description:
    - Username for your Ansible Galaxy or Automation Hub instance.
    - If value not set, will try environment variable C(AH_USERNAME)
    type: str

is_superuser:
    aliases:
    - superuser
    default: false
    description:
    - Gives the super user permissions to the user.
    type: bool

ah_path_prefix:
    default: galaxy
    description:
    - API path used to access the api.
    - For galaxy_ng this is either 'automation-hub' or the custom prefix used on install
      with GALAXY_API_PATH_PREFIX
    - For Automation Hub this is 'galaxy'
    type: str

validate_certs:
    aliases:
    - ah_verify_ssl
    description:
    - Whether to allow insecure connections to Galaxy or Automation Hub Server.
    - 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(AH_VERIFY_SSL)
    type: bool

See also

• redhat_cop.ah_configuration.ah_group_perm
• redhat_cop.ah_configuration.ah_group