cisco.nxos.nxos_acl module – (deprecated, removed after 2022-06-01) Manages access list entries for ACLs.
Note
This module is part of the cisco.nxos collection (version 3.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.nxos
.
To use it in a playbook, specify: cisco.nxos.nxos_acl
.
New in cisco.nxos 1.0.0
DEPRECATED
- Removed in:
major release after 2022-06-01
- Why:
Updated modules released with more functionality
- Alternative:
nxos_acls
Synopsis
Manages access list entries for ACLs.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
Match on the ACK bit. Choices:
|
|
Action of the ACE. Choices:
|
|
Destination ip and mask using IP/MASK notation and supports the keyword ‘any’. |
|
Port/protocol and also first (lower) port when using range operand. |
|
Second (end) port when using range operand. |
|
Destination port operands such as eq, neq, gt, lt, range. Choices:
|
|
Match packets with given dscp value. Choices:
|
|
Match established connections. Choices:
|
|
Match on the FIN bit. Choices:
|
|
Check non-initial fragments. Choices:
|
|
Log matches against this entry. Choices:
|
|
Case sensitive name of the access list (ACL). |
|
Match packets with given precedence. Choices:
|
|
Port number or protocol (as supported by the switch). |
|
Deprecated Starting with Ansible 2.5 we recommend using Starting with Ansible 2.6 we recommend using This option will be removed in a release after 2022-06-01. For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html. A dict object containing connection details. |
|
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 |
|
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 Choices:
|
|
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. |
|
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 |
|
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). |
|
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 |
|
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). |
|
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. Choices:
|
|
If Choices:
|
|
Configures the transport to use SSL if set to Choices:
|
|
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 |
|
If Choices:
|
|
Match on the PSH bit. Choices:
|
|
If action is set to remark, this is the description. |
|
Match on the RST bit. Choices:
|
|
Sequence number of the entry (ACE). |
|
Source ip and mask using IP/MASK notation and supports keyword ‘any’. |
|
Port/protocol and also first (lower) port when using range operand. |
|
Second (end) port when using range operand. |
|
Source port operands such as eq, neq, gt, lt, range. Choices:
|
|
Specify desired state of the resource. Choices:
|
|
Match on the SYN bit. Choices:
|
|
Name of time-range to apply. |
|
Match on the URG bit. Choices:
|
Notes
Note
Tested against NXOSv 7.3.(0)D1(1) on VIRL
Unsupported for Cisco MDS
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 :ref:`NXOS Platform Options guide <nxos_platform_options>`
For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
Examples
# configure ACL ANSIBLE
- cisco.nxos.nxos_acl:
name: ANSIBLE
seq: 10
action: permit
proto: tcp
src: 192.0.2.1/24
dest: any
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
commands sent to the device Returned: always Sample: |
Status
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.