nxos_acl – Manages access list entries for ACLs — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# nxos_acl – Manages access list entries for ACLs

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Manages access list entries for ACLs.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
ack - | Choices: enable | Match on the ACK bit.
action - | Choices: permit deny remark | Action of the ACE.
dest - |  | Destination ip and mask using IP/MASK notation and supports the keyword 'any'.
dest_port1 - |  | Port/protocol and also first (lower) port when using range operand.
dest_port2 - |  | Second (end) port when using range operand.
dest_port_op - | Choices: any eq gt lt neq range | 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 | Match packets with given dscp value.
established - | Choices: enable | Match established connections.
fin - | Choices: enable | Match on the FIN bit.
fragments - | Choices: enable | Check non-initial fragments.
log - | Choices: enable | 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 | Match packets with given precedence.
proto - |  | Port number or protocol (as supported by the switch).
provider dictionary |  | 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.
| auth_pass string added in 2.5.3 |  | 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.
| authorize boolean 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.
| host string / 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.
| password string |  | 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 integer | 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).
| ssh_keyfile string |  | 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.
| timeout integer | 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).
| transport string / required | Choices: cli ← nxapi | 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.
| use_proxy boolean added in 2.5 | Choices: no yes ← | If `no`, the environment variables `http_proxy` and `https_proxy` will be ignored.
| use_ssl boolean | Choices: no ← yes | Configures the transport to use SSL if set to `yes` only when the `transport=nxapi`, otherwise this value is ignored.
| username string |  | 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.
| validate_certs boolean | Choices: no yes ← | 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.
psh - | Choices: enable | Match on the PSH bit.
remark - |  | If action is set to remark, this is the description.
rst - | Choices: enable | Match on the RST bit.
seq - |  | Sequence number of the entry (ACE).
src - |  | Source ip and mask using IP/MASK notation and supports keyword 'any'.
src_port1 - |  | Port/protocol and also first (lower) port when using range operand.
src_port2 - |  | Second (end) port when using range operand.
src_port_op - | Choices: any eq gt lt neq range | 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 | Match on the SYN bit.
time_range - |  | Name of time-range to apply.
urg - | Choices: enable | 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: 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 | Returned | Description
--- | --- | ---
commands list | always | commands sent to the device Sample: ['ip access-list ANSIBLE', '10 permit tcp 192.0.2.1/24 any']

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]

### Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

### Authors

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

Hint

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