na_ontap_portset – NetApp ONTAP Create/Delete portset

New in version 2.8.

Synopsis
Requirements
Parameters
Notes
Examples
Status

Synopsis

Create/Delete ONTAP portset, modify ports in a portset.

Requirements

The below requirements are needed on the host that executes this module.

A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward
Ansible 2.6
Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’
Python3 netapp-lib (2018.11.13) or later. 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
force boolean	no ← yes	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.
hostname string / required		The hostname or IP address of the ONTAP instance.
http_port integer		Override the default port (80 or 443) with this port
https boolean	no ← yes	Enable and disable https
name - / required		Name of the port set to create.
ontapi integer		The ontap api version to use
password string / required		Password for the specified user. aliases: pass
ports -		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.
state -	Default: "present"	If you want to create a portset.
type -	fcp iscsi mixed	Required for create. Protocols accepted for this portset.
username string / 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://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. aliases: user
validate_certs boolean	no yes ←	If set to `no`, the SSL certificates will not be validated. This should only set to `False` used on personally controlled sites using self-signed certificates.
vserver - / required		Name of the SVM.

Notes

Note

The modules prefixed with na\_ontap are built to support the ONTAP storage platform.

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

Status

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors

NetApp Ansible Team (@carchi8py) <[email protected]>

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/na_ontap_portset_module.html