cisco.mso.mso_schema_template_contract_filter module – Manage contract filters in schema templates
Note
This module is part of the cisco.mso collection (version 1.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
.
To use it in a playbook, specify: cisco.mso.mso_schema_template_contract_filter
.
Requirements
The below requirements are needed on the host that executes this module.
Multi Site Orchestrator v2.1 or newer
Parameters
Parameter |
Comments |
---|---|
The filter action parameter is supported on versions of MSO that are 3.3 or greater. Choices:
|
|
The name of the contract to manage. |
|
The name as displayed on the MSO web interface. This defaults to the contract name when unset on creation. |
|
The type of filters defined in this contract. This defaults to Choices:
|
|
The scope of the contract. This defaults to Choices:
|
|
The description of contract is supported on versions of MSO that are 3.3 or greater. |
|
The filter to associate with this contract. |
|
A list of filter directives. Choices:
|
|
The schema name in which the filter is located. |
|
The template name in which the filter is located. |
|
The type of filter to manage. Choices:
|
|
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 |
|
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 filter priority override parameter is supported on versions of MSO that are 3.3 or greater. Choices:
|
|
The Contract QoS Level parameter is supported on versions of MSO that are 3.3 or greater. |
|
The name of the schema. |
|
Use Use Choices:
|
|
The name of the template. |
|
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable Default: 30 |
|
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
Due to restrictions of the MSO REST API this module creates contracts when needed, and removes them when the last filter has been removed.
Due to restrictions of the MSO REST API concurrent modifications to contract filters can be dangerous and corrupt data.
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_template_filter_entry
The official documentation on the cisco.mso.mso_schema_template_filter_entry module.
Examples
- name: Add a new contract filter
cisco.mso.mso_schema_template_contract_filter:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
contract: Contract 1
contract_scope: global
filter: Filter 1
state: present
delegate_to: localhost
- name: Remove a contract filter
cisco.mso.mso_schema_template_contract_filter:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
contract: Contract 1
filter: Filter 1
state: absent
delegate_to: localhost
- name: Query a specific contract filter
cisco.mso.mso_schema_template_contract_filter:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
contract: Contract 1
filter: Filter 1
state: query
delegate_to: localhost
register: query_result
- name: Query all contract filters
cisco.mso.mso_schema_template_contract_filter:
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
Dag Wieers (@dagwieers)