cisco.mso.mso_schema_template_contract_service_graph module – Manage the service graph association with a contract in schema template

Note

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

Synopsis

  • Manage the service graph association with a contract in schema template on Cisco ACI Multi-Site.

  • The Contract Service Graph parameter is supported on versions of MSO/NDO that are 3.3 or greater.

Requirements

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

  • Multi Site Orchestrator v2.1 or newer

Parameters

Parameter

Comments

contract

string / required

The name of the contract.

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.

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.

service_graph

string

The service graph to associate with this contract.

service_graph_schema

string

The schema name in which the service graph is located.

service_graph_template

string

The template name in which the service graph is located.

service_nodes

list / elements=dictionary

A list of nodes and their connector details associated with the Service Graph.

The order of the list matches the node id ordering in GUI, so first entry in list will be match node 1.

connector_object_type

string

The connector ACI object type of the node.

Choices:

  • "bd" ← (default)

consumer

string / required

The name of the Bridge Domain.

consumer_schema

string

The schema name in which the consumer is located.

consumer_template

string

The template name in which the consumer is located.

provider

string / required

The name of the Bridge Domain.

provider_schema

string

The schema name in which the provider is located.

provider_template

string

The template name in which the provider is located.

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

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

  • 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_template_contract_filter

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

Examples

- name: Add a new contract service graph
  cisco.mso.mso_schema_template_contract_service_graph:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    contract: Contract 1
    service_graph: SG1
    service_graph_nodes:
      - provider: b1
        consumer: b2
    filter: Filter 1
    state: present
  delegate_to: localhost

- name: Remove a contract service graph
  cisco.mso.mso_schema_template_contract_service_graph:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    contract: Contract 1
    service_graph: SG1
    state: absent
  delegate_to: localhost

- name: Query a contract service graph
  cisco.mso.mso_schema_template_contract_service_graph:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema 1
    template: Template 1
    contract: Contract 1
    state: query
  delegate_to: localhost
  register: query_result

Authors

  • Akini Ross (@akinross)