cisco.mso.mso_schema_template_anp_epg_useg_attribute module – Manage EPG uSeg Attributes in schema templates
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.mso_schema_template_anp_epg_useg_attribute
.
Synopsis
Manage uSeg Attributes in the schema template EPGs on Cisco ACI Multi-Site.
Requirements
The below requirements are needed on the host that executes this module.
Multi Site Orchestrator v2.1 or newer
Parameters
Parameter |
Comments |
---|---|
The name of the Application Profile. |
|
The description of the uSeg Attribute. |
|
The name of the EPG. |
|
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 |
|
The name and display name of the uSeg Attribute. |
|
The operator type of the uSeg Attribute. Choices:
|
|
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 |
|
The name of the Schema. |
|
Use Use Choices:
|
|
The name of the 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 |
|
The type of the uSeg Attribute. Choices:
|
|
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 uSeg Subnet can only be used when the attribute_type is IP. Use Use 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 value of the uSeg Attribute. |
Notes
Note
Due to restrictions of the MSO REST API concurrent modifications to EPG subnets can be dangerous and corrupt data.
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: Add an uSeg attr with attribute_type - ip
cisco.mso.mso_schema_template_anp_epg_useg_attribute:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
name: useg_attr_ip
attribute_type: ip
useg_subnet: false
value: 10.0.0.0/24
state: present
- name: Query a specific EPG uSeg attr with name
cisco.mso.mso_schema_template_anp_epg_useg_attribute:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
name: useg_attr_ip
state: query
register: query_result
- name: Query all EPG uSeg attrs
cisco.mso.mso_schema_template_anp_epg_useg_attribute:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
state: query
register: query_result
- name: Remove a uSeg attr from an EPG with name
cisco.mso.mso_schema_template_anp_epg_useg_attribute:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
name: useg_attr_ip
state: absent