cisco.mso.mso_schema_template_filter_entry – Manage filter entries in schema templates

Note

This plugin is part of the cisco.mso collection (version 1.2.0).

To install it use: ansible-galaxy collection install cisco.mso.

To use it in a playbook, specify: cisco.mso.mso_schema_template_filter_entry.

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.
There should be no space in the filter name. APIC will throw an error if a space is provided in the filter name.
See the filter_display_name attribute if you want the display name of the filter to contain a space.
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
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
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.
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
    Choices:
  • debug
  • info
  • normal ←
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.
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.
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 / elements=string
    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.
If the value is not specified in the task, the value of environment variable MSO_TIMEOUT will be used instead.
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.
If the value is not specified in the task, the value of environment variable MSO_USE_PROXY will be used instead.
use_ssl
boolean
    Choices:
  • no
  • yes ←
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
    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.
If the value is not specified in the task, the value of environment variable MSO_VALIDATE_CERTS will be used instead.

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 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_contract_filter

The official documentation on the cisco.mso.mso_schema_template_contract_filter module.

Examples

- name: Add a new filter entry
  cisco.mso.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
  cisco.mso.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
  cisco.mso.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
  cisco.mso.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

Authors

  • Dag Wieers (@dagwieers)