The Ansible Modules for Dell EMC VxRail allow data center and IT administrators to use RedHat Ansible to automate and orchestrate the configuration and management of Dell EMC VxRail.
The capabilities of Ansible modules are gathering system information and performing Lay2 Node Expansion. These tasks can be executed by running simple playbooks written in yaml syntax. The modules are written so that all the operations are idempotent, therefore making multiple identical requests has the same effect as making a single request.
Ansible modules for VxRail are supported by Dell EMC open source community, but not product support agreements, and are provided under the terms of the license attached to the source code. Dell EMC does not provide support for any source code modifications. For any Ansible module issues, questions or feedback, join the Dell EMC Automation community.
- Dell EMC VxRail
This table provides information about the software prerequisites for the Ansible Modules for Dell EMC VxRail.
| Ansible Modules | VxRail version | Python version | Python library (VxRail Ansible Utility) version | Ansible Version |
|---|---|---|---|---|
| v2.4.1 | 8.0.210 | 3.7, 3.8 | 2.4.1 | 2.9 and 2.10 |
- Please follow VxRail Ansible Utility installation instructions on VxRail Ansible Utility Documentation
The modules are written in such a way that all requests are idempotent and hence fault-tolerant. This means that the result of a successfully performed request is independent of the number of times it is executed.
- Auto Discovery hosts module
- Callhome Information module
- Callhome Disable module
- Callhome Enable module
- Callhome Mode Information module
- Callhome Mode Change module
- Certificate Get Automated Renewal Configurations module
- Certificate Get Automated Renewal Status module
- Certificate Get Content module
- Certificate Get Fingerprints module
- Certificate Get All Information module
- Certificate Import Certs Into Truststore module
- Certificate Removal module
- Certificate Signing Request Generation module
- Certificate Update Automated Renewal Configurations module
- Certificate Update module
- Certificate Validate module
- Chassis module
- Cluster expansion module
- Cluster expansion cancel module
- Cluster information module
- Cluster Layer3 Get Segment Health module
- Cluster Layer3 Get Segments module
- Cluster Layer3 New Segment module
- Cluster Layer3 Segement change module
- Cluster Layer3 Segment Label change module
- Cluster Layer3 Segment remove module
- Cluster Layer3 Specific Segment module
- Cluster Portgroups module
- Cluster Shutdown module
- Configure Manager Address module
- Customer Supplied Hosts module
- CVS Compliance Report module
- Day1 Initialization module
- Disks Information module
- Export CVS Compliance Report module
- Hosts module
- Host Shutdown module
- Hosts Update module
- iDRAC Add User Module
- iDRAC Available User Slot ID Module
- iDRAC Network Settings module
- iDRAC Update Network Settings Module
- iDRAC Update User Account Information Module
- iDRAC Users module
- LCM Advisory Meta Bundle module
- LCM Upload Customized Component
- LCM Advisory Report module
- LCM module
- LCM Retry module
- LCM VLCM Image Info module
- LCM VLCM Info module
- LCM VLCM Enable module
- Host Folder LCM
- LCM Precheck module
- Network throttling Change module
- Network throttling Info module
- Prechecks Report Module
- Remove Host module
- Satellite Node Expansion module
- Satellite Node Remove module
- Sequential Reboot Cancel Module
- Sequential Reboot Module
- Sequential Reboot Retry Module
- Stig Information module
- Support Account module
- System Available Hosts module
- System Cluster Hosts module
- System Disable Proxy module
- System DNS Change module
- System DNS Information module
- System Get Management Accounts module
- System Internet Mode Change module
- System Internet Mode Information module
- System module
- System NTP Change module
- System NTP Information module
- System Precheck module
- System Prechecks Profiles module
- System Precheck Version module
- System Proxy Information module
- System Set Proxy module
- System Update Credential module
- System Update Proxy module
- System Validate Credential module
- System Virtual Machines module
- Telemetry Tier Change module
- Telemetry Tier Info module
- VC Mode Change module
- VC Mode Information module
Install the python sdk named 'VxRail Ansible Utility'. It can be installed using pip, based on the appropriate python version.
-
Download the tar build and install the collection anywhere in your system, e.g.
ansible-galaxy collection install dellemc-vxrail-1.1.0.tar.gz -p <install_path> -
Set the environment variable:
export ANSIBLE_COLLECTIONS_PATHS=$ANSIBLE_COLLECTIONS_PATHS:<install_path>
- In order to use any Ansible module, ensure that the importation of the proper FQCN (Fully Qualified Collection Name) must be embedded in the playbook. For example,
collections:
- dellemc.vxrail - To generate Ansible documentation for a specific module, embed the FQCN before the module name. For example,
ansible-doc dellemc.vxrail.dellemc_vxrail_cluster
The Ansible server must be configured with Python library for VxRail Ansible Utility to run the Ansible playbooks. The Documents provide information on different Ansible modules along with their functions and syntax. The parameters table in the Product Guide provides information on various parameters which needs to be configured before running the modules.