/ home / ansible / ansible.builtin / v2.9.26 / module / na_ontap_ports

ansible.builtin.na_ontap_ports (v2.9.26) — module

NetApp ONTAP add/remove ports

| "added in version" 2.9 of ansible.builtin"

Authors: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>

preview | supported by community

Install Ansible via `pip`

Install with pip install ansible==2.9.26

Description

Add or remove ports for broadcast domain and portset.

Requirements

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.
Ansible 2.6
Ansible 2.9 or later is strongly recommended as it enables the new collection delivery system.
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'
netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.
To enable http on the cluster you must run the following commands 'set -privilege advanced;' 'system services web modify -http-enabled true;'

Usage examples

Scanned by Steampunk Spotter


    - 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

Scanned by Steampunk Spotter

    - 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

Scanned by Steampunk Spotter

    - 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

Scanned by Steampunk Spotter

    - 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

Inputs

https:
default: false
description:
- Enable and disable https.
- Ignored when using REST as only https is supported.
- Ignored when using SSL certificate authentication as it requires SSL.
type: bool

names:
description:
- List of ports.
required: true
type: list

state:
choices:
- present
- absent
default: present
description:
- Whether the specified port should be added or removed.
type: str

ontapi:
description:
- The ontap api version to use
type: int

ipspace:
description:
- Specify the required ipspace for the broadcast domain.
- A domain ipspace can not be modified after the domain has been created.
type: str

vserver:
description:
- Name of the SVM.
- Specify this option when operating on portset.
type: str

hostname:
description:
- The hostname or IP address of the ONTAP instance.
required: true
type: str

password:
aliases:
- pass
description:
- Password for the specified user.
type: str

use_rest:
choices:
- Never
- Always
- Auto
default: Auto
description:
- 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
type: str

username:
aliases:
- user
description:
- 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 U(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.
type: str

http_port:
description:
- Override the default port (80 or 443) with this port
type: int

key_filepath:
description:
- path to SSL client key file.
type: str
version_added: 20.6.0
version_added_collection: netapp.ontap

portset_type:
choices:
- fcp
- iscsi
- mixed
description:
- Protocols accepted for portset.
type: str

cert_filepath:
description:
- path to SSL client cert file (.pem).
- not supported with python 2.6.
type: str
version_added: 20.6.0
version_added_collection: netapp.ontap

feature_flags:
description:
- 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.
type: dict
version_added: 20.5.0
version_added_collection: netapp.ontap

resource_name:
description:
- name of the portset or broadcast domain.
required: true
type: str

resource_type:
choices:
- broadcast_domain
- portset
description:
- type of the resource to add a port to or remove a port from.
required: true
type: str

validate_certs:
default: true
description:
- If set to C(no), the SSL certificates will not be validated.
- This should only set to C(False) used on personally controlled sites using self-signed
certificates.
type: bool

Install Ansible via pip

Description

Requirements

Usage examples

Inputs

Install Ansible via `pip`