ansible.builtin.mso_schema_template_filter_entry (v2.9.13) — module

Install Ansible via pip

Install with pip install ansible==2.9.13

Description

Manage filter entries in schema templates on Cisco ACI Multi-Site.

Requirements

• Multi Site Orchestrator v2.1 or newer

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
host:
    aliases:
    - hostname
    description:
    - IP Address or hostname of the ACI Multi Site Orchestrator host.
    required: true
    type: str

port:
    description:
    - Port number to be used for the REST connection.
    - The default value depends on parameter `use_ssl`.
    type: int

entry:
    aliases:
    - name
    description:
    - The filter entry name to manage.
    type: str

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:
    description:
    - The name of the filter to manage.
    required: true
    type: str

schema:
    description:
    - The name of the schema.
    required: true
    type: str

timeout:
    default: 30
    description:
    - The socket level timeout in seconds.
    type: int

use_ssl:
    default: true
    description:
    - If C(no), an HTTP connection will be used instead of the default HTTPS connection.
    type: bool

arp_flag:
    choices:
    - reply
    - request
    - unspecified
    description:
    - The ARP flag to use for this filter entry.
    type: str

password:
    description:
    - The password to use for authentication.
    - This option is mutual exclusive with C(private_key). If C(private_key) is provided
      too, it will be used instead.
    required: true
    type: str

stateful:
    default: false
    description:
    - Whether this filter entry is stateful.
    type: bool

template:
    description:
    - The name of the template.
    required: true
    type: str

username:
    default: admin
    description:
    - The username to use for authentication.
    type: str

ethertype:
    choices:
    - arp
    - fcoe
    - ip
    - ipv4
    - ipv6
    - mac-security
    - mpls-unicast
    - trill
    - unspecified
    description:
    - The ethernet type to use for this filter entry.
    type: str

source_to:
    description:
    - The source port range to.
    type: str

use_proxy:
    default: true
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

description:
    aliases:
    - entry_description
    description:
    - The description of this filer entry.
    type: str

ip_protocol:
    choices:
    - eigrp
    - egp
    - icmp
    - icmpv6
    - igmp
    - igp
    - l2tp
    - ospfigp
    - pim
    - tcp
    - udp
    - unspecified
    description:
    - The IP protocol to use for this filter entry.
    type: str

source_from:
    description:
    - The source port range from.
    type: str

display_name:
    aliases:
    - entry_display_name
    description:
    - The name as displayed on the MSO web interface.
    type: str

login_domain:
    description:
    - The login domain name to use for authentication.
    - The default value is Local.
    type: str

output_level:
    choices:
    - debug
    - info
    - normal
    default: normal
    description:
    - Influence the output of this ACI 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
    type: str

destination_to:
    description:
    - The destination port range to.
    type: str

fragments_only:
    default: false
    description:
    - Whether this filter entry only matches fragments.
    type: bool

validate_certs:
    default: true
    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.
    type: bool

destination_from:
    description:
    - The destination port range from.
    type: str

tcp_session_rules:
    choices:
    - acknowledgement
    - established
    - finish
    - synchronize
    - reset
    - unspecified
    description:
    - A list of TCP session rules.
    type: list

filter_display_name:
    description:
    - The name as displayed on the MSO web interface.
    type: str

See also

• mso_schema_template_contract_filter