.. _cisco.nxos.nxos_acls_module:
********************
cisco.nxos.nxos_acls
********************
**ACLs resource module**
Version added: 1.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- Manage named IP ACLs on the Cisco NX-OS platform
Parameters
----------
.. raw:: html
| Parameter |
Choices/Defaults |
Comments |
|
config
list
/ elements=dictionary
|
|
A dictionary of ACL options.
|
|
acls
list
/ elements=dictionary
|
|
A list of the ACLs.
|
|
|
aces
list
/ elements=dictionary
|
|
The entries within the ACL.
|
|
|
|
destination
dictionary
|
|
Specify the packet destination.
|
|
|
|
|
address
string
|
|
Destination network address.
|
|
|
|
|
any
boolean
|
|
Any destination address.
|
|
|
|
|
host
string
|
|
Host IP address.
|
|
|
|
|
port_protocol
dictionary
|
|
Specify the destination port or protocol (only for TCP and UDP).
|
|
|
|
|
|
eq
string
|
|
Match only packets on a given port number.
|
|
|
|
|
|
gt
string
|
|
Match only packets with a greater port number.
|
|
|
|
|
|
lt
string
|
|
Match only packets with a lower port number.
|
|
|
|
|
|
neq
string
|
|
Match only packets not on a given port number.
|
|
|
|
|
|
range
dictionary
|
|
Match only packets in the range of port numbers.
|
|
|
|
|
|
|
end
string
|
|
Specify the end of the port range.
|
|
|
|
|
|
|
start
string
|
|
Specify the start of the port range.
|
|
|
|
|
prefix
string
|
|
Destination network prefix. Only for prefixes of value less than 31 for ipv4 and 127 for ipv6. Prefixes of 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
|
|
|
|
|
wildcard_bits
string
|
|
Destination wildcard bits.
|
|
|
|
dscp
string
|
|
Match packets with given DSCP value.
|
|
|
|
fragments
boolean
|
|
Check non-initial fragments.
|
|
|
|
grant
string
|
|
Action to be applied on the rule.
|
|
|
|
log
boolean
|
|
Log matches against this entry.
|
|
|
|
precedence
string
|
|
Match packets with given precedence value.
|
|
|
|
protocol
string
|
|
Specify the protocol.
|
|
|
|
protocol_options
dictionary
|
|
All possible suboptions for the protocol chosen.
|
|
|
|
|
icmp
dictionary
|
|
ICMP protocol options.
|
|
|
|
|
|
administratively_prohibited
boolean
|
|
Administratively prohibited
|
|
|
|
|
|
alternate_address
boolean
|
|
Alternate address
|
|
|
|
|
|
conversion_error
boolean
|
|
Datagram conversion
|
|
|
|
|
|
dod_host_prohibited
boolean
|
|
Host prohibited
|
|
|
|
|
|
dod_net_prohibited
boolean
|
|
Net prohibited
|
|
|
|
|
|
echo
boolean
|
|
Echo (ping)
|
|
|
|
|
|
echo_reply
boolean
|
|
Echo reply
|
|
|
|
|
|
echo_request
boolean
|
|
Echo request (ping)
|
|
|
|
|
|
general_parameter_problem
boolean
|
|
Parameter problem
|
|
|
|
|
|
host_isolated
boolean
|
|
Host isolated
|
|
|
|
|
|
host_precedence_unreachable
boolean
|
|
Host unreachable for precedence
|
|
|
|
|
|
host_redirect
boolean
|
|
Host redirect
|
|
|
|
|
|
host_tos_redirect
boolean
|
|
Host redirect for TOS
|
|
|
|
|
|
host_tos_unreachable
boolean
|
|
Host unreachable for TOS
|
|
|
|
|
|
host_unknown
boolean
|
|
Host unknown
|
|
|
|
|
|
host_unreachable
boolean
|
|
Host unreachable
|
|
|
|
|
|
information_reply
boolean
|
|
Information replies
|
|
|
|
|
|
information_request
boolean
|
|
Information requests
|
|
|
|
|
|
mask_reply
boolean
|
|
Mask replies
|
|
|
|
|
|
mask_request
boolean
|
|
Mask requests
|
|
|
|
|
|
message_code
integer
|
|
ICMP message code
|
|
|
|
|
|
message_type
integer
|
|
ICMP message type
|
|
|
|
|
|
mobile_redirect
boolean
|
|
Mobile host redirect
|
|
|
|
|
|
net_redirect
boolean
|
|
Network redirect
|
|
|
|
|
|
net_tos_redirect
boolean
|
|
Net redirect for TOS
|
|
|
|
|
|
net_tos_unreachable
boolean
|
|
Network unreachable for TOS
|
|
|
|
|
|
net_unreachable
boolean
|
|
Net unreachable
|
|
|
|
|
|
network_unknown
boolean
|
|
Network unknown
|
|
|
|
|
|
no_room_for_option
boolean
|
|
Parameter required but no room
|
|
|
|
|
|
option_missing
boolean
|
|
Parameter required but not present
|
|
|
|
|
|
packet_too_big
boolean
|
|
Fragmentation needed and DF set
|
|
|
|
|
|
parameter_problem
boolean
|
|
All parameter problems
|
|
|
|
|
|
port_unreachable
boolean
|
|
Port unreachable
|
|
|
|
|
|
precedence_unreachable
boolean
|
|
Precedence cutoff
|
|
|
|
|
|
protocol_unreachable
boolean
|
|
Protocol unreachable
|
|
|
|
|
|
reassembly_timeout
boolean
|
|
Reassembly timeout
|
|
|
|
|
|
redirect
boolean
|
|
All redirects
|
|
|
|
|
|
router_advertisement
boolean
|
|
Router discovery advertisements
|
|
|
|
|
|
router_solicitation
boolean
|
|
Router discovery solicitations
|
|
|
|
|
|
source_quench
boolean
|
|
Source quenches
|
|
|
|
|
|
source_route_failed
boolean
|
|
Source route failed
|
|
|
|
|
|
time_exceeded
boolean
|
|
All time exceeded.
|
|
|
|
|
|
timestamp_reply
boolean
|
|
Timestamp replies
|
|
|
|
|
|
timestamp_request
boolean
|
|
Timestamp requests
|
|
|
|
|
|
traceroute
boolean
|
|
Traceroute
|
|
|
|
|
|
ttl_exceeded
boolean
|
|
TTL exceeded
|
|
|
|
|
|
unreachable
boolean
|
|
All unreachables
|
|
|
|
|
igmp
dictionary
|
|
IGMP protocol options.
|
|
|
|
|
|
dvmrp
boolean
|
|
Distance Vector Multicast Routing Protocol
|
|
|
|
|
|
host_query
boolean
|
|
Host Query
|
|
|
|
|
|
host_report
boolean
|
|
Host Report
|
|
|
|
|
tcp
dictionary
|
|
TCP flags.
|
|
|
|
|
|
ack
boolean
|
|
Match on the ACK bit
|
|
|
|
|
|
established
boolean
|
|
Match established connections
|
|
|
|
|
|
fin
boolean
|
|
Match on the FIN bit
|
|
|
|
|
|
psh
boolean
|
|
Match on the PSH bit
|
|
|
|
|
|
rst
boolean
|
|
Match on the RST bit
|
|
|
|
|
|
syn
boolean
|
|
Match on the SYN bit
|
|
|
|
|
|
urg
boolean
|
|
Match on the URG bit
|
|
|
|
remark
string
|
|
Access list entry comment.
|
|
|
|
sequence
integer
|
|
Sequence number.
|
|
|
|
source
dictionary
|
|
Specify the packet source.
|
|
|
|
|
address
string
|
|
Source network address.
|
|
|
|
|
any
boolean
|
|
Any source address.
|
|
|
|
|
host
string
|
|
Host IP address.
|
|
|
|
|
port_protocol
dictionary
|
|
Specify the destination port or protocol (only for TCP and UDP).
|
|
|
|
|
|
eq
string
|
|
Match only packets on a given port number.
|
|
|
|
|
|
gt
string
|
|
Match only packets with a greater port number.
|
|
|
|
|
|
lt
string
|
|
Match only packets with a lower port number.
|
|
|
|
|
|
neq
string
|
|
Match only packets not on a given port number.
|
|
|
|
|
|
range
dictionary
|
|
Match only packets in the range of port numbers.
|
|
|
|
|
|
|
end
string
|
|
Specify the end of the port range.
|
|
|
|
|
|
|
start
string
|
|
Specify the start of the port range.
|
|
|
|
|
prefix
string
|
|
Source network prefix. Only for prefixes of mask value less than 31 for ipv4 and 127 for ipv6. Prefixes of mask 32 (ipv4) and 128 (ipv6) should be given in the 'host' key.
|
|
|
|
|
wildcard_bits
string
|
|
Source wildcard bits.
|
|
|
name
string
/ required
|
|
Name of the ACL.
|
|
afi
string
/ required
|
|
The Address Family Indicator (AFI) for the ACL.
|
|
running_config
string
|
|
This option is used only with state parsed.
The value of this option should be the output received from the NX-OS device by executing the command show running-config | section 'ip(v6* access-list).
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
|
|
state
string
|
Choices:
- deleted
- gathered
merged ←
- overridden
- rendered
- replaced
- parsed
|
The state the configuration should be left in
|