New in version 2.2.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| ack | no |
| Match on the ACK bit. | |
| action | no |
| 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 |
| Destination port operands such as eq, neq, gt, lt, range. | |
| dscp | no |
| Match packets with given dscp value. | |
| established | no |
| Match established connections. | |
| fin | no |
| Match on the FIN bit. | |
| fragments | no |
| 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 |
| 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 |
| 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 |
| Match on the PSH bit. | |
| remark | no | If action is set to remark, this is the description. | ||
| rst | no |
| 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 |
| 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 |
| Specify desired state of the resource. |
| syn | no |
| 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 |
| Match on the URG bit. | |
| use_ssl | 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. | ||
| validate_certs | no |
| 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. |
# 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 }}"
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| commands | commands sent to the device | always | list | ['ip access-list ANSIBLE', '10 permit tcp 1.1.1.1/24 any'] |
Note
state=absent removes the ACE if it exists.state=delete_acl deletes the ACL if it exists.This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/nxos_acl_module.html