aci_filter_entry
Manage filter entries (vz:Entry)
Collection: cisco.aci
Full Name: cisco.aci.aci_filter_entry
Synopsis
Manage filter entries (vz:Entry)
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| annotation | string | orchestrator:ansible | User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable C(ACI_ANNOTATION) will be used instead. If the value is not specified in the task and environment variable C(ACI_ANNOTATION) then the default value will be used. | |
| arp_flag | string | The arp flag to use when the ether_type is arp. The APIC defaults to C(unspecified) when unset during creation. | ||
| certificate_name | string | The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a C(private_key) filename was provided, this defaults to the C(private_key) basename, without extension. If PEM-formatted content was provided for C(private_key), this defaults to the C(username) value. If the value is not specified in the task, the value of environment variable C(ACI_CERTIFICATE_NAME) will be used instead. | ||
| description | string | Description for the Filter Entry. | ||
| destination_port | string | 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 C(unspecified) when unset during creation. | ||
| destination_port_end | string | 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 C(unspecified) when unset during creation. | ||
| destination_port_start | string | 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 C(unspecified) when unset during creation. | ||
| entry | string | Then name of the Filter Entry. | ||
| ether_type | string | The Ethernet type. The APIC defaults to C(unspecified) when unset during creation. | ||
| filter | string | The name of Filter that the entry should belong to. | ||
| host | string | IP Address or hostname of APIC resolvable by Ansible control host. If the value is not specified in the task, the value of environment variable C(ACI_HOST) will be used instead. | ||
| icmp6_msg_type | string | ICMPv6 message type; used when ip_protocol is icmpv6. The APIC defaults to C(unspecified) when unset during creation. | ||
| icmp_msg_type | string | ICMPv4 message type; used when ip_protocol is icmp. The APIC defaults to C(unspecified) when unset during creation. | ||
| ip_protocol | string | The IP Protocol type when ether_type is ip. The APIC defaults to C(unspecified) when unset during creation. | ||
| match_only_fragments | bool | The match only packet fragments of the filter entry. When enabled C(true) the rule applies to any fragments with offset greater than 0 (all fragments except first). When disabled C(false) it applies to all packets (including all fragments) The APIC defaults to C(false) when unset during creation. | ||
| name_alias | string | The alias for the current object. This relates to the nameAlias field in ACI. | ||
| output_level | string | normal | 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 If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_LEVEL) will be used instead. | |
| output_path | string | Path to a file that will be used to dump the ACI JSON configuration objects generated by the module. If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_PATH) will be used instead. | ||
| password | string | 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. If the value is not specified in the task, the value of environment variables C(ACI_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead. | ||
| port | int | Port number to be used for REST connection. The default value depends on parameter C(use_ssl). If the value is not specified in the task, the value of environment variable C(ACI_PORT) will be used instead. | ||
| private_key | string | Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default C(certificate_name) that is used. This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable C(ACI_PRIVATE_KEY) or C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. | ||
| source_port | string | Used to set both source 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 C(unspecified) when unset during creation. | ||
| source_port_end | string | Used to set the source end port when ip_protocol is tcp or udp. Accepted values are any valid TCP/UDP port range. The APIC defaults to C(unspecified) when unset during creation. | ||
| source_port_start | string | Used to set the source start port when ip_protocol is tcp or udp. Accepted values are any valid TCP/UDP port range. The APIC defaults to C(unspecified) when unset during creation. | ||
| state | string | present | present, absent, query | |
| stateful | bool | Determines the statefulness of the filter entry. | ||
| suppress_previous | bool | If C(true), a GET to check previous will not be sent before a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_PREVIOUS) will be used instead. The default value is C(false). WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. | ||
| suppress_verification | bool | If C(true), a verifying GET will not be sent after a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_VERIFICATION) will be used instead. The default value is C(false). WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. | ||
| tcp_flags | list | The TCP flags of the filter entry. The TCP C(established) cannot be combined with other tcp rules. The APIC defaults to C(unspecified) when unset during creation. | ||
| tenant | string | The name of the tenant. | ||
| timeout | int | The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable C(ACI_TIMEOUT) will be used instead. The default value is 30. | ||
| use_proxy | bool | If C(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable C(ACI_USE_PROXY) will be used instead. The default value is true. | ||
| use_ssl | bool | If C(false), an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable C(ACI_USE_SSL) will be used instead. The default value is true when the connection is local. | ||
| username | string | The username to use for authentication. If the value is not specified in the task, the value of environment variables C(ACI_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead. The default value is admin. | ||
| validate_certs | bool | If C(false), SSL certificates will not be validated. This should only set to C(false) when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable C(ACI_VALIDATE_CERTS) will be used instead. The default value is true. |
Example
yaml
- {"cisco.aci.aci_filter_entry": {"dst_port_end": 443, "dst_port_start": 443, "entry": "https_allow", "ether_type": "ip", "filter": "web_filter", "host": "apic", "ip_protocol": "tcp", "password": "SomeSecretPassword", "source_port_end": 22, "source_port_start": 20, "state": "present", "tcp_flags": ["acknowledgment", "finish"], "tenant": "prod", "username": "admin"}, "delegate_to": "localhost", "name": "Create a filter entry"}
- {"cisco.aci.aci_filter_entry": {"entry": "https_allow", "ether_type": "ip", "filter": "web_filter", "host": "apic", "ip_protocol": "tcp", "match_only_fragments": true, "password": "SomeSecretPassword", "state": "present", "tenant": "prod", "username": "admin"}, "delegate_to": "localhost", "name": "Create a filter entry with the match only packet fragments enabled"}
- {"cisco.aci.aci_filter_entry": {"entry": "https_allow", "filter": "web_filter", "host": "apic", "password": "SomeSecretPassword", "state": "absent", "tenant": "prod", "username": "admin"}, "delegate_to": "localhost", "name": "Delete a filter entry"}
- {"cisco.aci.aci_filter_entry": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all filter entries", "register": "query_result"}
- {"cisco.aci.aci_filter_entry": {"entry": "https_allow", "filter": "web_filter", "host": "apic", "password": "SomeSecretPassword", "state": "query", "tenant": "prod", "username": "admin"}, "delegate_to": "localhost", "name": "Query a specific filter entry", "register": "query_result"}