W3cubDocs

/Ansible

netapp.ontap.na_ontap_portset – NetApp ONTAP Create/Delete portset

Note

This plugin is part of the netapp.ontap collection (version 21.12.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.

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 Choices/Defaults Comments
cert_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client cert file (.pem).
not supported with python 2.6.
feature_flags
dictionary
added in 20.5.0 of netapp.ontap
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.
force
boolean
    Choices:
  • 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
    Choices:
  • no ←
  • yes
Enable and disable https.
Ignored when using REST as only https is supported.
Ignored when using SSL certificate authentication as it requires SSL.
key_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client key file.
name
string / required
Name of the port set to create.
ontapi
integer
The ontap api version to use
password
string
Password for the specified user.

aliases: pass
ports
list / elements=string
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
string
Default:
"present"
If you want to create a portset.
type
string
    Choices:
  • fcp
  • iscsi
  • mixed
Required for create.
Protocols accepted for this portset.
use_rest
string
Default:
"auto"
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
username
string
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
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.

aliases: user
validate_certs
boolean
    Choices:
  • 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
string / 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 }}"

Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_portset_module.html