manageiq_user - Management of users in ManageIQ.

New in version 2.4.

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

Examples

- name: Create a new user in ManageIQ
  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'
      verify_ssl: False

- name: Create a new user in ManageIQ using a token
  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'
      verify_ssl: False

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

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

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

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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

• Daniel Korn (@dkorn)

Hint

If you notice any issues in this documentation you can edit this document to improve it.