Try SpotterNetApp ONTAP manage volumes.
| "added in version" 2.6 of ansible.builtin"
Authors: NetApp Ansible Team (ng-ansibleteam@netapp.com)
preview | supported by certified
pipInstall with pip install ansible==2.7.7
Create or destroy or modify volumes on NetApp ONTAP.
- 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 }}"
name:
description:
- The name of the volume to manage.
required: true
size:
description:
- The size of the volume in (size_unit). Required when C(state=present).
type:
description:
- The volume type, either read-write (RW) or data-protection (DP).
https:
default: false
description:
- Enable and disable https.
- Ignored when using REST as only https is supported.
- Ignored when using SSL certificate authentication as it requires SSL.
type: bool
state:
choices:
- present
- absent
default: present
description:
- Whether the specified volume should exist or not.
ontapi:
description:
- The ontap api version to use
type: int
policy:
description:
- Name of the export policy.
encrypt:
default: false
description:
- Whether or not to enable Volume Encryption.
type: bool
version_added: '2.7'
version_added_collection: ansible.builtin
vserver:
description:
- Name of the vserver to use.
required: true
hostname:
description:
- The hostname or IP address of the ONTAP instance.
required: true
type: str
password:
aliases:
- pass
description:
- Password for the specified user.
type: str
use_rest:
default: auto
description:
- 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.
type: str
username:
aliases:
- user
description:
- 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 U(https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/).
- Two authentication methods are supported
- 1. basic authentication, using username and password,
- 2. SSL certificate authentication, using a ssl client cert file, and optionally
a private key file.
- To use a certificate, the certificate must have been installed in the ONTAP cluster,
and cert authentication must have been enabled.
type: str
from_name:
description:
- Name of the existing volume to be renamed to name.
version_added: '2.7'
version_added_collection: ansible.builtin
http_port:
description:
- Override the default port (80 or 443) with this port
type: int
is_online:
default: true
description:
- Whether the specified volume is online, or not.
type: bool
size_unit:
choices:
- bytes
- b
- kb
- mb
- gb
- tb
- pb
- eb
- zb
- yb
default: gb
description:
- The unit used to interpret the size parameter.
is_infinite:
description: Set True if the volume is an Infinite Volume. Deleting an infinite volume
is asynchronous.
type: bool
key_filepath:
description:
- path to SSL client key file.
type: str
version_added: 20.6.0
version_added_collection: netapp.ontap
cert_filepath:
description:
- path to SSL client cert file (.pem).
- not supported with python 2.6.
type: str
version_added: 20.6.0
version_added_collection: netapp.ontap
feature_flags:
description:
- 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.
type: dict
version_added: 20.5.0
version_added_collection: netapp.ontap
junction_path:
description:
- Junction path of the volume.
aggregate_name:
description:
- The name of the aggregate the flexvol should exist on.
- Required when C(state=present).
validate_certs:
default: true
description:
- If set to C(no), the SSL certificates will not be validated.
- This should only set to C(False) used on personally controlled sites using self-signed
certificates.
type: bool
space_guarantee:
choices:
- none
- volume
description:
- Space guarantee style for the volume.
efficiency_policy:
description:
- Allows a storage efficiency policy to be set on volume creation.
version_added: '2.7'
version_added_collection: ansible.builtin
force_ontap_version:
description:
- 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 C(use_rest) is set to auto, this may force a switch to ZAPI based on the version
and platform capabilities.
- Ignored with ZAPI.
type: str
version_added: 21.23.0
version_added_collection: netapp.ontap
volume_security_style:
choices:
- mixed
- ntfs
- unified
- unix
default: mixed
description:
- The security style associated with this volume.
percent_snapshot_space:
description:
- Amount of space reserved for snapshot copies of the volume.