ansible / ansible.builtin / v2.9.0 / module / mso_schema_template_contract_filter Manage contract filters in schema templates | "added in version" 2.8 of ansible.builtin" Authors: Dag Wieers (@dagwieers) preview | supported by communityansible.builtin.mso_schema_template_contract_filter (v2.9.0) — module
pip
Install with pip install ansible==2.9.0
Manage contract filters in schema templates on Cisco ACI Multi-Site.
- 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 contract_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
host: aliases: - hostname description: - 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 C(MSO_HOST) will be used instead. type: str port: description: - 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 C(MSO_PORT) will be used instead. type: int state: choices: - absent - present - query default: present description: - Use C(present) or C(absent) for adding or removing. - Use C(query) for listing an object or multiple objects. type: str filter: aliases: - name description: - The filter to associate with this contract. type: str schema: description: - The name of the schema. required: true type: str timeout: default: 30 description: - The socket level timeout in seconds. - If the value is not specified in the task, the value of environment variable C(MSO_TIMEOUT) will be used instead. type: int use_ssl: description: - If C(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 C(MSO_USE_SSL) will be used instead. - When using a HTTPAPI connection plugin the inventory variable C(ansible_httpapi_use_ssl) will be used if this attribute is not specified. - The default is C(no) when using a HTTPAPI connection plugin (mso or nd) and C(yes) when using the legacy connection method (only for mso). type: bool contract: description: - The name of the contract to manage. required: true type: str password: description: - The password to use for authentication. - If the value is not specified in the task, the value of environment variables C(MSO_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead. type: str template: description: - The name of the template. required: true type: str username: description: - The username to use for authentication. - If the value is not specified in the task, the value of environment variables C(MSO_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead. type: str use_proxy: description: - If C(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 C(MSO_USE_PROXY) will be used instead. - The default is C(yes). type: bool filter_type: aliases: - type choices: - both-way - consumer-to-provider - provider-to-consumer default: both-way description: - The type of filter to manage. type: str login_domain: description: - 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 C(MSO_LOGIN_DOMAIN) will be used instead. type: str output_level: choices: - debug - info - normal default: normal description: - Influence the output of this MSO module. - C(normal) means the standard output, incl. C(current) dict - C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts - C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information - If the value is not specified in the task, the value of environment variable C(MSO_OUTPUT_LEVEL) will be used instead. type: str filter_schema: description: - The schema name in which the filter is located. type: str contract_scope: choices: - application-profile - global - tenant - vrf description: - The scope of the contract. - This defaults to C(vrf) when unset on creation. type: str validate_certs: description: - If C(no), SSL certificates will not be validated. - This should only set to C(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 C(MSO_VALIDATE_CERTS) will be used instead. - The default is C(yes). type: bool filter_template: description: - The template name in which the filter is located. type: str filter_directives: choices: - log - none description: - A list of filter directives. type: list contract_filter_type: choices: - both-way - one-way description: - The type of filters defined in this contract. - This defaults to C(both-way) when unset on creation. type: str contract_display_name: description: - The name as displayed on the MSO web interface. - This defaults to the contract name when unset on creation. type: str