community.general.vexata_eg module – Manage export groups on Vexata VX100 storage arrays

Note

This module is part of the community.general collection (version 9.4.0).

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 community.general. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.vexata_eg.

Synopsis

  • Create or delete export groups on a Vexata VX100 array.

  • An export group is a tuple of a volume group, initiator group and port group that allows a set of volumes to be exposed to one or more hosts through specific array ports.

Requirements

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

  • Vexata VX100 storage array with VXOS >= v3.5.0 on storage array

  • vexatapi >= 0.0.1

  • VEXATA_USER and VEXATA_PASSWORD environment variables must be set if user and password arguments are not passed to the module directly.

Parameters

Parameter

Comments

array

string / required

Vexata VX100 array hostname or IPv4 Address.

ig

string

Initiator group name.

name

string / required

Export group name.

password

string

Vexata API user password.

Uses the VEXATA_PASSWORD environment variable as a fallback.

pg

string

Port group name.

state

string

Creates export group when present or delete when absent.

Choices:

  • "present" ← (default)

  • "absent"

user

string

Vexata API user with administrative privileges.

Uses the VEXATA_USER environment variable as a fallback.

validate_certs

boolean

Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

If set to true, please make sure Python >= 2.7.9 is installed on the given machine.

Choices:

  • false ← (default)

  • true

vg

string

Volume group name.

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name: Create export group named db_export.
  community.general.vexata_eg:
    name: db_export
    vg: dbvols
    ig: dbhosts
    pg: pg1
    state: present
    array: vx100_ultra.test.com
    user: admin
    password: secret

- name: Delete export group named db_export
  community.general.vexata_eg:
    name: db_export
    state: absent
    array: vx100_ultra.test.com
    user: admin
    password: secret

Authors

  • Sandeep Kasargod (@vexata)