aci_filter_entry – Manage filter entries (vz:Entry)
aci_filter_entry – Manage filter entries (vz:Entry)
New in version 2.4.
Synopsis
- Manage filter entries for a filter on Cisco ACI fabrics.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
arp_flag - |
|
The arp flag to use when the ether_type is arp. The APIC defaults to |
certificate_name - |
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. It defaults to the
| |
description - |
Description for the Filter Entry.
| |
dst_port - |
Used to set both destination start and end ports to the same value when ip_protocol is tcp or udp. Accepted values are any valid TCP/UDP port range. The APIC defaults to | |
dst_port_end - |
Used to set the destination end port when ip_protocol is tcp or udp. Accepted values are any valid TCP/UDP port range. The APIC defaults to | |
dst_port_start - |
Used to set the destination start port when ip_protocol is tcp or udp. Accepted values are any valid TCP/UDP port range. The APIC defaults to | |
entry - |
Then name of the Filter Entry.
| |
ether_type - |
|
The Ethernet type. The APIC defaults to |
filter - |
The name of Filter that the entry should belong to.
| |
host - / required |
IP Address or hostname of APIC resolvable by Ansible control host.
| |
icmp6_msg_type - |
|
ICMPv6 message type; used when ip_protocol is icmpv6. The APIC defaults to |
icmp_msg_type - |
|
ICMPv4 message type; used when ip_protocol is icmp. The APIC defaults to |
ip_protocol - |
|
The IP Protocol type when ether_type is ip. The APIC defaults to |
output_level - |
|
Influence the output of this ACI module.
|
password - / required |
The password to use for authentication. This option is mutual exclusive with | |
port - |
Port number to be used for REST connection. The default value depends on parameter `use_ssl`. | |
private_key - / required |
PEM formatted file that contains your private key to be used for signature-based authentication. The name of the key (without extension) is used as the certificate name in ACI, unless This option is mutual exclusive with
| |
state - |
|
present, absent, query |
stateful boolean |
|
Determines the statefulness of the filter entry. |
tenant - |
The name of the tenant.
| |
timeout integer |
Default: 30 |
The socket level timeout in seconds. |
use_proxy boolean |
|
If |
use_ssl boolean |
|
If |
username - |
Default: "admin" |
The username to use for authentication.
|
validate_certs boolean |
|
If This should only set to |
Notes
Note
- The
tenant
andfilter
used must exist before using this module in your playbook. The aci_tenant and aci_filter modules can be used for this. - More information about the internal APIC class vz:Entry from the APIC Management Information Model reference.
See Also
See also
- 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
- aci_filter_entry:
host: "{{ inventory_hostname }}"
username: "{{ user }}"
password: "{{ pass }}"
state: "{{ state }}"
entry: "{{ entry }}"
tenant: "{{ tenant }}"
ether_name: "{{ ether_name }}"
icmp_msg_type: "{{ icmp_msg_type }}"
filter: "{{ filter }}"
descr: "{{ descr }}"
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
current list |
success |
The existing configuration from the APIC after the module has finished
Sample: [{'fvTenant': {'attributes': {'descr': 'Production environment', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': , 'ownerKey': , 'ownerTag': }}}] |
error dictionary |
failure |
The error information as returned from the APIC
Sample: {'code': '122', 'text': 'unknown managed object class foo'} |
filter_string string |
failure or debug |
The filter string used for the request
Sample: ?rsp-prop-include=config-only |
method string |
failure or debug |
The HTTP method used for the request to the APIC
Sample: POST |
previous list |
info |
The original configuration from the APIC before the module has started
Sample: [{'fvTenant': {'attributes': {'descr': 'Production', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': , 'ownerKey': , 'ownerTag': }}}] |
proposed dictionary |
info |
The assembled configuration from the user-provided parameters
Sample: {'fvTenant': {'attributes': {'descr': 'Production environment', 'name': 'production'}}} |
raw string |
parse error |
The raw output returned by the APIC REST API (xml or json)
Sample:
|
response string |
failure or debug |
The HTTP response from the APIC
Sample: OK (30 bytes) |
sent list |
info |
The actual/minimal configuration pushed to the APIC
Sample: {'fvTenant': {'attributes': {'descr': 'Production environment'}}} |
status integer |
failure or debug |
The HTTP status from the APIC
Sample: 200 |
url string |
failure or debug |
The HTTP url used for the request to the APIC
Sample: |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Jacob McGill (@jmcgill298)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/aci_filter_entry_module.html