Docs4dev
Docs
ansible / latest / collections / community / general / vexata_volume_module.html

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

Note

This plugin is part of the community.general collection (version 3.8.1).

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.

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

Synopsis

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

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 Choices/Defaults 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
    Choices:
  • present ←
  • absent
Creates/Modifies volume when present or removes when absent.
user
string
Vexata API user with administrative privileges.
validate_certs
boolean
    Choices:
  • no ←
  • yes
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
If set to yes, please make sure Python >= 2.7.9 is installed on the given machine.

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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/vexata_volume_module.html