infra.eda_configuration.user (1.1.0) — module

Manage a user in EDA Controller

Authors: Tom Page (@Tompage1994)

preview | supported by community

Install collection

Install with ansible-galaxy collection install infra.eda_configuration:==1.1.0


Add to requirements.yml

  collections:
    - name: infra.eda_configuration
      version: 1.1.0

Description

Create, update and delete users in EDA Controller

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create eda user
  infra.eda_configuration.user:
    username: john_smith
    first_name: john
    last_name: smith
    email: jsmith@example.com
    password: my_p455word
    roles:
      - Viewer
      - Auditor
      - Contributor
    state: present
    eda_host: eda.example.com
    eda_username: admin
    eda_password: Sup3r53cr3t

Inputs

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

roles:
    description:
    - The roles the user is provided with.
    - Current values are C(Viewer), C(Auditor), C(Editor), C(Contributor), C(Operator),
      C(Admin)
    elements: str
    type: list

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

eda_host:
    aliases:
    - eda_hostname
    description:
    - URL to Ansible Galaxy or EDA Controller instance.
    - If value not set, will try environment variable C(EDA_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.
    type: str

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

eda_token:
    description:
    - The Ansible Galaxy or EDA Controller API 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 eda_token module.
    - If value not set, will try environment variable C(EDA_API_TOKEN)
    type: raw

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

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

eda_password:
    description:
    - Password for your Ansible Galaxy or EDA Controller instance.
    - If value not set, will try environment variable C(EDA_PASSWORD)
    type: str

eda_username:
    description:
    - Username for your Ansible Galaxy or EDA Controller instance.
    - If value not set, will try environment variable C(EDA_USERNAME)
    type: str

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

update_secrets:
    default: true
    description:
    - C(true) will always change password if user specifies password.
    - C(false) will only set the password if other values change too.
    type: bool

validate_certs:
    aliases:
    - eda_verify_ssl
    description:
    - Whether to allow insecure connections to Galaxy or EDA Controller 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(EDA_VERIFY_SSL)
    type: bool

request_timeout:
    description:
    - Specify the timeout Ansible should use in requests to the Galaxy or EDA Controller
      host.
    - Defaults to 10s, but this is handled by the shared module_utils code
    type: float