netapp.ontap.na_ontap_portset – NetApp ONTAP Create/Delete portset
Note
This plugin is part of the netapp.ontap collection (version 21.14.1).
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
.
To use it in a playbook, specify: netapp.ontap.na_ontap_portset
.
New in version 2.8.0: of netapp.ontap
Synopsis
Create/Delete ONTAP portset, modify ports in a portset.
Modify type(protocol) is not supported in ONTAP.
Requirements
The below requirements are needed on the host that executes this module.
Ansible 2.9
Python3 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.
To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Parameters
Parameter |
Comments |
---|---|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
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. |
|
If ‘false’ or not specified, the request will fail if there are any igroups bound to this portset. If ‘true’, forcibly destroy the portset, even if there are existing igroup bindings. Choices:
|
|
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:
|
|
path to SSL client key file. |
|
Name of the port set to create. |
|
The ontap api version to use |
|
Password for the specified user. |
|
Specify the ports associated with this portset. Should be comma separated. It represents the expected state of a list of ports at any time, and replaces the current value of ports. Adds a port if it is specified in expected state but not in current state. Deletes a port if it is in current state but not in expected state. |
|
If you want to create a portset. Default: “present” |
|
Required for create. Protocols accepted for this portset. Choices:
|
|
REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always – will always use the REST API never – will always use the ZAPI auto – will try to use the REST Api Default: “auto” |
|
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:
|
|
Name of the SVM. |
Examples
- name: Create Portset
na_ontap_portset:
state: present
vserver: vserver_name
name: portset_name
ports: a1
type: "{{ protocol type }}"
username: "{{ netapp username }}"
password: "{{ netapp password }}"
hostname: "{{ netapp hostname }}"
- name: Modify ports in portset
na_ontap_portset:
state: present
vserver: vserver_name
name: portset_name
ports: a1,a2
username: "{{ netapp username }}"
password: "{{ netapp password }}"
hostname: "{{ netapp hostname }}"
- name: Delete Portset
na_ontap_portset:
state: absent
vserver: vserver_name
name: portset_name
force: True
type: "{{ protocol type }}"
username: "{{ netapp username }}"
password: "{{ netapp password }}"
hostname: "{{ netapp hostname }}"
Authors
NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>