na_ontap_volume – NetApp ONTAP manage volumes — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# na_ontap_volume – NetApp ONTAP manage volumes

New in version 2.6.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Status

## 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 support Data ONTAP 9.1 and onward
- Ansible 2.6
- Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’
- Python3 netapp-lib (2018.11.13) or later. 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
--- | --- | ---
aggr_list list added in 2.8 |  | an array of names of aggregates to be used for FlexGroup constituents.
aggr_list_multiplier integer added in 2.8 |  | The number of times to iterate over the aggregates listed with the aggr_list parameter when creating a FlexGroup.
aggregate_name string |  | The name of the aggregate the flexvol should exist on. Required when `state=present`.
atime_update boolean added in 2.8 | Choices: no yes | 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.
auto_provision_as string added in 2.8 | Choices: flexgroup | Automatically provision a FlexGroup volume.
comment string added in 2.9 |  | Sets a comment associated with the volume.
efficiency_policy string added in 2.7 |  | Allows a storage efficiency policy to be set on volume creation.
encrypt boolean added in 2.7 | Choices: no ← yes | Whether or not to enable Volume Encryption.
from_name string added in 2.7 |  | Name of the existing volume to be renamed to name.
hostname string / 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 | Choices: no ← yes | Enable and disable https
is_infinite boolean | Choices: no yes | Set True if the volume is an Infinite Volume. Deleting an infinite volume is asynchronous.
is_online boolean | Choices: no yes ← | Whether the specified volume is online, or not.
junction_path string |  | Junction path of the volume. To unmount, use junction path `''`.
language string added in 2.8 |  | 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
name string / required |  | The name of the volume to manage.
nvfail_enabled boolean added in 2.9 | Choices: no yes | 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.
ontapi integer |  | The ontap api version to use
password string / required |  | Password for the specified user. aliases: pass
percent_snapshot_space integer |  | Amount of space reserved for snapshot copies of the volume.
policy string |  | Name of the export policy.
qos_adaptive_policy_group - added in 2.9 |  | Specifies a QoS adaptive policy group to be set on volume.
qos_policy_group - added in 2.9 |  | Specifies a QoS policy group to be set on volume.
size integer |  | The size of the volume in (size_unit). Required when `state=present`.
size_unit string | Choices: bytes b kb mb gb ← tb pb eb zb yb | The unit used to interpret the size parameter.
snapdir_access boolean added in 2.8 | Choices: no yes | 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.
snapshot_policy string added in 2.8 |  | The name of the snapshot policy. the default policy name is 'default'.
space_guarantee string | Choices: none file volume | Space guarantee style for the volume.
space_slo string added in 2.9 | Choices: none thick semi-thick | 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.
state - | Choices: present ← absent | Whether the specified volume should exist or not.
tiering_policy string added in 2.9 | Choices: snapshot-only auto backup none | 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. 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.
time_out integer added in 2.8 | Default: 180 | time to wait for flexGroup creation, modification, or deletion in seconds. Error out if task is not completed in defined time. if 0, the request is asynchronous. default is set to 3 minutes.
type string |  | The volume type, either read-write (RW) or data-protection (DP).
unix_permissions string added in 2.8 |  | 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.
use_rest string | Choices: Never Always Auto ← | REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. Always -- will always use the REST API Never -- will always use the ZAPI Auto -- will try to use the REST Api
username string / 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 | Choices: no yes ← | If set to `no`, 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 string | Choices: mixed ← ntfs unified unix | The security style associated with this volume.
vserver string / required |  | Name of the vserver to use.
vserver_dr_protection string added in 2.9 | Choices: protected unprotected | Specifies the protection type for the volume in a Vserver DR setup.
wait_for_completion boolean added in 2.8 | Choices: no ← yes | 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

## 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: ansibleVolume12
        is_infinite: False
        aggregate_name: ansible_aggr
        size: 100
        size_unit: mb
        space_guarantee: none
        tiering_policy: auto
        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
      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
      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
      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
        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 provision as flex group
      na_ontap_volume:
        state: present
        name: ansibleVolume
        is_infinite: False
        auto_provision_as: flexgroup
        size: 200
        size_unit: mb
        space_guarantee: none
        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
      na_ontap_volume:
        state: present
        name: ansibleVolume15
        is_infinite: False
        aggregate_name: ansible_aggr
        size: 100
        size_unit: gb
        space_guarantee: none
        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)
      na_ontap_volume:
        state: present
        name: ansibleVolume
        vserver_dr_protection: protected
        vserver: "{{ vserver }}"
        hostname: "{{ netapp_hostname }}"
        username: "{{ netapp_username }}"
        password: "{{ netapp_password }}"
        https: False

## 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 (@carchi8py) <ng-ansibleteam@netapp.com>

Hint

If you notice any issues in this documentation, you can edit this document to improve it.