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 2.0.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.

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

Comments

action

string

The filter action parameter is supported on versions of MSO that are 3.3 or greater.

Choices:

  • permit

  • deny

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.

Choices:

  • both-way ← (default)

  • one-way

contract_scope

string

The scope of the contract.

This defaults to vrf when unset on creation.

Choices:

  • application-profile

  • global

  • tenant

  • vrf

description

string

The description of contract is supported on versions of MSO that are 3.3 or greater.

filter

aliases: name

string

The filter to associate with this contract.

filter_directives

list / elements=string

A list of filter directives.

Choices:

  • log

  • none

  • policy_compression

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

aliases: type

string

The type of filter to manage.

Choices:

  • both-way ← (default)

  • consumer-to-provider

  • provider-to-consumer

host

aliases: hostname

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.

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 dict

info adds informational output, incl. previous, proposed and sent dicts

debug adds debugging output, incl. filter_string, method, response, status and url information

If the value is not specified in the task, the value of environment variable MSO_OUTPUT_LEVEL will be used instead.

Choices:

  • debug

  • info

  • normal ← (default)

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.

priority

string

The filter priority override parameter is supported on versions of MSO that are 3.3 or greater.

Choices:

  • default

  • lowest_priority

  • medium_priority

  • highest_priority

qos_level

string

The Contract QoS Level parameter is supported on versions of MSO that are 3.3 or greater.

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.

Choices:

  • absent

  • present ← (default)

  • query

template

string / required

The name of the template.

timeout

integer

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.

Default: 30

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.

The default is yes.

Choices:

  • no

  • yes

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.

The default is yes.

Choices:

  • no

  • yes

username

string

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.

The default is yes.

Choices:

  • no

  • yes

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)