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

infinidat.infinibox.infini_pool – Create, Delete and Modify Pools 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_pool.

New in version 2.3: of infinidat.infinibox

Synopsis

  • This module to creates, deletes or modifies pools on Infinibox.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
compression
boolean
added in 2.8 of infinidat.infinibox
    Choices:
  • no
  • yes ←
Enable/Disable Compression on Pool
name
string / required
Pool Name
password
string
Infinibox User password.
size
string
Pool Physical Capacity in MB, GB or TB units. If pool size is not set on pool creation, size will be equal to 1TB. See examples.
ssd_cache
boolean
    Choices:
  • no
  • yes ←
Enable/Disable SSD Cache on Pool
state
string
    Choices:
  • present ←
  • absent
Creates/Modifies Pool when present or removes when absent
system
string / required
Infinibox Hostname or IPv4 Address.
user
string
Infinibox User username with sufficient priveledges ( see notes ).
vsize
string
Pool Virtual Capacity in MB, GB or TB units. If pool vsize is not set on pool creation, Virtual Capacity will be equal to Physical Capacity. See examples.

Notes

Note

  • Infinibox Admin level access is required for pool modifications
  • 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: Make sure pool foo exists. Set pool physical capacity to 10TB
  infini_pool:
    name: foo
    size: 10TB
    vsize: 10TB
    user: admin
    password: secret
    system: ibox001

- name: Disable SSD Cache on pool
  infini_pool:
    name: foo
    ssd_cache: no
    user: admin
    password: secret
    system: ibox001

- name: Disable Compression on pool
  infini_pool:
    name: foo
    compression: no
    user: admin
    password: secret
    system: ibox001

Authors

  • Gregory Shulov (@GR360RY)

© 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_pool_module.html