Documentation

aci_filter - Manages top level filter objects on Cisco ACI fabrics (vz:Filter)

New in version 2.4.

Synopsis

Options

parameter required default choices comments
description
 no
Description for the filter.

aliases: descr
filter
 yes
The name of the filter.

aliases: filter_name, name
hostname
 yes
IP Address or hostname of APIC resolvable by Ansible control host.

aliases: host
password
 yes
The password to use for authentication.
state
 no present
  • absent
  • present
  • query
Use present or absent for adding or removing.
Use query for listing an object or multiple objects.
tenant
 yes
The name of the tenant.

aliases: tenant_name
timeout
 no 30
The socket level timeout in seconds.
use_proxy
 no yes
  • yes
  • no
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl
 no yes
  • yes
  • no
If no, an HTTP connection will be used instead of the default HTTPS connection.
username
 yes admin
The username to use for authentication.

aliases: user
validate_certs
 no yes
  • yes
  • no
If no, SSL certificates will not be validated.
This should only set to no used on personally controlled sites using self-signed certificates.

Examples

- name: Add a new filter to a tenant
  aci_filter:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    filter: web_filter
    description: Filter for web protocols
    tenant: production
    state: present

- name: Remove a filter for a tenant
  aci_filter:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    filter: web_filter
    tenant: production
    state: absent

- name: Query a filter of a tenant
  aci_filter:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    filter: web_filter
    tenant: production
    state: query

- name: Query all filters for a tenant
  aci_filter:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    state: query

Notes

Note

  • The tenant used must exist before using this module in your playbook. The aci_tenant module can be used for this.
  • By default, if an environment variable <protocol>_proxy is set on the target host, requests will be sent through that proxy. This behaviour can be overridden by setting a variable for this task (see setting the environment), or by using the use_proxy option.
  • HTTP redirects can redirect from HTTP to HTTPS so you should be sure that your proxy environment for both protocols is correct.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.