netapp.ontap.na_ontap_volume module – NetApp ONTAP manage volumes.
Note
This module is part of the netapp.ontap collection (version 22.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.ontap.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp.ontap.na_ontap_volume.
New in netapp.ontap 2.6.0
Synopsis
Create or destroy or modify volumes on NetApp ONTAP.
Requirements
The below requirements are needed on the host that executes this module.
Ansible 2.9 or later - 2.12 or later is recommended.
Python3 - 3.9 or later is recommended.
When using ZAPI, netapp-lib 2018.11.13 or later (install using ‘pip install netapp-lib’), netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues
a physical or virtual clustered Data ONTAP system, the modules support Data ONTAP 9.1 and onward, REST support requires ONTAP 9.6 or later
Parameters
Parameter |
Comments |
|---|---|
an array of names of aggregates to be used for FlexGroup constituents. |
|
The number of times to iterate over the aggregates listed with the aggr_list parameter when creating a FlexGroup. |
|
The name of the aggregate the flexvol should exist on. Cannot be set when using the na_application_template option. |
|
Set file system analytics state of the volume. Only supported with REST and requires ONTAP 9.8 or later version. Cannot enable analytics for volume that contains luns. Choices:
|
|
This is an advanced option, the default is True. If false, prevent the update of inode access times when a file is read. This value is useful for volumes with extremely high read traffic, since it prevents writes to the inode file for the volume from contending with reads from other files. This field should be used carefully. That is, use this field when you know in advance that the correct access time for inodes will not be needed for files on that volume. Choices:
|
|
Automatically provision a FlexGroup volume. Choices:
|
|
Flag to control automatic map of LUNs. Choices:
|
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
The amount of time in seconds to wait between checks of a volume to see if it has moved successfully. Default: |
|
Sets a comment associated with the volume. |
|
Whether to enable compression for the volume (HDD and Flash Pool aggregates). If this option is not present, it is automatically set to true if inline_compression is true. Choices:
|
|
Specifies the action to be taken for cutover. Possible values are ‘abort_on_failure’, ‘defer_on_failure’, ‘force’ and ‘wait’. Default is ‘defer_on_failure’. Choices:
|
|
Allows a storage efficiency policy to be set on volume creation. |
|
Whether or not to enable Volume Encryption. If not present, ONTAP defaults to false at volume creation. Changing encrypt value after creation requires ONTAP 9.3 or later. Choices:
|
|
Name of the export policy. Mutually exclusive with nfs_access suboption in nas_application_template. |
|
Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. |
|
Override the cluster ONTAP version when using REST. The behavior is undefined if the version does not match the target cluster. This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. This should be in the form 9.10 or 9.10.1 with each element being an integer number. When Ignored with ZAPI. |
|
If this field is set to “true”, the Snapshot copy is restored even if the volume has one or more newer Snapshot copies which are currently used as reference Snapshot copy by SnapMirror. If a restore is done in this situation, this will cause future SnapMirror transfers to fail. Option should only be used along with snapshot_restore. Choices:
|
|
Flag to control automatic unmap of LUNs. Choices:
|
|
Name of the existing volume to be renamed to name. |
|
The source vserver of the volume is rehosted. |
|
The UNIX group ID for the volume. The default value is 0 (‘root’). |
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
Whether to enable inline compression for the volume (HDD and Flash Pool aggregates, AFF platforms). Choices:
|
|
Set True if the volume is an Infinite Volume. Deleting an infinite volume is asynchronous. Choices:
|
|
Whether the specified volume is online, or not. Choices:
|
|
Junction path of the volume. To unmount, use junction path |
|
path to SSL client key file. |
|
Language to use for Volume Default uses SVM language Possible values Language c POSIX ar Arabic cs Czech da Danish de German en English en_us English (US) es Spanish fi Finnish fr French he Hebrew hr Croatian hu Hungarian it Italian ja Japanese euc-j ja_v1 Japanese euc-j ja_jp.pck Japanese PCK (sjis) ja_jp.932 Japanese cp932 ja_jp.pck_v2 Japanese PCK (sjis) ko Korean no Norwegian nl Dutch pl Polish pt Portuguese ro Romanian ru Russian sk Slovak sl Slovenian sv Swedish tr Turkish zh Simplified Chinese zh.gbk Simplified Chinese (GBK) zh_tw Traditional Chinese euc-tw zh_tw.big5 Traditional Chinese Big 5 To use UTF-8 as the NFS character set, append ‘.UTF-8’ to the language code |
|
This optionally specifies whether to perform logical space accounting on the volume. When space is enforced logically, ONTAP enforces volume settings such that all the physical space saved by the storage efficiency features will be calculated as used. This is only supported with REST. Choices:
|
|
This optionally specifies whether to report space logically on the volume. When space is reported logically, ONTAP reports the volume space such that all the physical space saved by the storage efficiency features are also reported as used. This is only supported with REST. Choices:
|
|
The maximum number of files (inodes) for user-visible data allowed on the volume. Note - ONTAP allocates a slightly different value, for instance 3990 when asking for 4000. Tp preserve idempotency, small variations in size are ignored. |
|
Volume move and encryption operations might take longer time to complete. With If time exipres, module exit and the operation may still running. Default is set to 10 minutes. Default: |
|
The name of the volume to manage. |
|
additional options when using the application/applications REST API to create a volume. the module is using ZAPI by default, and switches to REST if any suboption is present. create a FlexVol by default. create a FlexGroup if create a FlexCache if |
|
The list of CIFS access controls. You must provide user_or_group or access to enable CIFS access. |
|
The CIFS access granted to the user or group. Default is full_control. Choices:
|
|
The name of the CIFS user or group that will be granted access. Default is Everyone. |
|
The list of aggregate names to exclude when creating a volume. Requires ONTAP 9.9.1 GA or later. |
|
whether to create a flexcache. If absent, a FlexVol or FlexGroup is created. |
|
whether to use the same flexgroup msid as the origin. requires ONTAP 9.9 and REST. create only option, ignored if the flexcache already exists. Choices:
|
|
the remote component for the flexcache. |
|
the remote SVM for the flexcache. |
|
The list of NFS access controls. You must provide host or access to enable NFS access. Mutually exclusive with export_policy option. |
|
The NFS access granted. Default is rw. Choices:
|
|
The name of the NFS entity granted access. Default is 0.0.0.0/0. |
|
The performance service level (PSL) for this volume Choices:
|
|
Cloud tiering policy (see |
|
Storage tiering placement rules for the container. Choices:
|
|
list of object store names for tiering. |
|
Cloud tiering policy (see Must match Choices:
|
|
Whether to use the application/applications REST/API to create a volume. This will default to true if any other suboption is present. Choices:
|
|
If true, the controller performs additional work at boot and takeover times if it finds that there has been any potential data loss in the volume’s constituents due to an NVRAM failure. The volume’s constituents would be put in a special state called ‘in-nvfailed-state’ such that protocol access is blocked. This will cause the client applications to crash and thus prevent access to stale data. To get out of this situation, the admin needs to manually clear the ‘in-nvfailed-state’ on the volume’s constituents. Choices:
|
|
The ontap api version to use |
|
Password for the specified user. |
|
Amount of space reserved for snapshot copies of the volume. |
|
If this field is set to “true”, LUNs in the volume being restored will remain mapped and their identities preserved such that host connectivity will not be disrupted during the restore operation. I/O’s to the LUN will be fenced during the restore operation by placing the LUNs in an unavailable state. Once the restore operation has completed, hosts will be able to resume I/O access to the LUNs. Option should only be used along with snapshot_restore. Choices:
|
|
Specifies a QoS adaptive policy group to be set on volume. |
|
Specifies a QoS policy group to be set on volume. |
|
The size of the volume in (size_unit). Required when |
|
Percentage in size change to trigger a resize. When this parameter is greater than 0, a difference in size between what is expected and what is configured is ignored if it is below the threshold. For instance, the nas application allocates a larger size than specified to account for overhead. Set this to 0 for an exact match. Default: |
|
The unit used to interpret the size parameter. Choices:
|
|
Represents the method to modify the size of a FlexGroup. use_existing_resources - Increases or decreases the size of the FlexGroup by increasing or decreasing the size of the current FlexGroup resources. add_new_resources - Increases the size of the FlexGroup by adding new resources. This is limited to two new resources per available aggregate. This is only supported if REST is enabled (ONTAP 9.6 or later) and only for FlexGroups. ONTAP defaults to use_existing_resources. Choices:
|
|
This is an advanced option, the default is False. Enable the visible ‘.snapshot’ directory that is normally present at system internal mount points. This value also turns on access to all other ‘.snapshot’ directories in the volume. Choices:
|
|
Starting with ONTAP 9.10.1, snaplock.type is set at the volume level. The other suboptions can be set or modified when using REST on earlier versions of ONTAP. This option and suboptions are only supported with REST. |
|
when enabled, all the files created with write permissions on the volume are, by default, WORM appendable files. The user can append the data to a WORM appendable file but cannot modify the existing contents of the file nor delete the file until it expires. Choices:
|
|
autocommit period for SnapLock volume. All files which are not modified for a period greater than the autocommit period of the volume are committed to the WORM state. duration is in the ISO-8601 duration format (eg PY, PM, PD, PTH, PTM). examples P30M, P10Y, PT1H, “none”. A duration that combines different periods is not supported. |
|
privileged-delete attribute of a SnapLock volume. On a SnapLock Enterprise (SLE) volume, a designated privileged user can selectively delete files irrespective of the retention time of the file. On a SnapLock Compliance (SLC) volume, it is always permanently_disabled. Choices:
|
|
default, maximum, and minumum retention periods for files committed to the WORM state on the volume. durations are in the ISO-8601 duration format, see autocommit_period. |
|
default retention period that is applied to files while committing them to the WORM state without an associated retention period. |
|
maximum allowed retention period for files committed to the WORM state on the volume. |
|
minimum allowed retention period for files committed to the WORM state on the volume. |
|
The SnapLock type of the volume. compliance - A SnapLock Compliance (SLC) volume provides the highest level of WORM protection and an administrator cannot destroy a SLC volume if it contains unexpired WORM files. enterprise - An administrator can delete a SnapLock Enterprise (SLE) volume. non_snaplock - Indicates the volume is non-snaplock. Choices:
|
|
A dictionary for the auto delete options and values. Supported options include ‘state’, ‘commitment’, ‘trigger’, ‘target_free_space’, ‘delete_order’, ‘defer_delete’, ‘prefix’, ‘destroy_list’. Option ‘state’ determines if the snapshot autodelete is currently enabled for the volume. Possible values are ‘on’ and ‘off’. Option ‘commitment’ determines the snapshots which snapshot autodelete is allowed to delete to get back space. Possible values are ‘try’, ‘disrupt’ and ‘destroy’. Option ‘trigger’ determines the condition which starts the automatic deletion of snapshots. Possible values are ‘volume’, ‘snap_reserve’ and DEPRECATED ‘space_reserve’. Option ‘target_free_space’ determines when snapshot autodelete should stop deleting snapshots. Depending on the trigger, snapshots are deleted till we reach the target free space percentage. Accepts int type. Option ‘delete_order’ determines if the oldest or newest snapshot is deleted first. Possible values are ‘newest_first’ and ‘oldest_first’. Option ‘defer_delete’ determines which kind of snapshots to delete in the end. Possible values are ‘scheduled’, ‘user_created’, ‘prefix’ and ‘none’. Option ‘prefix’ can be set to provide the prefix string for the ‘prefix’ value of the ‘defer_delete’ option. The prefix string length can be 15 char long. Option ‘destroy_list’ is a comma seperated list of services which can be destroyed if the snapshot backing that service is deleted. For 7-mode, the possible values for this option are a combination of ‘lun_clone’, ‘vol_clone’, ‘cifs_share’, ‘file_clone’ or ‘none’. For cluster-mode, the possible values for this option are a combination of ‘lun_clone,file_clone’ (for LUN clone and/or file clone), ‘lun_clone,sfsr’ (for LUN clone and/or sfsr), ‘vol_clone’, ‘cifs_share’, or ‘none’. |
|
The name of the snapshot policy. The default policy name is ‘default’. If present, this will set the protection_type when using |
|
Name of snapshot to restore from. Not supported on Infinite Volume. |
|
Space guarantee style for the volume. The file setting is no longer supported. Choices:
|
|
Specifies the space SLO type for the volume. The space SLO type is the Service Level Objective for space management for the volume. The space SLO value is used to enforce existing volume settings so that sufficient space is set aside on the aggregate to meet the space SLO. This parameter is not supported on Infinite Volumes. Choices:
|
|
Whether the specified volume should exist or not. Choices:
|
|
Tags are an optional way to track the uses of a resource. Tag values must be formatted as key:value strings, example [“team:csi”, “environment:test”] |
|
Determines how many days must pass before inactive data in a volume using the Auto or Snapshot-Only policy is considered cold and eligible for tiering. This option is only supported in REST 9.8 or later. |
|
The tiering policy that is to be associated with the volume. This policy decides whether the blocks of a volume will be tiered to the capacity tier. snapshot-only policy allows tiering of only the volume snapshot copies not associated with the active file system. auto policy allows tiering of both snapshot and active file system user data to the capacity tier. backup policy on DP volumes allows all transferred user data blocks to start in the capacity tier. all is the REST equivalent for backup. When set to none, the Volume blocks will not be tiered to the capacity tier. If no value specified, the volume is assigned snapshot only by default. Requires ONTAP 9.4 or later. Choices:
|
|
With ZAPI - time to wait for Flexgroup creation, modification, or deletion in seconds. With REST - time to wait for any volume creation, modification, or deletion in seconds. Error out if task is not completed in defined time. With ZAPI - if 0, the request is asynchronous. Default is set to 3 minutes. Use Default: |
|
The volume type, either read-write (RW) or data-protection (DP). |
|
Unix permission bits in octal or symbolic format. For example, 0 is equivalent to ————, 777 is equivalent to —rwxrwxrwx,both formats are accepted. The valid octal value ranges between 0 and 777 inclusive. |
|
Whether to use REST or ZAPI. always – will always use the REST API if the module supports REST. A warning is issued if the module does not support REST. An error is issued if a module option is not supported in REST. never – will always use ZAPI if the module supports ZAPI. An error may be issued if a REST option is not supported in ZAPI. auto – will try to use the REST API if the module supports REST and modules options are supported. Reverts to ZAPI otherwise. Default: |
|
The UNIX user ID for the volume. The default value is 0 (‘root’). |
|
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/. Two authentication methods are supported
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
If set to This should only set to Choices:
|
|
The security style associated with this volume. Choices:
|
|
Name of the vserver to use. |
|
Specifies the protection type for the volume in a Vserver DR setup. Choices:
|
|
Set this parameter to ‘true’ for synchronous execution during create (wait until volume status is online) Set this parameter to ‘false’ for asynchronous execution For asynchronous, execution exits as soon as the request is sent, without checking volume status Choices:
|
Notes
Note
supports REST and ZAPI. REST requires ONTAP 9.6 or later. Efficiency with REST requires ONTAP 9.7 or later.
REST is enabled when
use_restis set to always.The feature_flag
warn_or_fail_on_fabricpool_backend_changecontrols whether an error is reported when tiering control would require or disallow FabricPool for an existing volume with a different backend. Allowed values are fail, warn, and ignore, and the default is set to fail.snapshot_restore is not idempotent, it always restores.
The modules prefixed with na_ontap are built to support the ONTAP storage platform.
https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Examples
- name: Create FlexVol
netapp.ontap.na_ontap_volume:
state: present
name: ansibleVolume12
is_infinite: False
aggregate_name: ansible_aggr
size: 100
size_unit: mb
user_id: 1001
group_id: 2002
space_guarantee: none
tiering_policy: auto
export_policy: default
percent_snapshot_space: 60
qos_policy_group: max_performance_gold
vserver: ansibleVServer
wait_for_completion: True
space_slo: none
nvfail_enabled: False
comment: ansible created volume
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Volume Delete
netapp.ontap.na_ontap_volume:
state: absent
name: ansibleVolume12
aggregate_name: ansible_aggr
vserver: ansibleVServer
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Make FlexVol offline
netapp.ontap.na_ontap_volume:
state: present
name: ansibleVolume
is_infinite: False
is_online: False
vserver: ansibleVServer
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Create Flexgroup volume manually
netapp.ontap.na_ontap_volume:
state: present
name: ansibleVolume
is_infinite: False
aggr_list: "{{ aggr_list }}"
aggr_list_multiplier: 2
size: 200
size_unit: mb
space_guarantee: none
export_policy: default
vserver: "{{ vserver }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: False
unix_permissions: 777
snapshot_policy: default
time_out: 0
- name: Create Flexgroup volume auto provsion as flex group
netapp.ontap.na_ontap_volume:
state: present
name: ansibleVolume
is_infinite: False
auto_provision_as: flexgroup
size: 200
size_unit: mb
space_guarantee: none
export_policy: default
vserver: "{{ vserver }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: False
unix_permissions: 777
snapshot_policy: default
time_out: 0
- name: Create FlexVol with QoS adaptive
netapp.ontap.na_ontap_volume:
state: present
name: ansibleVolume15
is_infinite: False
aggregate_name: ansible_aggr
size: 100
size_unit: gb
space_guarantee: none
export_policy: default
percent_snapshot_space: 10
qos_adaptive_policy_group: extreme
vserver: ansibleVServer
wait_for_completion: True
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Modify volume dr protection (vserver of the volume must be in a snapmirror relationship)
netapp.ontap.na_ontap_volume:
state: present
name: ansibleVolume
vserver_dr_protection: protected
vserver: "{{ vserver }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: False
- name: Modify volume with snapshot auto delete options
netapp.ontap.na_ontap_volume:
state: present
name: vol_auto_delete
snapshot_auto_delete:
state: "on"
commitment: try
defer_delete: scheduled
target_free_space: 30
destroy_list: lun_clone,vol_clone
delete_order: newest_first
aggregate_name: "{{ aggr }}"
vserver: "{{ vserver }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: False
- name: Move volume with force cutover action
netapp.ontap.na_ontap_volume:
name: ansible_vol
aggregate_name: aggr_ansible
cutover_action: force
vserver: "{{ vserver }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: false
- name: Rehost volume to another vserver auto remap luns
netapp.ontap.na_ontap_volume:
name: ansible_vol
from_vserver: ansible
auto_remap_luns: true
vserver: "{{ vserver }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: false
- name: Rehost volume to another vserver force unmap luns
netapp.ontap.na_ontap_volume:
name: ansible_vol
from_vserver: ansible
force_unmap_luns: true
vserver: "{{ vserver }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: false
- name: Snapshot restore volume
netapp.ontap.na_ontap_volume:
name: ansible_vol
vserver: ansible
snapshot_restore: 2020-05-24-weekly
force_restore: true
preserve_lun_ids: true
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
- name: Volume create using application/applications nas template
netapp.ontap.na_ontap_volume:
state: present
name: ansibleVolume12
vserver: ansibleSVM
size: 100000000
size_unit: b
space_guarantee: none
language: es
percent_snapshot_space: 60
unix_permissions: ---rwxrwxrwx
snapshot_policy: default
efficiency_policy: default
comment: testing
nas_application_template:
nfs_access: # the mere presence of a suboption is enough to enable this new feature
- access: ro
- access: rw
host: 10.0.0.0/8
exclude_aggregates: aggr0
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
# requires Ontap collection version - 21.24.0 to use iso filter plugin.
- name: volume create with snaplock set.
netapp.ontap.na_ontap_volume:
state: present
name: "{{ snaplock_volume }}"
aggregate_name: "{{ aggregate }}"
size: 20
size_unit: mb
space_guarantee: none
policy: default
type: rw
snaplock:
type: enterprise
retention:
default: "{{ 60 | netapp.ontap.iso8601_duration_from_seconds }}"