mso_schema_site_anp_epg_staticport – Manage site-local EPG static ports in schema template

New in version 2.8.

Synopsis

  • Manage site-local EPG static ports in schema template 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 Choices/Defaults Comments
anp
string
The name of the ANP.
deployment_immediacy
string
    Choices:
  • immediate
  • lazy
The deployment immediacy of the static port.
immediate means Deploy immediate.
lazy means deploy on demand.
epg
string
The name of the EPG.
host
string / required
IP Address or hostname of the ACI Multi Site Orchestrator host.

aliases: hostname
leaf
string
The leaf of the static port.
mode
string
    Choices:
  • native
  • regular
  • untagged
The mode of the static port.
native means Access (802.1p).
regular means Trunk.
untagged means Access (untagged).
output_level
string
    Choices:
  • debug
  • info
  • normal ←
Influence the output of this ACI module.
normal means the standard output, incl. current dict
info adds informational output, incl. previous, proposed and sent dicts
debug adds debugging output, incl. filter_string, method, response, status and url information
password
string / required
The password to use for authentication.
This option is mutual exclusive with private_key. If private_key is provided too, it will be used instead.
path
string
The path of the static port.
pod
string
The pod of the static port.
port
integer
Port number to be used for the REST connection.
The default value depends on parameter `use_ssl`.
schema
string / required
The name of the schema.
site
string / required
The name of the site.
state
string
    Choices:
  • absent
  • present ←
  • query
Use present or absent for adding or removing.
Use query for listing an object or multiple objects.
template
string / required
The name of the template.
timeout
integer
Default:
30
The socket level timeout in seconds.
type
string
    Choices:
  • port ←
The path type of the static port
use_proxy
boolean
    Choices:
  • no
  • yes ←
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl
boolean
    Choices:
  • no
  • yes ←
If no, an HTTP connection will be used instead of the default HTTPS connection.
username
string
Default:
"admin"
The username to use for authentication.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated.
This should only set to no when used on personally controlled sites using self-signed certificates.
vlan
integer
The port encap VLAN id of the static port.

Notes

Note

  • The ACI MultiSite PATCH API has a deficiency requiring some objects to be referenced by index. This can cause silent corruption on concurrent access when changing/removing on object as the wrong object may be referenced. This module is affected by this deficiency.

  • Please read the Cisco ACI Guide for more detailed information on how to manage your ACI infrastructure using Ansible.

  • This module was written to support ACI Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.

See Also

See also

mso_schema_site_anp_epg – Manage site-local Endpoint Groups (EPGs) in schema template

The official documentation on the mso_schema_site_anp_epg module.

mso_schema_template_anp_epg – Manage Endpoint Groups (EPGs) in schema templates

The official documentation on the mso_schema_template_anp_epg module.

Examples

- name: Add a new static port to a site EPG
  mso_schema_site_anp_epg_staticport:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    anp: ANP1
    epg: EPG1
    type: port
    pod: pod-1
    leaf: 101
    path: eth1/1
    vlan: 126
    deployment_immediacy: immediate
    state: present
  delegate_to: localhost

- name: Remove a static port from a site EPG
  mso_schema_site_anp_epg_staticport:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    anp: ANP1
    epg: EPG1
    type: port
    pod: pod-1
    leaf: 101
    path: eth1/1
    state: absent
  delegate_to: localhost

- name: Query a specific site EPG static port
  mso_schema_site_anp_epg_staticport:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    anp: ANP1
    epg: EPG1
    type: port
    pod: pod-1
    leaf: 101
    path: eth1/1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all site EPG static ports
  mso_schema_site_anp_epg_staticport:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    site: Site1
    template: Template1
    anp: ANP1
    state: query
  delegate_to: localhost
  register: query_result

Status

Authors

  • Dag Wieers (@dagwieers)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.