cisco.mso.ndo_vlan_pool module – Manage VLAN Pools on Cisco Nexus Dashboard Orchestrator (NDO).
Note
This module is part of the cisco.mso collection (version 2.9.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 cisco.mso
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.mso.ndo_vlan_pool
.
Synopsis
Manage VLAN Pools on Cisco Nexus Dashboard Orchestrator (NDO).
This module is only supported on ND v3.1 (NDO v4.3) and later.
Requirements
The below requirements are needed on the host that executes this module.
Multi Site Orchestrator v2.1 or newer
Parameters
Parameter |
Comments |
---|---|
The description of the VLAN Pool. |
|
IP Address or hostname of the ACI Multi Site Orchestrator host. If the value is not specified in the task, the value of environment variable |
|
The login domain name to use for authentication. The default value is Local. If the value is not specified in the task, the value of environment variable When using a HTTPAPI connection plugin the inventory variable |
|
Influence the output of this MSO module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
The password to use for authentication. If the value is not specified in the task, the value of environment variables |
|
Port number to be used for the REST connection. The default value depends on parameter `use_ssl`. If the value is not specified in the task, the value of environment variable |
|
Use Use Use Choices:
|
|
The name of the template. The template must be a fabric policy template. |
|
The socket level timeout in seconds. The default value is 30 seconds. If the value is not specified in the task, the value of environment variable |
|
If If the value is not specified in the task, the value of environment variable The default is Choices:
|
|
If If the value is not specified in the task, the value of environment variable When using a HTTPAPI connection plugin the inventory variable The default is Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default is Choices:
|
|
The name of the VLAN Pool. |
|
The uuid of the VLAN Pool. This parameter is required when the |
|
A list of vlan ranges attached to the VLAN Pool. The list of configured vlan ranges must contain at least one entry. When the list of vlan ranges is null the update will not change existing entry configuration. |
|
The start of the VLAN range. |
|
The end of the VLAN range. |
Notes
Note
This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.
Examples
- name: Create a new vlan pool
cisco.mso.ndo_vlan_pool:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_template
vlan_pool: ansible_test_vlan_pool
vlan_ranges:
- from_vlan: 100
to_vlan: 200
- from_vlan: 300
to_vlan: 400
state: present
- name: Query a vlan pool with template_name
cisco.mso.ndo_vlan_pool:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_template
vlan_pool: ansible_test_vlan_pool
state: query
register: query_one
- name: Query all vlan pools in the template
cisco.mso.ndo_vlan_pool:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_template
state: query
register: query_all
- name: Delete a vlan pool
cisco.mso.ndo_vlan_pool:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_template
vlan_pool: ansible_test_vlan_pool
state: absent