cisco.mso.mso_schema_site_contract_service_graph module – Manage the service graph association with a contract in schema sites

Note

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

Synopsis

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

  • This module is only compatible with NDO versions 3.7 and 4.2+. NDO versions 4.0 and 4.1 are not supported.

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

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.

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

node_relationship

list / elements=dictionary

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

cluster_interface_device

aliases: cluster_device, device, device_name

string / required

The name of the cluster interface device.

consumer_connector_cluster_interface

aliases: consumer_cluster_interface, consumer_interface, consumer_interface_name

string / required

The name of the cluster interface for the consumer connector.

consumer_connector_redirect_policy

aliases: consumer_redirect_policy, consumer_policy

string

The name of the redirect policy for the consumer connector.

consumer_connector_redirect_policy_tenant

aliases: consumer_redirect_policy_tenant, consumer_tenant

string

The name of the tenant for the consumer connector redirect policy.

consumer_subnet_ips

list / elements=string

The list of subnet IPs for the consumer connector.

The subnet IPs option is only available for the load balancer devices.

provider_connector_cluster_interface

aliases: provider_cluster_interface, provider_interface, provider_interface_name

string / required

The name of the cluster interface for the provider connector.

provider_connector_redirect_policy

aliases: provider_redirect_policy, provider_policy

string

The name of the redirect policy for the provider connector.

provider_connector_redirect_policy_tenant

aliases: provider_redirect_policy_tenant, provider_tenant

string

The name of the tenant for the provider connector redirect policy.

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 name of the service graph to associate with the site contract.

service_graph_schema

string

The name of the schema in which the service graph is located.

service_graph_template

string

The name of the template in which the service graph is located.

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.

tenant

string

The name of the tenant.

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

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

Manage the service graph association with a contract in schema template.

Examples

- name: Associate a service graph with a site contract
  cisco.mso.mso_schema_site_contract_service_graph:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    schema: ansible_schema
    template: ansible_template1
    site: ansible_test
    contract: Contract1
    service_graph_schema: ansible_schema
    service_graph_template: ansible_template1
    service_graph: sg
    node_relationship:
      - cluster_interface_device: ansible_tenant_firewall1
        provider_connector_cluster_interface: clu_if1
        provider_connector_redirect_policy: redirect_policy1
        consumer_connector_cluster_interface: clu_if1
        consumer_connector_redirect_policy: redirect_policy1
      - cluster_interface_device: ansible_tenant_adc
        provider_connector_cluster_interface: clu_if3
        provider_connector_redirect_policy: redirect_policy1
        consumer_connector_cluster_interface: clu_if3
        consumer_connector_redirect_policy: redirect_policy1
        consumer_subnet_ips: ["1.1.1.1/24", "4.4.4.4/24"]
      - cluster_interface_device: ansible_tenant_other
        provider_connector_cluster_interface: clu_if4
        provider_connector_redirect_policy: redirect_policy1
        consumer_connector_cluster_interface: clu_if4
        consumer_connector_redirect_policy: redirect_policy1
    state: present

- name: Associate a service graph with a cloud site contract
  cisco.mso.mso_schema_site_contract_service_graph:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    schema: ansible_schema
    template: ansible_template1
    site: ansible_test
    contract: Contract1
    service_graph_schema: ansible_schema
    service_graph_template: ansible_template1
    service_graph: sg
    state: present

- name: Query a site contract service graph with contract name
  cisco.mso.mso_schema_site_contract_service_graph:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: ansible_schema
    template: ansible_template1
    contract: Contract1
    site: ansible_test
    state: query
  register: query_result

- name: Query all site contract service graphs associated with a site template
  cisco.mso.mso_schema_site_contract_service_graph:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: ansible_schema
    template: ansible_template1
    site: ansible_test
    state: query
  register: query_result

- name: Remove a site contract service graph with contract name
  cisco.mso.mso_schema_site_contract_service_graph:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: ansible_schema
    template: ansible_template1
    site: ansible_test
    contract: Contract1
    state: absent

Authors

  • Sabari Jaganathan (@sajagana)