netapp.ontap.na_ontap_svm module – NetApp ONTAP SVM
Note
This module is part of the netapp.ontap collection (version 22.10.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_svm.
New in netapp.ontap 2.6.0
Synopsis
Create, modify or delete SVM 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 |
|---|---|
when the SVM is created, it will be in the running state, unless specified otherwise. This is ignored with ZAPI. Choices:
|
|
List of aggregates assigned for volume operations. These aggregates could be shared for use with other Vservers. When specified as part of a vserver-create, this field represents the list of aggregates that are assigned to the Vserver for volume operations. When part of vserver-get-iter call, this will return the list of Vservers which have any of the aggregates specified as part of the aggr list. |
|
Allowed Protocols. This field represent the list of protocols allowed on the Vserver. When part of modify, this field should include the existing list along with new protocol list to be added to prevent data disruptions. Possible values nfs NFS protocol, cifs CIFS protocol, fcp FCP protocol, iscsi iSCSI protocol, ndmp NDMP protocol, http HTTP protocol - ZAPI only, nvme NVMe protocol |
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
When specified as part of a vserver-create, this field represents the comment associated with the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers. |
|
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. |
|
Name of the SVM to be renamed |
|
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:
|
|
When true, ignore Ignored when Choices:
|
|
IPSpace name Cannot be modified after creation. |
|
path to SSL client key file. |
|
Language to use for the SVM Default to C.UTF-8 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 utf8mb4 Most of the values accept a .utf_8 suffix, e.g. fr.utf_8 |
|
Maximum number of volumes that can be created on the vserver. Expects an integer or |
|
The name of the SVM to manage. vserver is a convenient alias when using module_defaults. |
|
The ontap api version to use |
|
Password for the specified user. |
|
Root volume of the SVM. Cannot be modified after creation. |
|
The aggregate on which the root volume will be created. Cannot be modified after creation. |
|
Security Style of the root volume. When specified as part of the vserver-create, this field represents the security style for the Vserver root volume. When specified as part of vserver-get-iter call, this will return the list of matching Vservers. The ‘unified’ security style, which applies only to Infinite Volumes, cannot be applied to a Vserver’s root volume. Cannot be modified after creation. Choices:
|
|
Enabled Protocols, only available with REST. The service will be started if needed. A valid license may be required.
If a service is not present, it is left unchanged. |
|
CIFS protocol service |
|
If true, an SVM administrator can manage the CIFS service. If false, only the cluster administrator can manage the service. Choices:
|
|
FCP protocol service |
|
If true, an SVM administrator can manage the FCP service. If false, only the cluster administrator can manage the service. Choices:
|
|
If allowed, setting to true enables the FCP service. Choices:
|
|
iSCSI protocol service |
|
If true, an SVM administrator can manage the iSCSI service. If false, only the cluster administrator can manage the service. Choices:
|
|
If allowed, setting to true enables the iSCSI service. Choices:
|
|
Network Data Management Protocol service |
|
If this is set to true, an SVM administrator can manage the NDMP service If it is false, only the cluster administrator can manage the service. Requires ONTAP 9.10.1 or later. Choices:
|
|
NFS protocol service |
|
If true, an SVM administrator can manage the NFS service. If false, only the cluster administrator can manage the service. Choices:
|
|
If allowed, setting to true enables the NFS service. Choices:
|
|
nvme protocol service |
|
If true, an SVM administrator can manage the NVMe service. If false, only the cluster administrator can manage the service. Choices:
|
|
If allowed, setting to true enables the NVMe service. Choices:
|
|
Default snapshot policy setting for all volumes of the Vserver. This policy will be assigned to all volumes created in this Vserver unless the volume create request explicitly provides a snapshot policy or volume is modified later with a specific snapshot policy. A volume-level snapshot policy always overrides the default Vserver-wide snapshot policy. |
|
Whether the specified SVM should exist or not. Choices:
|
|
The subtype for vserver to be created. Cannot be modified after creation. Choices:
|
|
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: |
|
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:
|
|
web services security configuration. requires ONTAP 9.8 or later for certificate name. requires ONTAP 9.10.1 or later for the other options. |
|
name of certificate used by cluster and node management interfaces for TLS connection requests. The certificate must be of type “server”. |
|
whether client authentication is enabled. Choices:
|
|
whether online certificate status protocol verification is enabled. Choices:
|
Notes
Note
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 SVM
netapp.ontap.na_ontap_svm:
state: present
name: ansibleVServer
root_volume: vol1
root_volume_aggregate: aggr1
root_volume_security_style: mixed
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Create SVM
netapp.ontap.na_ontap_svm:
state: present
services:
cifs:
allowed: true
fcp:
allowed: true
nfs:
allowed: true
enabled: true
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
- name: Stop SVM REST
netapp.ontap.na_ontap_svm:
state: present
name: ansibleVServer
admin_state: stopped
use_rest: always
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"