Try SpotterManage Endpoint Groups (EPGs) in schema templates
| "added in version" 2.8 of ansible.builtin"
Authors: Dag Wieers (@dagwieers)
preview | supported by community
pipInstall with pip install ansible==2.8.11
Manage EPGs in schema templates on Cisco ACI Multi-Site.
- name: Add a new EPG
mso_schema_template_anp_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
state: present
delegate_to: localhost
- name: Remove an EPG
mso_schema_template_anp_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
state: absent
delegate_to: localhost
- name: Query a specific EPG
mso_schema_template_anp_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
epg: EPG 1
state: query
delegate_to: localhost
register: query_result
- name: Query all EPGs
mso_schema_template_anp_epg:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
anp: ANP 1
state: query
delegate_to: localhost
register: query_result
bd:
description:
- The BD associated to this ANP.
suboptions:
name:
description:
- The name of the BD to associate with.
required: true
type: str
schema:
description:
- The schema that defines the referenced BD.
- If this parameter is unspecified, it defaults to the current schema.
type: str
template:
description:
- The template that defines the referenced BD.
type: str
type: dict
anp:
description:
- The name of the ANP.
required: true
type: str
epg:
aliases:
- name
description:
- The name of the EPG to manage.
type: str
host:
aliases:
- hostname
description:
- 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 C(MSO_HOST)
will be used instead.
type: str
port:
description:
- 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 C(MSO_PORT)
will be used instead.
type: int
state:
choices:
- absent
- present
- query
default: present
description:
- Use C(present) or C(absent) for adding or removing.
- Use C(query) for listing an object or multiple objects.
type: str
schema:
description:
- The name of the schema.
required: true
type: str
subnets:
description:
- The subnets associated to this ANP.
suboptions:
description:
description:
- The description of this subnet.
type: str
ip:
description:
- The IP range in CIDR notation.
required: true
type: str
no_default_gateway:
description:
- Whether this subnet has a default gateway.
type: bool
scope:
choices:
- private
- public
description:
- The scope of the subnet.
type: str
shared:
description:
- Whether this subnet is shared between VRFs.
type: bool
type: list
timeout:
description:
- 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 C(MSO_TIMEOUT)
will be used instead.
type: int
use_ssl:
description:
- If C(false), an HTTP connection will be used instead of the default HTTPS connection.
- If the value is not specified in the task, the value of environment variable C(MSO_USE_SSL)
will be used instead.
- When using a HTTPAPI connection plugin the inventory variable C(ansible_httpapi_use_ssl)
will be used if this attribute is not specified.
- The default is C(false) when using a HTTPAPI connection plugin (mso or nd) and C(true)
when using the legacy connection method (only for mso).
type: bool
password:
description:
- The password to use for authentication.
- If the value is not specified in the task, the value of environment variables C(MSO_PASSWORD)
or C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
template:
description:
- The name of the template.
required: true
type: str
useg_epg:
description:
- Whether this is a USEG EPG.
type: bool
username:
description:
- The username to use for authentication.
- If the value is not specified in the task, the value of environment variables C(MSO_USERNAME)
or C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
use_proxy:
description:
- If C(false), it will not use a proxy, even if one is defined in an environment variable
on the target hosts.
- If the value is not specified in the task, the value of environment variable C(MSO_USE_PROXY)
will be used instead.
- The default is C(true).
type: bool
display_name:
description:
- The name as displayed on the MSO web interface.
type: str
login_domain:
description:
- 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 C(MSO_LOGIN_DOMAIN)
will be used instead.
- When using a HTTPAPI connection plugin the inventory variable C(ansible_httpapi_login_domain)
will be used if this attribute is not specified.
type: str
output_level:
choices:
- debug
- info
- normal
default: normal
description:
- Influence the output of this MSO module.
- C(normal) means the standard output, incl. C(current) dict
- C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts
- C(debug) adds debugging output, incl. C(filter_string), C(method), C(response),
C(status) and C(url) information
- If the value is not specified in the task, the value of environment variable C(MSO_OUTPUT_LEVEL)
will be used instead.
type: str
validate_certs:
description:
- If C(false), SSL certificates will not be validated.
- This should only set to C(false) when used on personally controlled sites using
self-signed certificates.
- If the value is not specified in the task, the value of environment variable C(MSO_VALIDATE_CERTS)
will be used instead.
- The default is C(true).
type: bool
intra_epg_isolation:
choices:
- enforced
- unenforced
description:
- Whether intra EPG isolation is enforced.
- When not specified, this parameter defaults to C(unenforced).
type: str
intersite_multicaste_source:
description:
- Whether intersite multicast source is enabled.
- When not specified, this parameter defaults to C(no).
type: bool