netapp.ontap.na_ontap_ports – NetApp ONTAP add/remove ports

Note

This plugin is part of the netapp.ontap collection (version 21.1.1).

To install it use: ansible-galaxy collection install netapp.ontap.

To use it in a playbook, specify: netapp.ontap.na_ontap_ports.

New in version 2.9.0: of netapp.ontap

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

Add or remove ports for broadcast domain and portset.

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.
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. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL.
ipspace string		Specify the required ipspace for the broadcast domain. A domain ipspace can not be modified after the domain has been created.
key_filepath string added in 20.6.0 of netapp.ontap		path to SSL client key file.
names list / elements=string / required		List of ports.
ontapi integer		The ontap api version to use
password string		Password for the specified user. aliases: pass
portset_type string	fcp iscsi mixed	Protocols accepted for portset.
resource_name string / required		name of the portset or broadcast domain.
resource_type string / required	broadcast_domain portset	type of the resource to add a port to or remove a port from.
state string	present ← absent	Whether the specified port should be added or removed.
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	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		Name of the SVM. Specify this option when operating on portset.

Notes

Note

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

Examples

- name: broadcast domain remove port
  tags:
  - remove
  na_ontap_ports:
    state: absent
    names: test-vsim1:e0d-1,test-vsim1:e0d-2
    resource_type: broadcast_domain
    resource_name: ansible_domain
    hostname: "{{ hostname }}"
    username: user
    password: password
    https: False

- name: broadcast domain add port
  tags:
  - add
  na_ontap_ports:
    state: present
    names: test-vsim1:e0d-1,test-vsim1:e0d-2
    resource_type: broadcast_domain
    resource_name: ansible_domain
    ipspace: Default
    hostname: "{{ hostname }}"
    username: user
    password: password
    https: False

- name: portset remove port
  tags:
  - remove
  na_ontap_ports:
    state: absent
    names: lif_2
    resource_type: portset
    resource_name: portset_1
    vserver: "{{ vserver }}"
    hostname: "{{ hostname }}"
    username: user
    password: password
    https: False

- name: portset add port
  tags:
  - add
  na_ontap_ports:
    state: present
    names: lif_2
    resource_type: portset
    resource_name: portset_1
    portset_type: iscsi
    vserver: "{{ vserver }}"
    hostname: "{{ hostname }}"
    username: user
    password: password
    https: False

Authors

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

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