The Ansible Modules for Dell Technologies (Dell) PowerScale allow Data Center and IT administrators to use RedHat Ansible to automate and orchestrate the configuration and management of Dell PowerScale arrays.
The Ansible Modules for Dell PowerScale support the following features:
- Create user, groups, filesystem, NFS export, smart quotas, SMB share, snapshot and snapshot schedule of a filesystem.
- Modify user, groups, filesystem, access zone, NFS export, smart quotas, SMB share, snapshot and snapshot schedule of a filesystem.
- Delete user, groups, filesystem, NFS export, smart quotas, SMB share, snapshot and snapshot schedule of a filesystem.
- Get details of user, groups, node, filesystem, access zone, NFS export, smart quotas, SMB share, snapshot and snapshot schedule of a filesystem.
- Get details of SyncIQ policies, SyncIQ jobs, SyncIQ reports, SyncIQ target reports and SyncIQ performance rules of the cluster.
- Add, modify and remove Active Directory and LDAP to Authentication providers list.
- Map or unmap Active Directory and LDAP Authentication providers to Access zone.
- Create, modify and delete SyncIQ policy.
- Create job on SyncIQ policy and modify the state of SyncIQ Job.
- Create, modify and delete SyncIQ performance rule.
- Create, modify and delete Groupnet, Subnet, Network Pool and Network Rule.
- Get details of Groupnet, Subnet, Network Pool and Network Rule.
- Modify cluster email settings.
- Get cluster email settings and NTP Server details.
- Add and remove NTP Servers
- Create an access zone.
- Get network and smart pool settings.
- Modify network and smart pool settings.
- Get attributes and entities of the array.
The tasks can be executed by running simple playbooks written in yaml syntax.
Ansible collection for PowerScale is released and licensed under the GPL-3.0 license. See LICENSE for the full terms. Ansible modules and modules utilities that are part of the Ansible collection for PowerScale are released and licensed under the Apache 2.0 license. See MODULE-LICENSE for the full terms.
Ansible collection for PowerScale are supported by Dell and are provided under the terms of the license attached to the collection. Please see the LICENSE section for the full terms. Dell does not provide any support for the source code modifications. For any Ansible modules issues, questions or feedback, join the Dell Automation Community.
- Dell PowerScale OneFS versions 8.x, 9.0.x, 9.1.x, 9.2.x and 9.3.x
This table provides information about the software prerequisites for the Ansible Modules for Dell PowerScale.
| Ansible Modules | OneFS Version | Red Hat Enterprise Linux | Python version | Python SDK version | Ansible |
|---|---|---|---|---|---|
| v1.5.0 | 8.x 9.0.x 9.1.x 9.2.x 9.3.x |
8.4 8.5 |
3.5 3.6 3.9 |
8.1.1 9.0.0 |
2.10 2.11 2.12 |
The modules are written in such a way that all requests are idempotent and hence fault-tolerant. It essentially means that the result of a successfully performed request is independent of the number of times it is executed.
- File System Module
- Access Zone Module
- Users Module
- Groups Module
- Snapshot Module
- Snapshot Schedule Module
- NFS Module
- SMB Module
- Smart Quota Module
- Info Module
- Active Directory Module
- LDAP Module
- Node Module
- SyncIQ Policy Module
- SyncIQ Jobs Module
- SyncIQ Performance Rules Module
- SyncIQ Reports Module
- SyncIQ Target Reports Module
- Groupnet Module
- Subnet Module
- Network Pool Module
- Network Rule Module
- Settings Module
- Network Setting Module
- Smart Pool Setting Module
Based on which PowerScale OneFS version is being used, install sdk as follows:
-
For PowerScale OneFS version < 9.0.0, install python sdk named 'isi-sdk-8-1-1' as below:
pip install isi_sdk_8_1_1 -
For PowerScale OneFS version 9.0.0 and above, install python sdk named 'isi-sdk-9-0-0' as below:
pip install isi_sdk_9_0_0
- Use the following command to build the collection from source code:
ansible-galaxy collection build
For more details on how to build a tar ball, please refer: Building the collection
- Use the following command to install the latest collection hosted in galaxy:
ansible-galaxy collection install dellemc.powerscale -p <install_path>
- Download the latest tar build from either of the available distribution channels Ansible Galaxy /Automation Hub and use the following command to install the collection anywhere in your system:
ansible-galaxy collection install dellemc-powerscale-1.5.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 importing of a proper FQCN (Fully Qualified Collection Name) must be embedded in the playbook. Refer to the following example:
collections:
- dellemc.powerscale
- In order to use an installed collection specific to the task use a proper FQCN (Fully Qualified Collection Name). Refer to the following example:
tasks:
- name: Get filesystem details
dellemc.powerscale.filesystem
- For generating Ansible documentaion for a specific module, embed the FQCN before the module name. Refer to the following example:
ansible-doc dellemc.powerscale.info
The Ansible server must be configured with Python library for OneFS 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 need to be configured before running the modules.
- Export the SSL certificate using KeyStore Explorer tool or from the browser in .crt format.
- Append the SSL certificate to the Certifi package file cacert.pem.
- For Python 3.5 : cat <> >> /usr/local/lib/python3.5/dist-packages/certifi/cacert.pem
- For Python 2.7 : cat <> >> /usr/local/lib/python2.7/dist-packages/certifi/cacert.pem
Each module returns the updated state and details of the entity. For example, if you are using the group module, all calls will return the updated details of the group. Sample result is shown in each module's documentation.