na_ontap_volume – NetApp ONTAP manage volumes.
New in version 2.6.
Synopsis
- Create or destroy or modify volumes on NetApp ONTAP.
Requirements
The below requirements are needed on the host that executes this module.
- A physical or virtual clustered Data ONTAP system. The modules were developed with Clustered Data ONTAP 9.3
- Ansible 2.6
- netapp-lib (2017.10.30). Install using ‘pip install netapp-lib’
- To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| aggregate_name
-
|
The name of the aggregate the flexvol should exist on.
Required when state=present.
|
|
| efficiency_policy
-
added in 2.7
|
Allows a storage efficiency policy to be set on volume creation.
|
|
| encrypt
boolean
added in 2.7
|
|
Whether or not to enable Volume Encryption.
|
| from_name
-
added in 2.7
|
Name of the existing volume to be renamed to name.
|
|
| hostname
- / required
|
The hostname or IP address of the ONTAP instance.
|
|
| http_port
integer
|
Override the default port (80 or 443) with this port
|
|
| https
boolean
|
|
Enable and disable https
|
| is_infinite
boolean
|
|
Set True if the volume is an Infinite Volume. Deleting an infinite volume is asynchronous.
|
| is_online
boolean
|
|
Whether the specified volume is online, or not.
|
| junction_path
-
|
Junction path of the volume.
|
|
| name
- / required
|
The name of the volume to manage.
|
|
| password
- / required
|
Password for the specified user.
aliases: pass |
|
| percent_snapshot_space
-
|
Amount of space reserved for snapshot copies of the volume.
|
|
| policy
-
|
Name of the export policy.
|
|
| size
-
|
The size of the volume in (size_unit). Required when state=present.
|
|
| size_unit
-
|
|
The unit used to interpret the size parameter.
|
| space_guarantee
-
|
|
Space guarantee style for the volume.
|
| state
-
|
|
Whether the specified volume should exist or not.
|
| type
-
|
The volume type, either read-write (RW) or data-protection (DP).
|
|
| username
- / required
|
This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required. For more information, please read the documentation https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.
aliases: user |
|
| validate_certs
boolean
|
|
If set to
False, the SSL certificates will not be validated.
This should only set to False used on personally controlled sites using self-signed certificates.
|
| volume_security_style
-
|
|
The security style associated with this volume.
|
| vserver
- / required
|
Name of the vserver to use.
|
Notes
Note
- The modules prefixed with na_ontap are built to support the ONTAP storage platform.
Examples
- name: Create FlexVol
na_ontap_volume:
state: present
name: ansibleVolume
is_infinite: False
aggregate_name: aggr1
size: 20
size_unit: mb
junction_path: /ansibleVolume11
vserver: ansibleVServer
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Make FlexVol offline
na_ontap_volume:
state: present
name: ansibleVolume
is_infinite: False
is_online: False
vserver: ansibleVServer
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- NetApp Ansible Team (ng-ansibleteam@netapp.com)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/na_ontap_volume_module.html