W3cubDocs

/Ansible 2.10

infinidat.infinibox.infini_user – Create, Delete and Modify a User on Infinibox

Note

This plugin is part of the infinidat.infinibox collection.

To install it use: ansible-galaxy collection install infinidat.infinibox.

To use it in a playbook, specify: infinidat.infinibox.infini_user.

New in version 2.10: of infinidat.infinibox

Synopsis

  • This module creates, deletes or modifies a user on Infinibox.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
password
string
Infinibox User password.
state
string
    Choices:
  • stat
  • reset_password
  • present ←
  • absent
Creates/Modifies user when present or removes when absent
system
string / required
Infinibox Hostname or IPv4 Address.
user
string
Infinibox User username with sufficient priveledges ( see notes ).
user_email
string / required
The new user's Email address
user_enabled
boolean
    Choices:
  • no
  • yes ←
Specify whether to enable the user
user_name
string / required
The new user's Name. Once a user is created, the user_name may not be changed from this module. It may be changed from the UI or from infinishell.
user_password
string / required
The new user's password
user_pool
string
Use with role==pool_admin. Specify the new user's pool.
user_role
string / required
    Choices:
  • admin
  • pool_admin
  • read_only
The user's role

Notes

Note

  • This module requires infinisdk python library
  • You must set INFINIBOX_USER and INFINIBOX_PASSWORD environment variables if user and password arguments are not passed to the module directly
  • Ansible uses the infinisdk configuration file ~/.infinidat/infinisdk.ini if no credentials are provided. See http://infinisdk.readthedocs.io/en/latest/getting_started.html
  • All Infinidat modules support check mode (–check). However, a dryrun that creates resources may fail if the resource dependencies are not met for a task. For example, consider a task that creates a volume in a pool. If the pool does not exist, the volume creation task will fail. It will fail even if there was a previous task in the playbook that would have created the pool but did not because the pool creation was also part of the dry run.

Examples

- name: Create new user
  infini_user:
    user_name: foo_user
    user_email: [email protected]
    user_password: secret2
    user_role: pool_admin
    user_enabled: false
    pool: foo_pool
    state: present
    password: secret1
    system: ibox001

Authors

  • David Ohlemacher (@ohlemacher)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/infinidat/infinibox/infini_user_module.html