W3cubDocs

/Ansible 2.10

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

Note

This plugin is part of the infinidat.infinibox collection.

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 on Infinibox. infini_map is implemented separately from infini_host to allow ansible plays to remove, or make absent, a mapping without removing the host.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
host
string / required
Host Name
password
string
Infinibox User password.
state
string
    Choices:
  • stat
  • present ←
  • absent
Creates mapping when present or removes when absent, or provides details of a mapping when stat.
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: 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)

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