- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# mso_schema_template_filter_entry – Manage filter entries in schema templates

New in version 2.8.

- Synopsis

- Requirements

- Parameters

- Notes

- See Also

- Examples

- Status

## Synopsis

- Manage filter entries 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
--- | --- | ---
arp_flag string | Choices: reply request unspecified | The ARP flag to use for this filter entry.
description string |  | The description of this filer entry. aliases: entry_description
destination_from string |  | The destination port range from.
destination_to string |  | The destination port range to.
display_name string |  | The name as displayed on the MSO web interface. aliases: entry_display_name
entry string |  | The filter entry name to manage. aliases: name
ethertype string | Choices: arp fcoe ip ipv4 ipv6 mac-security mpls-unicast trill unspecified | The ethernet type to use for this filter entry.
filter string / required |  | The name of the filter to manage.
filter_display_name string |  | The name as displayed on the MSO web interface.
fragments_only boolean | Choices: no ← yes | Whether this filter entry only matches fragments.
host string / required |  | IP Address or hostname of the ACI Multi Site Orchestrator host. aliases: hostname
ip_protocol string | Choices: eigrp egp icmp icmpv6 igmp igp l2tp ospfigp pim tcp udp unspecified | The IP protocol to use for this filter entry.
output_level string | Choices: debug info normal ← | Influence the output of this ACI 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
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.
source_from string |  | The source port range from.
source_to string |  | The source port range to.
state string | Choices: absent present ← query | Use `present` or `absent` for adding or removing. Use `query` for listing an object or multiple objects.
stateful boolean | Choices: no ← yes | Whether this filter entry is stateful.
tcp_session_rules list | Choices: acknowledgement established finish synchronize reset unspecified | A list of TCP session rules.
template string / required |  | The name of the template.
timeout integer | Default: 30 | The socket level timeout in seconds.
use_proxy boolean | Choices: no yes ← | If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl boolean | Choices: no yes ← | 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 | Choices: no yes ← | 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 filters when needed, and removes them when the last entry has been removed.

- 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_contract_filter – Manage contract filters in schema templates

  The official documentation on the mso_schema_template_contract_filter module.

## Examples

    - name: Add a new filter entry
      mso_schema_template_filter_entry:
        host: mso_host
        username: admin
        password: SomeSecretPassword
        schema: Schema 1
        template: Template 1
        filter: Filter 1
        state: present
      delegate_to: localhost

    - name: Remove a filter entry
      mso_schema_template_filter_entry:
        host: mso_host
        username: admin
        password: SomeSecretPassword
        schema: Schema 1
        template: Template 1
        filter: Filter 1
        state: absent
      delegate_to: localhost

    - name: Query a specific filter entry
      mso_schema_template_filter_entry:
        host: mso_host
        username: admin
        password: SomeSecretPassword
        schema: Schema 1
        template: Template 1
        filter: Filter 1
        state: query
      delegate_to: localhost
      register: query_result

    - name: Query all filter entries
      mso_schema_template_filter_entry:
        host: mso_host
        username: admin
        password: SomeSecretPassword
        schema: Schema 1
        template: Template 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]

### Authors

- Dag Wieers (@dagwieers)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.