infinidat.infinibox.infini_map module – Create and Delete mapping of a volume to a host or cluster on Infinibox

Note

This module is part of the infinidat.infinibox collection (version 1.3.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.

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

New in version 2.10: of infinidat.infinibox

Synopsis

  • This module creates or deletes mappings of volumes to hosts or clusters on Infinibox.

Requirements

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

Parameters

Parameter

Comments

cluster

string

Cluster Name

host

string

Host Name

password

string

Infinibox User password.

state

string

Creates mapping when present or removes when absent, or provides details of a mapping when stat.

Choices:

  • stat

  • present ← (default)

  • absent

system

string / required

Infinibox Hostname or IPv4 Address.

user

string

Infinibox User username with sufficient priveledges ( see notes ).

volume

string / required

Volume name to map to the host

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: Map a volume to an existing host
  infini_map:
    host: foo.example.com
    volume: bar
    state: present  # Default
    user: admin
    password: secret
    system: ibox001

- name: Map a volume to an existing cluster
  infini_map:
    cluster: test-cluster
    volume: bar
    state: present  # Default
    user: admin
    password: secret
    system: ibox001

- name: Unmap volume bar from host foo.example.com
  infini_map:
    host: foo.example.com
    volume: bar
    state: absent
    system: ibox01
    user: admin
    password: secret

- name: Stat mapping of volume bar to host foo.example.com
  infini_map:
    host: foo.example.com
    volume: bar
    state: stat
    system: ibox01
    user: admin
    password: secret

Authors

  • David Ohlemacher (@ohlemacher)