Docs4dev
Docs
ansible / latest / collections / infinidat / infinibox / infini_cluster_module.html

infinidat.infinibox.infini_cluster – Create, Delete and Modify Host Cluster on Infinibox

Note

This plugin is part of the infinidat.infinibox collection (version 1.2.4).

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.

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

New in version 2.9: of infinidat.infinibox

Synopsis

  • This module creates, deletes or modifies host clusters on Infinibox.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
name
string / required
Cluster Name
password
string
Infinibox User password.
state
string
    Choices:
  • stat
  • present ←
  • absent
Creates/Modifies Cluster when present, removes when absent, or provides details of a cluster when stat.
system
string / required
Infinibox Hostname or IPv4 Address.
user
string
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 new cluster
  infini_cluster:
    name: foo_cluster
    user: admin
    password: secret
    system: ibox001

Authors

  • David Ohlemacher (@ohlemacher)

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