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 |
---|---|
The name of the contract. |
|
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 |
|
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 When using a HTTPAPI connection plugin the inventory variable |
|
A list of nodes and their connector details associated with the Service Graph. |
|
The name of the cluster interface device. |
|
The name of the cluster interface for the consumer connector. |
|
The name of the redirect policy for the consumer connector. |
|
The name of the tenant for the consumer connector redirect policy. |
|
The list of subnet IPs for the consumer connector. The subnet IPs option is only available for the load balancer devices. |
|
The name of the cluster interface for the provider connector. |
|
The name of the redirect policy for the provider connector. |
|
The name of the tenant for the provider connector redirect policy. |
|
Influence the output of this MSO module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
The password to use for authentication. If the value is not specified in the task, the value of environment variables |
|
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 |
|
The name of the schema. |
|
The name of the service graph to associate with the site contract. |
|
The name of the schema in which the service graph is located. |
|
The name of the template in which the service graph is located. |
|
The name of the site. |
|
Use Use Choices:
|
|
The name of the template. |
|
The name of the tenant. |
|
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 |
|
If If the value is not specified in the task, the value of environment variable The default is Choices:
|
|
If If the value is not specified in the task, the value of environment variable When using a HTTPAPI connection plugin the inventory variable The default is Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default is Choices:
|
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