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

Note

This plugin is part of the cisco.mso collection (version 1.2.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.

To use it in a playbook, specify: cisco.mso.mso_schema_site_anp_epg_staticport.

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

Comments

anp

string / required

The name of the ANP.

deployment_immediacy

string

The deployment immediacy of the static port.

immediate means Deploy immediate.

lazy means deploy on demand.

Choices:

  • immediate

  • lazy ← (default)

epg

string / required

The name of the EPG.

fex

string

The fex id of the static port.

host

aliases: hostname

string

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 MSO_HOST will be used instead.

leaf

string

The leaf of the static port.

login_domain

string

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 MSO_LOGIN_DOMAIN will be used instead.

mode

string

The mode of the static port.

native means Access (802.1p).

regular means Trunk.

untagged means Access (untagged).

Choices:

  • native

  • regular

  • untagged ← (default)

output_level

string

Influence the output of this MSO 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

If the value is not specified in the task, the value of environment variable MSO_OUTPUT_LEVEL will be used instead.

Choices:

  • debug

  • info

  • normal ← (default)

password

string

The password to use for authentication.

If the value is not specified in the task, the value of environment variables MSO_PASSWORD or ANSIBLE_NET_PASSWORD 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.

If the value is not specified in the task, the value of environment variable MSO_PORT will be used instead.

primary_micro_segment_vlan

integer

Primary micro-seg VLAN of static port.

schema

string / required

The name of the schema.

site

string / required

The name of the site.

state

string

Use present or absent for adding or removing.

Use query for listing an object or multiple objects.

Choices:

  • absent

  • present ← (default)

  • query

template

string / required

The name of the template.

timeout

integer

The socket level timeout in seconds.

If the value is not specified in the task, the value of environment variable MSO_TIMEOUT will be used instead.

Default: 30

type

string

The path type of the static port

vpc is used for a Virtual Port Channel

dpc is used for a Direct Port Channel

port is used for a single interface

Choices:

  • port ← (default)

  • vpc

  • dpc

use_proxy

boolean

If no, 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 MSO_USE_PROXY will be used instead.

Choices:

  • no

  • yes ← (default)

use_ssl

boolean

If no, 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 MSO_USE_SSL will be used instead.

Choices:

  • no

  • yes ← (default)

username

string

The username to use for authentication.

If the value is not specified in the task, the value of environment variables MSO_USERNAME or ANSIBLE_NET_USERNAME will be used instead.

Default: “admin”

validate_certs

boolean

If no, SSL certificates will not be validated.

This should only set to no when used on personally controlled sites using self-signed certificates.

If the value is not specified in the task, the value of environment variable MSO_VALIDATE_CERTS will be used instead.

Choices:

  • no

  • yes ← (default)

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 an object as the wrong object may be referenced. This module is affected by this deficiency.

  • Please read the mso_guide for more detailed information on how to manage your MSO infrastructure using Ansible.

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

See Also

See also

cisco.mso.mso_schema_site_anp_epg

The official documentation on the cisco.mso.mso_schema_site_anp_epg module.

cisco.mso.mso_schema_template_anp_epg

The official documentation on the cisco.mso.mso_schema_template_anp_epg module.

Examples

- name: Add a new static port to a site EPG
  cisco.mso.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: Add a new static fex 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
    fex: 151
    path: eth1/1
    vlan: 126
    deployment_immediacy: lazy
    state: present
  delegate_to: localhost

- name: Add a new static VPC 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
    pod: pod-1
    leaf: 101-102
    path: ansible_polgrp
    vlan: 127
    type: vpc
    mode: untagged
    deployment_immediacy: lazy
    state: present
  delegate_to: localhost

- name: Remove a static port from a site EPG
  cisco.mso.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
  cisco.mso.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
  cisco.mso.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

Authors

  • Dag Wieers (@dagwieers)