New in version 2.4.
Parameter | Choices/Defaults | Comments |
---|---|---|
arp_flag |
|
The arp flag to use when the ether_type is arp.
The APIC defaults new Filter Entries to
unspecified . |
certificate_name |
Default: C(private_key) basename
|
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.
It defaults to the
private_key basename, without extension.aliases: cert_name |
description |
Description for the Filter Entry.
aliases: descr |
|
dst_port |
unspecified
|
Used to set both destination start and end ports to the same value when ip_protocol is tcp or udp.
The APIC defaults new Filter Entries to
unspecified . |
dst_port_end |
unspecified
|
Used to set the destination end port when ip_protocol is tcp or udp.
The APIC defaults new Filter Entries to
unspecified . |
dst_port_start |
unspecified
|
Used to set the destination start port when ip_protocol is tcp or udp.
The APIC defaults new Filter Entries to
unspecified . |
entry |
Then name of the Filter Entry.
aliases: entry_name, filter_entry, name |
|
ether_type |
|
The Ethernet type.
The APIC defaults new Filter Entries to
unspecified . |
filter |
The name of Filter that the entry should belong to.
aliases: filter_name |
|
host
required |
IP Address or hostname of APIC resolvable by Ansible control host.
aliases: hostname |
|
icmp6_msg_type |
|
ICMPv6 message type; used when ip_protocol is icmpv6.
The APIC defaults new Filter Entries to
unspecified . |
icmp_msg_type |
|
ICMPv4 message type; used when ip_protocol is icmp.
The APIC defaults new Filter Entries to
unspecified . |
ip_protocol |
|
The IP Protocol type when ether_type is ip.
The APIC defaults new Filter Entries to
unspecified . |
output_level |
|
Influence the output of this ACI module.
normal means the standard output, incl. current dictinfo means informational output, incl. previous , proposed and sent dictsdebug means debugging output, incl. filter_string , method , response , status and url information |
password
required |
The password to use for authentication.
|
|
port |
Default: 443 (for https) and 80 (for http)
|
Port number to be used for REST connection.
|
private_key |
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
certificate_name is specified.aliases: cert_key |
|
state |
|
present, absent, query
|
stateful |
Determines the statefulness of the filter entry.
|
|
tenant |
The name of the tenant.
aliases: tenant_name |
|
timeout |
Default: 30
|
The socket level timeout in seconds.
|
use_proxy |
|
If
no , it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
use_ssl |
|
If
no , an HTTP connection will be used instead of the default HTTPS connection. |
username
required |
Default: admin
|
The username to use for authentication.
aliases: user |
validate_certs |
|
If
no , SSL certificates will not be validated.This should only set to
no used on personally controlled sites using self-signed certificates. |
Note
tenant
and filter
used must exist before using this module in your playbook. The aci_tenant and aci_filter modules can be used for this.<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.- 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 }}"
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
dict
|
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
dict
|
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:
<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>
|
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
int
|
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:
https://10.11.12.13/api/mo/uni/tn-production.json
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.