ansible / ansible.builtin / v2.7.7 / module / na_ontap_svm Manage NetApp ONTAP svm | "added in version" 2.6 of ansible.builtin" Authors: NetApp Ansible Team (ng-ansibleteam@netapp.com) preview | supported by certifiedansible.builtin.na_ontap_svm (v2.7.7) — module
pip
Install with pip install ansible==2.7.7
Create, modify or delete svm on NetApp ONTAP
- name: Create SVM 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: description: - The name of the SVM to manage. required: true 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 SVM should exist or not. ontapi: description: - The ontap api version to use type: int ipspace: description: - IPSpace name - Cannot be modified after creation. version_added: '2.7' version_added_collection: ansible.builtin subtype: choices: - default - dp_destination - sync_source - sync_destination description: - The subtype for vserver to be created. - Cannot be modified after creation. version_added: '2.7' version_added_collection: ansible.builtin hostname: description: - The hostname or IP address of the ONTAP instance. required: true type: str language: description: - 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 version_added: '2.7' version_added_collection: ansible.builtin 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 aggr_list: description: - 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. from_name: description: - Name of the SVM to be renamed version_added: '2.7' version_added_collection: ansible.builtin http_port: description: - Override the default port (80 or 443) with this port type: int root_volume: description: - Root volume of the SVM. - Cannot be modified after creation. 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 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 snapshot_policy: description: - 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. version_added: '2.7' version_added_collection: ansible.builtin allowed_protocols: description: - Allowed Protocols. - When specified as part of a vserver-create, this field represent the list of protocols allowed on the Vserver. - When part of vserver-get-iter call, this will return the list of Vservers which have any of the protocols specified as part of the allowed-protocols. - When part of vserver-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, - nvme NVMe protocol 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 root_volume_aggregate: description: - The aggregate on which the root volume will be created. - Cannot be modified after creation. root_volume_security_style: choices: - unix - ntfs - mixed - unified description: - 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.