W3cubDocs

/Ansible

infinidat.infinibox.infini_users_repository module – Create, Delete or Modify respositories of users that can log on to an Infinibox

Note

This module is part of the infinidat.infinibox collection (version 1.6.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 infinidat.infinibox. You need further requirements to be able to use this module, see Requirements for details.

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

New in infinidat.infinibox 2.13.0

Synopsis

  • This module creates, deletes or modifies respositories of users that can log on to an Infinibox.

Requirements

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

Parameters

Parameter

Comments

ad_auto_discover_servers

boolean

AD auto discover servers

Choices:

  • false
  • true ← (default)

ad_domain_name

string

AD domain name

bind_password

string

The bind user password

bind_username

string

The bind username

ldap_port

integer

LDAP or AD port to use

Default: 636

ldap_servers

list / elements=string

List of LDAP or AD servers

Default: []

name

string / required

Name of repository

password

string / required

Infinibox User password.

repository_type

string

The type of repository

Choices:

  • "ActiveDirectory"
  • "LDAP"

schema_group_class

string

Schema group class

schema_group_memberof_attribute

string

Schema group memberof attribute

schema_group_name_attribute

string

Schema group name attribute

schema_groups_basedn

string

Schema groups base DN

schema_user_class

string

Schema user class

schema_username_attribute

string

Schema username attribute

schema_users_basedn

string

Schema user base DN

servers

list / elements=string

A list of LDAP servers. For an empty list, use [].

Default: []

state

string

Creates/Modifies users repositories when present or removes when absent.

When getting the stats for a users repository, the module will test connectivity to the repository and report the result in ‘test_ok’ as true or false.

Choices:

  • "stat"
  • "present" ← (default)
  • "absent"

stay_logged_in

boolean

If True, persist API session to disk.

Load the session on subsequent module calls.

Persisted sessions are only usable for stay_logged_in_minutes.

Choices:

  • false ← (default)
  • true

stay_logged_in_minutes

integer

Number of minutes for which a persisted session may be reused.

After this time, the session data will be deleted.

The time should be shorter than the IBOX session timeout time.

Default: 5

system

string / required

Infinibox Hostname or IPv4 Address.

use_ldaps

boolean

Use SSL (LDAPS)

Choices:

  • false
  • true ← (default)

user

string / required

Infinibox User username with sufficient priveledges ( see notes ).

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 AD
  infini_users_repository:
    name: PSUS_ANSIBLE_ad
    bind_password: tuFrAxahuYe4
    bind_username: conldap
    ad_domain_name: infinidat.com
    repository_type: ActiveDirectory
    schema_group_class: group
    schema_group_memberof_attribute: memberof
    schema_group_name_attribute: cn
    schema_groups_basedn:
    schema_user_class: user
    schema_username_attribute: sAMAccountName
    state: present
    system: 172.20.67.167
    user: dohlemacher
    password: 123456

- name: Stat AD
  infini_users_repository:
    name: PSUS_ANSIBLE_ad
    state: stat
    user: admin
    password: secret
    system: ibox001

- name: Remove AD
  infini_users_repository:
    name: PSUS_ANSIBLE_ad
    state: absent
    user: admin
    password: secret
    system: ibox001

Authors

  • David Ohlemacher (@ohlemacher)

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