aci_filter – Manages top level filter objects (vz:Filter)¶
New in version 2.4.
Synopsis¶
Manages top level filter objects on Cisco ACI fabrics.
This modules does not manage filter entries, see aci_filter_entry for this functionality.
Parameters¶
Notes¶
Note
The
tenant
used must exist before using this module in your playbook. The aci_tenant module can be used for this.
See Also¶
See also
- aci_tenant – Manage tenants (fv:Tenant)
The official documentation on the aci_tenant module.
- APIC Management Information Model reference
More information about the internal APIC class vz:Filter.
- Cisco ACI Guide
Detailed information on how to manage your ACI infrastructure using Ansible.
- Developing Cisco ACI modules
Detailed guide on how to write your own Cisco ACI modules to contribute.
Examples¶
- name: Add a new filter to a tenant
aci_filter:
host: apic
username: admin
password: SomeSecretPassword
filter: web_filter
description: Filter for web protocols
tenant: production
state: present
delegate_to: localhost
- name: Remove a filter for a tenant
aci_filter:
host: apic
username: admin
password: SomeSecretPassword
filter: web_filter
tenant: production
state: absent
delegate_to: localhost
- name: Query a filter of a tenant
aci_filter:
host: apic
username: admin
password: SomeSecretPassword
filter: web_filter
tenant: production
state: query
delegate_to: localhost
register: query_result
- name: Query all filters for a tenant
aci_filter:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
state: query
delegate_to: localhost
register: query_result
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by an Ansible Partner. [certified]
Authors¶
Dag Wieers (@dagwieers)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.