Docs4dev
Docs
ansible / 2.6 / modules / na_ontap_volume_module.html

na_ontap_volume - Manage NetApp ONTAP 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.
hostname
required
The hostname or IP address of the ONTAP instance.
https
bool
    Choices:
  • no ←
  • yes
Enable and disabled https
is_infinite
bool
    Choices:
  • no
  • yes
Set True if the volume is an Infinite Volume. Deleting an infinite volume is asynchronous.
is_online
bool
    Choices:
  • no
  • yes ←
Whether the specified volume is online, or not.
junction_path
Junction path of the volume.
name
required
The name of the volume to manage.
new_name
New name of the volume to be renamed.
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
    Choices:
  • bytes
  • b
  • kb
  • mb
  • gb ←
  • tb
  • pb
  • eb
  • zb
  • yb
The unit used to interpret the size parameter.
space_guarantee
    Choices:
  • none
  • volume
Space guarantee style for the volume.
state
    Choices:
  • present ←
  • absent
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://goo.gl/BRu78Z.

aliases: user
volume_security_style
    Choices:
  • mixed ←
  • ntfs
  • unified
  • unix
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 flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

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.6/modules/na_ontap_volume_module.html