Documentation

nxos_acl - Manages access list entries for ACLs.

New in version 2.2.

Synopsis

  • Manages access list entries for ACLs.

Options

parameter required default choices comments
ack
no
  • enable
Match on the ACK bit.
action
no
  • permit
  • deny
  • remark
Action of the ACE.
dest
no
Destination ip and mask using IP/MASK notation and supports the keyword 'any'.
dest_port1
no
Port/protocol and also first (lower) port when using range operand.
dest_port2
no
Second (end) port when using range operand.
dest_port_op
no
  • any
  • eq
  • gt
  • lt
  • neq
  • range
Destination port operands such as eq, neq, gt, lt, range.
dscp
no
  • af11
  • af12
  • af13
  • af21
  • af22
  • af23
  • af31
  • af32
  • af33
  • af41
  • af42
  • af43
  • cs1
  • cs2
  • cs3
  • cs4
  • cs5
  • cs6
  • cs7
  • default
  • ef
Match packets with given dscp value.
established
no
  • enable
Match established connections.
fin
no
  • enable
Match on the FIN bit.
fragments
no
  • enable
Check non-initial fragments.
host
yes
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
log
no
  • enable
Log matches against this entry.
name
yes
Case sensitive name of the access list (ACL).
password
no
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port
no 0 (use common port)
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
precedence
no
  • critical
  • flash
  • flash-override
  • immediate
  • internet
  • network
  • priority
  • routine
Match packets with given precedence.
proto
no
Port number or protocol (as supported by the switch).
provider
no
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
psh
no
  • enable
Match on the PSH bit.
remark
no
If action is set to remark, this is the description.
rst
no
  • enable
Match on the RST bit.
seq
no
Sequence number of the entry (ACE).
src
no
Source ip and mask using IP/MASK notation and supports keyword 'any'.
src_port1
no
Port/protocol and also first (lower) port when using range operand.
src_port2
no
Second (end) port when using range operand.
src_port_op
no
  • any
  • eq
  • gt
  • lt
  • neq
  • range
Source port operands such as eq, neq, gt, lt, range.
ssh_keyfile
no
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
state
no present
  • present
  • absent
  • delete_acl
Specify desired state of the resource.
syn
no
  • enable
Match on the SYN bit.
time-range
no
Name of time-range to apply.
timeout
(added in 2.3)
no 10
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
transport
yes cli
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
urg
no
  • enable
Match on the URG bit.
use_ssl
no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
username
no
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

Examples

# configure ACL ANSIBLE
- nxos_acl:
    name: ANSIBLE
    seq: 10
    action: permit
    proto: tcp
    src: 1.1.1.1/24
    dest: any
    state: present
    provider: "{{ nxos_provider }}"

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
end_state k/v pairs of ACL entries after module execution. always dict {'src': '1.1.1.1/24', 'name': 'ANSIBLE', 'seq': '10', 'proto': 'tcp', 'dest': 'any', 'action': 'permit'}
changed check to see if a change was made on the device always boolean True
updates commands sent to the device always list ['ip access-list ANSIBLE', '10 permit tcp 1.1.1.1/24 any']
proposed k/v pairs of parameters passed into module. always dict {'src': '1.1.1.1/24', 'name': 'ANSIBLE', 'seq': '10', 'proto': 'tcp', 'dest': 'any', 'action': 'permit'}
existing k/v pairs of existing ACL entries. always dict {}


Notes

Note

  • state=absent removes the ACE if it exists.
  • state=delete_acl deleted the ACL if it exists.
  • For idempotency, use port numbers for the src/dest port params like src_port1 and names for the well defined protocols for the proto param.
  • Although this module is idempotent in that if the ace as presented in the task is identical to the one on the switch, no changes will be made. If there is any difference, what is in Ansible will be pushed (configured options will be overridden). This is to improve security, but at the same time remember an ACE is removed, then re-added, so if there is a change, the new ACE will be exactly what parameters you are sending to the module.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.