FAQ: Ansible Modules for VPLEX

FAQ: Ansible Modules for VPLEX

To which Ansible modules for Dell EMC VPLEX version does this FAQ apply?

This FAQ applies to version 1.0.

Where can I get the Ansible modules for Dell EMC VPLEX?

We have a repository in GitHub: https://github.com/dell/ansible-vplex

Is there anything additional I need to install?

Yes, VPLEX modules require the VPLEX Python SDK, available here. https://github.com/dell/python-vplex, you can automate this installation using Ansible as a task in your playbooks.  Python/Ansible/RHEL versions can be found in the Product Guide

What version of the VPLEX family are supported?

All models running GeoSynchrony 6.2

What are the supported features for this Ansible module for Dell EMC VPLEX?

The release of Ansible Modules for Dell EMC VPLEX v1.0 includes the following modules:

Gather Facts module

• Get list of storage arrays
• Get list of storage volumes
• Get list of ports
• Get list of initiators
• Get list of storage views
• Get list of virtual volumes
• Get list of consistency groups
• Get list of extents
• Get list of devices
• Get list of distributed devices
• Get list of distributed consistency groups
• Get list of distributed virtual volumes
• Get list of array management providers
• Gather Facts module parameters

Storage volume module

• Claim storage volume
• Unclaim storage volume
• Update or modify storage volume
• Set thin rebuild
• List ITLs
• Storage volume module parameters

Extent module

• Create extent with storage volume name
• Create extent with storage volume id
• Get extent
• Rename extent
• Delete extent with extent name
• Delete extent with storage volume name
• Extent module parameters

Device module

• Create a raid-1 device
• Get device from cluster
• Add an extent to the device
• Remove an extent from the device
• Rename device
• Delete device
• Manage local device module parameters

Virtual volume module

• Create virtual volume
• Get virtual volume using name or System ID
• Add local mirror to virtual volume using name or System ID
• Remove local mirror from virtual volume using name or System ID
• Enable remote access using name or System ID
• Disable remote access using name or System ID
• Rename virtual volume using name or System ID
• Expand virtual volume with device using name or System ID
• Delete virtual volume using name or System ID
• Manage virtual volume module parameters

Consistency group module

• Create a consistency group
• Add virtual volumes to consistency group
• Remove virtual volumes from consistency group
• Rename consistency group
• Delete consistency group
• Get consistency group
• Consistency group module parameters

Port module

• Get port
• Enable port
• Disable port
• Port module parameters

Initiator module

• Register an initiator
• Get details of an initiator
• Rename initiator
• Unregister an initiator
• Rediscover initiators
• Initiator module parameters

Storage View module

• Get details of a storage view
• Create a storage view
• Delete a storage view
• Rename a storage view
• Add ports to a storage view
• Add initiators to a storage view
• Add virtual volumes to a storage view
• Remove ports from a storage view
• Remove initiators from a storage view
• Remove virtual volumes from a storage view
• Storage view module parameters

Rediscover array module

• Rediscover array
• Get array
• Rediscover array module parameters

Do these modules support any array initialization or day-0 configuration?

No, the focus of these modules is repetitive storage provisioning operations and not tasks like setting network parameters, adding array management users/group, adding licenses, or software upgrades.

Where can I find playbook examples?
Examples are available in the embedded documentation along with each module's python code. They can be viewed using the ansible-doc command.  Sample playbooks are also on GitHub . VPLEX specific examples can be found here.

What are the known limitations?
Please refer to the limitations and considerations section in the release notes.

How to uninstall the modules?
Uninstallation simply involves deleting the module python files in the directories in which they were originally copied.

I have a question or a problem, where do I submit an issue against the driver?
The Ansible modules for Dell EMC VPLEX are officially by Dell EMC. Therefore you can open a discussion in the Automation community forum, or open a ticket directly on the support website.

Can I run this module in a production environment?
Yes, the module is production-grade. Please make sure your environment follows the pre-requisites and Ansible best practices.

What if I have a VPLEX question not related to Ansible?

There is a community forum for VPLEX which can be access here