ansible / ansible.builtin / v2.9.0 / module / aci_filter_entry Manage filter entries (vz:Entry) | "added in version" 2.4 of ansible.builtin" Authors: Jacob McGill (@jmcgill298) preview | supported by certifiedansible.builtin.aci_filter_entry (v2.9.0) — module
pip
Install with pip install ansible==2.9.0
Manage filter entries for a filter on Cisco ACI fabrics.
- 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
host: aliases: - hostname description: - IP Address or hostname of APIC resolvable by Ansible control host. required: true type: str port: description: - Port number to be used for REST connection. - The default value depends on parameter C(use_ssl). type: int entry: aliases: - entry_name - filter_entry - name description: - Then name of the Filter Entry. type: str state: choices: - absent - present - query default: present description: - present, absent, query type: str filter: aliases: - filter_name description: - The name of Filter that the entry should belong to. type: str tenant: aliases: - tenant_name description: - The name of the tenant. type: str timeout: default: 30 description: - The socket level timeout in seconds. type: int use_ssl: default: true description: - If C(no), an HTTP connection will be used instead of the default HTTPS connection. type: bool arp_flag: choices: - arp_reply - arp_request - unspecified description: - The arp flag to use when the ether_type is arp. - The APIC defaults to C(unspecified) when unset during creation. type: str dst_port: description: - 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. type: str password: description: - 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. required: true type: str stateful: description: - Determines the statefulness of the filter entry. type: bool username: aliases: - user default: admin description: - The username to use for authentication. type: str use_proxy: default: true description: - If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. type: bool ether_type: choices: - arp - fcoe - ip - mac_security - mpls_ucast - trill - unspecified description: - The Ethernet type. - The APIC defaults to C(unspecified) when unset during creation. type: str description: aliases: - descr description: - Description for the Filter Entry. type: str ip_protocol: choices: - eigrp - egp - icmp - icmpv6 - igmp - igp - l2tp - ospfigp - pim - tcp - udp - unspecified description: - The IP Protocol type when ether_type is ip. - The APIC defaults to C(unspecified) when unset during creation. type: str private_key: aliases: - cert_key description: - 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. required: true type: str dst_port_end: description: - 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. type: str output_level: choices: - debug - info - normal default: normal description: - 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 type: str icmp_msg_type: choices: - dst_unreachable - echo - echo_reply - src_quench - time_exceeded - unspecified description: - ICMPv4 message type; used when ip_protocol is icmp. - The APIC defaults to C(unspecified) when unset during creation. type: str dst_port_start: description: - 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. type: str icmp6_msg_type: choices: - dst_unreachable - echo_request - echo_reply - neighbor_advertisement - neighbor_solicitation - redirect - time_exceeded - unspecified description: - ICMPv6 message type; used when ip_protocol is icmpv6. - The APIC defaults to C(unspecified) when unset during creation. type: str validate_certs: default: true description: - If C(no), SSL certificates will not be validated. - This should only set to C(no) when used on personally controlled sites using self-signed certificates. type: bool certificate_name: aliases: - cert_name description: - 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. type: str
current: description: The existing configuration from the APIC after the module has finished returned: success sample: - fvTenant: attributes: descr: Production environment dn: uni/tn-production name: production nameAlias: '' ownerKey: '' ownerTag: '' type: list error: description: The error information as returned from the APIC returned: failure sample: code: '122' text: unknown managed object class foo type: dict filter_string: description: The filter string used for the request returned: failure or debug sample: ?rsp-prop-include=config-only type: str method: description: The HTTP method used for the request to the APIC returned: failure or debug sample: POST type: str previous: description: The original configuration from the APIC before the module has started returned: info sample: - fvTenant: attributes: descr: Production dn: uni/tn-production name: production nameAlias: '' ownerKey: '' ownerTag: '' type: list proposed: description: The assembled configuration from the user-provided parameters returned: info sample: fvTenant: attributes: descr: Production environment name: production type: dict raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error sample: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata> type: str response: description: The HTTP response from the APIC returned: failure or debug sample: OK (30 bytes) type: str sent: description: The actual/minimal configuration pushed to the APIC returned: info sample: fvTenant: attributes: descr: Production environment type: list status: description: The HTTP status from the APIC returned: failure or debug sample: 200 type: int url: description: The HTTP url used for the request to the APIC returned: failure or debug sample: https://10.11.12.13/api/mo/uni/tn-production.json type: str