mso_schema_template_contract_filter – Manage contract filters in schema templates¶
New in version 2.8.
Synopsis¶
Manage contract filters in schema templates on Cisco ACI Multi-Site.
Requirements¶
The below requirements are needed on the host that executes this module.
Multi Site Orchestrator v2.1 or newer
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
contract
string
/ required
|
The name of the contract to manage.
|
|
contract_display_name
string
|
The name as displayed on the MSO web interface.
This defaults to the contract name when unset on creation.
|
|
contract_filter_type
string
|
|
The type of filters defined in this contract.
This defaults to
both-way when unset on creation. |
contract_scope
string
|
|
The scope of the contract.
This defaults to
vrf when unset on creation. |
filter
string
|
The filter to associate with this contract.
aliases: name |
|
filter_directives
list
|
|
A list of filter directives.
|
filter_schema
string
|
The schema name in which the filter is located.
|
|
filter_template
string
|
The template name in which the filter is located.
|
|
filter_type
string
|
|
The type of filter to manage.
aliases: type |
host
string
/ required
|
IP Address or hostname of the ACI Multi Site Orchestrator host.
aliases: hostname |
|
output_level
string
|
|
Influence the output of this ACI module.
normal means the standard output, incl. current dictinfo adds informational output, incl. previous , proposed and sent dictsdebug adds debugging output, incl. filter_string , method , response , status and url information |
password
string
/ required
|
The password to use for authentication.
This option is mutual exclusive with
private_key . If private_key is provided too, it will be used instead. |
|
port
integer
|
Port number to be used for the REST connection.
The default value depends on parameter `use_ssl`.
|
|
schema
string
/ required
|
The name of the schema.
|
|
state
string
|
|
Use
present or absent for adding or removing.Use
query for listing an object or multiple objects. |
template
string
/ required
|
The name of the template.
|
|
timeout
integer
|
Default: 30
|
The socket level timeout in seconds.
|
use_proxy
boolean
|
|
If
no , it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
use_ssl
boolean
|
|
If
no , an HTTP connection will be used instead of the default HTTPS connection. |
username
string
|
Default: "admin"
|
The username to use for authentication.
|
validate_certs
boolean
|
|
If
no , SSL certificates will not be validated.This should only set to
no when used on personally controlled sites using self-signed certificates. |
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 Cisco ACI Guide for more detailed information on how to manage your ACI infrastructure using Ansible.
This module was written to support ACI Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.
See Also¶
See also
- mso_schema_template_filter_entry – Manage filter entries in schema templates
The official documentation on the mso_schema_template_filter_entry module.
Examples¶
- name: Add a new contract filter
mso_schema_template_contract_filter:
host: mso_host
username: admin
password: SomeSecretPassword
schema: Schema 1
template: Template 1
contract: Contract 1
scope: global
filter: Filter 1
state: present
delegate_to: localhost
- name: Remove a contract filter
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
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
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
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]