na_ontap_ports – NetApp ONTAP add/remove ports

New in version 2.9.

Synopsis

  • Add or remove ports for broadcast domain and 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
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
ipspace
string
Specify the required ipspace for the broadcast domain.
A domain ipspace can not be modified after the domain has been created.
names
list / required
List of ports.
ontapi
integer
The ontap api version to use
password
string / required
Password for the specified user.

aliases: pass
portset_type
string
    Choices:
  • fcp
  • iscsi
  • mixed
Protocols accepted for portset.
resource_name
string / required
name of the portset or broadcast domain.
resource_type
string / required
    Choices:
  • broadcast_domain
  • portset
type of the resource to add a port to or remove a port from.
state
string
    Choices:
  • present ←
  • absent
Whether the specified port should be added or removed.
use_rest
string
    Choices:
  • Never
  • Always
  • 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 / 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
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
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

Status

Authors

Hint

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