cisco.mso.mso_schema_template_anp_epg_intra_epg_contract module – Manage Intra-EPG Contract on Cisco Nexus Dashboard Orchestrator (NDO).

Note

This module is part of the cisco.mso collection (version 2.11.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_intra_epg_contract.

Synopsis

  • Manage Intra-EPG Contract on Cisco Nexus Dashboard Orchestrator (NDO).

Requirements

The below requirements are needed on the host that executes this module.

  • Multi Site Orchestrator v2.1 or newer

Parameters

Parameter

Comments

anp

aliases: application_profile

string / required

The name of the Application Profile.

contract

dictionary

A contract associated to this Intra-EPG Contract.

name

aliases: contract_name

string / required

The name of the Contract to associate with.

schema

aliases: contract_schema

string

The schema that defines the referenced Contract.

If this parameter is unspecified, it defaults to the current schema.

template

aliases: contract_template

string

The template that defines the referenced Contract.

If this parameter is unspecified, it defaults to the current template.

epg

aliases: endpoint_group

string / required

The name of the Endpoint Group.

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.

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.

When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_login_domain will be used if this attribute is not specified.

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.

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.

schema

string / required

The name of the Schema.

state

string

Use absent for removing.

Use query for listing an object or multiple objects.

Use present for creating or updating.

Choices:

  • "absent"

  • "query" ← (default)

  • "present"

template

string / required

The name of the Template.

timeout

integer

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

use_proxy

boolean

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

The default is true.

Choices:

  • false

  • true

use_ssl

boolean

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

When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_use_ssl will be used if this attribute is not specified.

The default is false when using a HTTPAPI connection plugin (mso or nd) and true when using the legacy connection method (only for mso).

Choices:

  • false

  • true

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.

validate_certs

boolean

If false, SSL certificates will not be validated.

This should only set to 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 MSO_VALIDATE_CERTS will be used instead.

The default is true.

Choices:

  • false

  • true

Notes

Note

See Also

See also

cisco.mso.mso_schema

Manage schemas.

cisco.mso.mso_schema_template

Manage templates in schemas.

cisco.mso.mso_schema_template_anp

Manage Application Network Profiles (ANPs) in schema templates.

cisco.mso.mso_schema_template_anp_epg

Manage Endpoint Groups (EPGs) in schema templates.

cisco.mso.mso_schema_template_contract_filter

Manage contract filters in schema templates.

Examples

- name: Bind an schema template contract with EPG Intra-EPG Contracts
  cisco.mso.mso_schema_template_anp_epg_intra_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: ansible_schema
    template: ansible_template
    anp: ansible_anp
    epg: ansible_epg
    contract:
      schema: ansible_contract_schema
      template: ansible_contract_template
      name: ansible_contract_name
    state: present

- name: Query an Intra-EPG Contract with contract details
  cisco.mso.mso_schema_template_anp_epg_intra_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: ansible_schema
    template: ansible_template
    anp: ansible_anp
    epg: ansible_epg
    contract:
      schema: ansible_contract_schema
      template: ansible_contract_template
      name: ansible_contract_name
    state: query
  register: query_with_contract_details

- name: Query an Intra-EPG Contract with only contract name
  cisco.mso.mso_schema_template_anp_epg_intra_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: ansible_schema
    template: ansible_template
    anp: ansible_anp
    epg: ansible_epg
    contract:
      name: ansible_contract_name
    state: query
  register: query_with_contract_name

- name: Query all Intra-EPG Contracts
  cisco.mso.mso_schema_template_anp_epg_intra_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: ansible_schema
    template: ansible_template
    anp: ansible_anp
    epg: ansible_epg
    state: query
  register: query_all

- name: Remove an Intra-EPG Contract with contract details
  cisco.mso.mso_schema_template_anp_epg_intra_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: ansible_schema
    template: ansible_template
    anp: ansible_anp
    epg: ansible_epg
    contract:
      schema: ansible_contract_schema
      template: ansible_contract_template
      name: ansible_contract_name
    state: absent

- name: Remove an Intra-EPG Contract with only contract name
  cisco.mso.mso_schema_template_anp_epg_intra_epg_contract:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: ansible_schema
    template: ansible_template
    anp: ansible_anp
    epg: ansible_epg
    contract:
      name: ansible_contract_name
    state: absent

Authors

  • Sabari Jaganathan (@sajagana)