netapp.ontap.na_ontap_net_vlan module – NetApp ONTAP network VLAN
Note
This module is part of the netapp.ontap collection (version 21.24.1).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp.ontap.na_ontap_net_vlan.
New in netapp.ontap 2.6.0
Synopsis
Create/Modify/Delete network VLAN
Modify VLAN are supported only with REST
broadcast_domain, ipspace and enabled keys are supported with REST and is ignored with ZAPI
Requirements
The below requirements are needed on the host that executes this module.
Ansible 2.9 or later - 2.12 or later is recommended.
Python3 - 3.9 or later is recommended.
When using ZAPI, 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
Parameters
Parameter |
Comments |
|---|---|
Specify the broadcast_domain name. Only supported with REST and is ignored with ZAPI. Required with 9.6 and 9.7, but optional with 9.8 or later. |
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
Enable/Disable Net vlan. Only supported with REST and is ignored with ZAPI. Choices:
|
|
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. |
|
Override the cluster ONTAP version when using REST. The behavior is undefined if the version does not match the target cluster. This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. This should be in the form 9.10 or 9.10.1 with each element being an integer number. When Ignored with ZAPI. |
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
Specify the ipspace for the broadcast domain. Only supported with REST and is ignored with ZAPI. Required with 9.6 and 9.7, but optional with 9.8 or later. |
|
path to SSL client key file. |
|
Node name of VLAN interface. |
|
The ontap api version to use |
|
The interface that hosts the VLAN interface. |
|
Password for the specified user. |
|
Whether the specified network VLAN should exist or not Choices:
|
|
Whether to use REST or ZAPI. always – will always use the REST API if the module supports REST. A warning is issued if the module does not support REST. An error is issued if a module option is not supported in REST. never – will always use ZAPI if the module supports ZAPI. An error may be issued if a REST option is not supported in ZAPI. auto – will try to use the REST API if the module supports REST and modules options are supported. Reverts to ZAPI otherwise. Default: |
|
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
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
If set to This should only set to Choices:
|
|
The VLAN id. Ranges from 1 to 4094. |
Notes
Note
The
interface_nameoption has been removed and should be deleted from playbooksThe modules prefixed with na_ontap are built to support the ONTAP storage platform.
https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Examples
- name: create VLAN
netapp.ontap.na_ontap_net_vlan:
state: present
vlanid: 13
node: "{{ vlan_node }}"
ipspace: "{{ ipspace_name }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
hostname: "{{ netapp_hostname }}"
- name: Create and add vlan to broadcast domain - REST
netapp.ontap.na_ontap_net_vlan:
state: present
vlanid: 14
node: "{{ vlan_node }}"
parent_interface: "{{ vlan_parent_interface_name }}"
broadcast_domain: "{{ broadcast_domain_name }}"
ipspace: "{{ ipspace_name }}"
enabled: true
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
hostname: "{{ netapp_hostname }}"
- name: Disable VLAN - REST
netapp.ontap.na_ontap_net_vlan:
state: present
vlanid: 14
node: "{{ vlan_node }}"
parent_interface: "{{ vlan_parent_interface_name }}"
enabled: false
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
hostname: "{{ netapp_hostname }}"
- name: Delete VLAN
netapp.ontap.na_ontap_net_vlan:
state: absent
vlanid: 14
node: "{{ vlan_node }}"
parent_interface: "{{ vlan_parent_interface_name }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
hostname: "{{ netapp_hostname }}"