W3cubDocs

/Ansible

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

New in infinidat.infinibox 2.3.0

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

Comments

compression

boolean

Enable/Disable Compression on Pool

Choices:

  • false
  • true ← (default)

name

string / required

Pool Name

password

string / required

Infinibox User password.

physical_capacity_critical

integer

Capacity, in percent, for a critical notification.

Default: 90

physical_capacity_warning

integer

Capacity, in percent, for a warning notification.

Default: 80

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

Enable/Disable SSD Cache on Pool

Choices:

  • false
  • true ← (default)

state

string

Creates/Modifies Pool when present or removes when absent

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.

user

string / required

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: false
    user: admin
    password: secret
    system: ibox001

- name: Disable Compression on pool
  infini_pool:
    name: foo
    compression: false
    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_pool_module.html