netapp.elementsw.na_elementsw_volume module – NetApp Element Software Manage Volumes
Note
This module is part of the netapp.elementsw collection (version 21.7.0).
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 netapp.elementsw
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp.elementsw.na_elementsw_volume
.
Note
The netapp.elementsw collection is considered unmaintained and will be removed from Ansible 10. See the discussion thread for more information.
New in netapp.elementsw 2.7.0
Synopsis
Create, destroy, or update volumes on ElementSW
Requirements
The below requirements are needed on the host that executes this module.
The modules were developed with SolidFire 10.1
solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’
Parameters
Parameter |
Comments |
---|---|
Access allowed for the volume. readOnly Only read operations are allowed. readWrite Reads and writes are allowed. locked No reads or writes are allowed. replicationTarget Identify a volume as the target volume for a paired set of volumes. If the volume is not paired, the access status is locked. If unspecified, the access settings of the clone will be the same as the source. Choices:
|
|
Account ID for the owner of this volume. It accepts Account_id or Account_name |
|
A YAML dictionary of attributes that you would like to apply on this volume. |
|
Required when Should the volume provide 512-byte sector emulation? Choices:
|
|
The hostname or IP address of the SolidFire cluster. For na_elementsw_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. |
|
The name of the volume to manage. It accepts volume_name or volume_id |
|
Password for the specified user. |
|
Initial quality of service settings for this volume. Configure as dict in playbooks. |
|
Quality of service policy for this volume. It can be a name or an id. Mutually exclusive with |
|
The size of the volume in (size_unit). Required when |
|
The unit used to interpret the size parameter. Choices:
|
|
Whether the specified volume should exist or not. Choices:
|
|
Please ensure that the user has the adequate permissions. For more information, please read the official documentation https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US. |
Notes
Note
The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform.
Examples
- name: Create Volume
na_elementsw_volume:
hostname: "{{ elementsw_hostname }}"
username: "{{ elementsw_username }}"
password: "{{ elementsw_password }}"
state: present
name: AnsibleVol
qos: {minIOPS: 1000, maxIOPS: 20000, burstIOPS: 50000}
account_id: 3
enable512e: False
size: 1
size_unit: gb
- name: Update Volume
na_elementsw_volume:
hostname: "{{ elementsw_hostname }}"
username: "{{ elementsw_username }}"
password: "{{ elementsw_password }}"
state: present
name: AnsibleVol
account_id: 3
access: readWrite
- name: Delete Volume
na_elementsw_volume:
hostname: "{{ elementsw_hostname }}"
username: "{{ elementsw_username }}"
password: "{{ elementsw_password }}"
state: absent
name: AnsibleVol
account_id: 2
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Success message Returned: success |