You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.manageiq_user – Management of users in ManageIQ.

Note

This plugin is part of the community.general collection (version 3.8.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.manageiq_user.

Synopsis

• The manageiq_user module supports adding, updating and deleting users in ManageIQ.

Requirements

The below requirements are needed on the host that executes this module.

• manageiq-client https://github.com/ManageIQ/manageiq-api-client-python/

Parameters

Parameter	Comments
email string	The users’ E-mail address.
group string	The name of the group to which the user belongs.
manageiq_connection dictionary	ManageIQ connection configuration information.
ca_cert aliases: ca_bundle_path string	The path to a CA bundle file or directory with certificates. defaults to None.
password string	ManageIQ password. MIQ_PASSWORD env var if set. otherwise, required if no token is passed in.
token string	ManageIQ token. MIQ_TOKEN env var if set. otherwise, required if no username or password is passed in.
url string	ManageIQ environment url. MIQ_URL env var if set. otherwise, it is required to pass it.
username string	ManageIQ username. MIQ_USERNAME env var if set. otherwise, required if no token is passed in.
validate_certs aliases: verify_ssl boolean	Whether SSL certificates should be verified for HTTPS requests. defaults to True. Choices: no yes ← (default)
name string	The users’ full name.
password string	The users’ password.
state string	absent - user should not exist, present - user should be. Choices: absent present ← (default)
update_password string	always will update passwords unconditionally. on_create will only set the password for a newly created user. Choices: always ← (default) on_create
userid string / required	The unique userid in manageiq, often mentioned as username.

Examples

- name: Create a new user in ManageIQ
  community.general.manageiq_user:
    userid: 'jdoe'
    name: 'Jane Doe'
    password: 'VerySecret'
    group: 'EvmGroup-user'
    email: '[email protected]'
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      validate_certs: False

- name: Create a new user in ManageIQ using a token
  community.general.manageiq_user:
    userid: 'jdoe'
    name: 'Jane Doe'
    password: 'VerySecret'
    group: 'EvmGroup-user'
    email: '[email protected]'
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      token: 'sometoken'
      validate_certs: False

- name: Delete a user in ManageIQ
  community.general.manageiq_user:
    state: 'absent'
    userid: 'jdoe'
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      validate_certs: False

- name: Delete a user in ManageIQ using a token
  community.general.manageiq_user:
    state: 'absent'
    userid: 'jdoe'
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      token: 'sometoken'
      validate_certs: False

- name: Update email of user in ManageIQ
  community.general.manageiq_user:
    userid: 'jdoe'
    email: '[email protected]'
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      validate_certs: False

- name: Update email of user in ManageIQ using a token
  community.general.manageiq_user:
    userid: 'jdoe'
    email: '[email protected]'
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      token: 'sometoken'
      validate_certs: False

Authors

• Daniel Korn (@dkorn)