Note
This plugin is part of the cisco.mso collection (version 1.2.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
.
The below requirements are needed on the host that executes this module.
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 / elements=string |
| 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 | 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.aliases: hostname | |
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 dictinfo adds informational output, incl. previous , proposed and sent dictsdebug adds debugging output, incl. filter_string , method , response , status and url informationIf the value is not specified in the task, the value of environment variable MSO_OUTPUT_LEVEL will be used instead. |
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. | |
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. If the value is not specified in the task, the value of environment variable MSO_TIMEOUT will be used instead. |
use_proxy boolean |
| If no , 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. |
use_ssl boolean |
| If no , 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. |
username string | Default: "admin" | 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 no , SSL certificates will not be validated.This should only set to no 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. |
Note
See also
The official documentation on the cisco.mso.mso_schema_template_filter_entry module.
- 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
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/mso/mso_schema_template_contract_filter_module.html