Documentation

na_ontap_svm - Manage NetApp Ontap svm

New in version 2.6.

Synopsis

  • Create, modify or delete svm 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
aggr_list
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
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
hostname
required
The hostname or IP address of the ONTAP instance.
https
bool
    Choices:
  • no ←
  • yes
Enable and disabled https
name
required
The name of the SVM to manage.
new_name
New name of the SVM to be renamed
password
required
Password for the specified user.

aliases: pass
root_volume
Root volume of the SVM. Required when state=present.
root_volume_aggregate
The aggregate on which the root volume will be created.
Required when state=present.
root_volume_security_style
    Choices:
  • unix
  • ntfs
  • mixed
  • unified
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.
Required when state=present
state
    Choices:
  • present ←
  • absent
Whether the specified SVM should exist or not.
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

Notes

Note

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

Examples

- 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 }}"

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

Hint

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