infinidat.infinibox.infini_infinimetrics module – Create (present state) or remove (absent state) an Infinibox registration on an Infinimetrics.

Note

This module is part of the infinidat.infinibox collection (version 1.4.5).

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_infinimetrics.

New in infinidat.infinibox 2.16.0

Synopsis

  • Create (present state) or remove (absent state) an Infinibox registration on an Infinimetrics.

Requirements

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

Parameters

Parameter

Comments

ibox_readonly_password

string

Read only Infinibox user password.

ibox_readonly_user

string

Read only Infinibox user name.

ibox_serial

string / required

Infinibox serial number.

ibox_url

string

Infinibox DNS resolvable hostname or IPv4 address.

imx_password

string / required

Infinimetrics user password.

imx_system

string / required

Infinimetrics hostname or IPv4 Address.

imx_user

string / required

Infinimetrics user name.

password

string / required

Infinibox User password.

state

string

Registers the Infinibox with Infinimetrics, when using state present.

For state absent, the Infinibox is disabled on Infinimetrics and will no longer appear on the Infinimetrics UI.

Existing Infinibox data is not purged from Infinimetrics.

Purging may be executed using the Infinimetrics CLI tool.

Choices:

  • "present" ← (default)

  • "absent"

system

string / required

Infinibox Hostname or IPv4 Address.

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: Register IBOX with Infinimetrics
  infini_infinimetrics:
    infinimetrics_system: infinimetrics
    state: present
    user: admin
    password: secret
    system: ibox001

- name: Deregister IBOX from Infinimetrics
  infini_infinimetrics:
    infinimetrics_system: infinimetrics
    state: absent
    user: admin
    password: secret
    system: ibox001

Authors

  • David Ohlemacher (@ohlemacher)