community.general.vexata_volume module – Manage volumes on Vexata VX100 storage arrays

Note

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

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 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_volume.

Synopsis

  • Create, deletes or extend volumes on a Vexata VX100 array.

Aliases: storage.vexata.vexata_volume

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

  • python >= 2.7

  • 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.

name

string / required

Volume name.

password

string

Vexata API user password.

size

string

Volume size in M, G, T units. M=2^20, G=2^30, T=2^40 bytes.

state

string

Creates/Modifies volume when present or removes when absent.

Choices:

  • "present" ← (default)

  • "absent"

user

string

Vexata API user with administrative privileges.

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

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 new 2 TiB volume named foo
  community.general.vexata_volume:
    name: foo
    size: 2T
    state: present
    array: vx100_ultra.test.com
    user: admin
    password: secret

- name: Expand volume named foo to 4 TiB
  community.general.vexata_volume:
    name: foo
    size: 4T
    state: present
    array: vx100_ultra.test.com
    user: admin
    password: secret

- name: Delete volume named foo
  community.general.vexata_volume:
    name: foo
    state: absent
    array: vx100_ultra.test.com
    user: admin
    password: secret

Authors

  • Sandeep Kasargod (@vexata)