Documentation

nxos_acl - Manages access list entries for ACLs.

New in version 2.2.

Synopsis

  • Manages access list entries for ACLs.

Parameters

Parameter Choices/Defaults Comments
ack
    Choices:
  • enable
Default:
None
Match on the ACK bit.
action
    Choices:
  • permit
  • deny
  • remark
Default:
None
Action of the ACE.
dest Default:
None
Destination ip and mask using IP/MASK notation and supports the keyword 'any'.
dest_port1 Default:
None
Port/protocol and also first (lower) port when using range operand.
dest_port2 Default:
None
Second (end) port when using range operand.
dest_port_op
    Choices:
  • any
  • eq
  • gt
  • lt
  • neq
  • range
Default:
None
Destination port operands such as eq, neq, gt, lt, range.
dscp
    Choices:
  • af11
  • af12
  • af13
  • af21
  • af22
  • af23
  • af31
  • af32
  • af33
  • af41
  • af42
  • af43
  • cs1
  • cs2
  • cs3
  • cs4
  • cs5
  • cs6
  • cs7
  • default
  • ef
Default:
None
Match packets with given dscp value.
established
    Choices:
  • enable
Default:
None
Match established connections.
fin
    Choices:
  • enable
Default:
None
Match on the FIN bit.
fragments
    Choices:
  • enable
Default:
None
Check non-initial fragments.
log
    Choices:
  • enable
Default:
None
Log matches against this entry.
name
required
Case sensitive name of the access list (ACL).
precedence
    Choices:
  • critical
  • flash
  • flash-override
  • immediate
  • internet
  • network
  • priority
  • routine
Default:
None
Match packets with given precedence.
proto Default:
None
Port number or protocol (as supported by the switch).
provider Default:
None
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli.
This option is only required if you are using NX-API.
For more information please see the NXOS Platform Options guide.

A dict object containing connection details.
username
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.
authorize
(added in 2.5.3)
    Choices:
  • no ←
  • yes
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead.
ssh_keyfile
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.
use_proxy
(added in 2.5)
    Choices:
  • yes ←
  • no
If no, the environment variables http_proxy and https_proxy will be ignored.
auth_pass
(added in 2.5.3)
Default:
none
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead.
host
required
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.
timeout
(added in 2.3)
Default:
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).
use_ssl
    Choices:
  • yes
  • no ←
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
password Default:
None
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.
validate_certs
    Choices:
  • yes
  • no
Default:
None
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored.
port Default:
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).
transport
required
Default:
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.
psh
    Choices:
  • enable
Default:
None
Match on the PSH bit.
remark Default:
None
If action is set to remark, this is the description.
rst
    Choices:
  • enable
Default:
None
Match on the RST bit.
seq Default:
None
Sequence number of the entry (ACE).
src Default:
None
Source ip and mask using IP/MASK notation and supports keyword 'any'.
src_port1 Default:
None
Port/protocol and also first (lower) port when using range operand.
src_port2 Default:
None
Second (end) port when using range operand.
src_port_op
    Choices:
  • any
  • eq
  • gt
  • lt
  • neq
  • range
Default:
None
Source port operands such as eq, neq, gt, lt, range.
state
    Choices:
  • present ←
  • absent
  • delete_acl
Specify desired state of the resource.
syn
    Choices:
  • enable
Default:
None
Match on the SYN bit.
time_range Default:
None
Name of time-range to apply.
urg
    Choices:
  • enable
Default:
None
Match on the URG bit.

Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL
  • state=absent removes the ACE if it exists.
  • state=delete_acl deletes 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.
  • For information on using CLI and NX-API see the NXOS Platform Options guide
  • For more information on using Ansible to manage network devices see the Ansible Network Guide
  • For more information on using Ansible to manage Cisco devices see the Cisco integration page.

Examples

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

Return Values

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

Key Returned Description
commands
list
always
commands sent to the device

Sample:
['ip access-list ANSIBLE', '10 permit tcp 1.1.1.1/24 any']


Status

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

Support

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author

  • Jason Edelman (@jedelman8)
  • Gabriele Gerbino (@GGabriele)

Hint

If you notice any issues in this documentation you can edit this document to improve it.