.. _a10_ip_access_list_module:


a10_ip_access_list
==================

.. contents::
   :local:
   :depth: 1


Synopsis
--------

Configure Access List






Parameters
----------

 
| Parameters                   | Choices/Defaults              | Comment                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| state                        | ['noop', 'present', 'absent'] | State of the object to be created.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| ansible_host                 |                               | Host for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| ansible_username             |                               | Username for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| ansible_password             |                               | Password for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| ansible_port                 |                               | Port for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| a10_device_context_id        | ['1-8']                       | Device ID for aVCS configuration                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| a10_partition                |                               | Destination/target partition for object/command                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| name                         |                               | IP Access List Name. Does not support name as digits or start with digit.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| rules                        |                               | Field rules                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| list                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | seq_num                  |                               | Sequence Number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | action                   |                               | 'deny'= Deny; 'permit'= Permit; 'l3-vlan-fwd-disable'= Disable L3 forwarding between VLANs;                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | remark                   |                               | Access list entry comment (Notes for this ACL)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | icmp                     |                               | Internet Control Message Protocol                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | tcp                      |                               | protocol TCP                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | udp                      |                               | protocol UDP                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | ip                       |                               | Any Internet Protocol                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | service_obj_group        |                               | Service object group (Source object group name)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | geo_location             |                               | Specify geo-location name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | icmp_type                |                               | ICMP type number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | any_type                 |                               | Any ICMP type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | special_type             |                               | 'echo-reply'= Type 0, echo reply; 'echo-request'= Type 8, echo request; 'info- reply'= Type 16, information reply; 'info-request'= Type 15, information request; 'mask-reply'= Type 18, address mask reply; 'mask-request'= Type 17, address mask request; 'parameter-problem'= Type 12, parameter problem; 'redirect'= Type 5, redirect message; 'source-quench'= Type 4, source quench; 'time-exceeded'= Type 11, time exceeded; 'timestamp'= Type 13, timestamp; 'timestamp-reply'= Type 14, timestamp reply; 'dest-unreachable'= Type 3, destination unreachable; |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | any_code                 |                               | Any ICMP code                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | icmp_code                |                               | ICMP code number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | special_code             |                               | 'frag-required'= Code 4, fragmentation required; 'host-unreachable'= Code 1, destination host unreachable; 'network-unreachable'= Code 0, destination network unreachable; 'port-unreachable'= Code 3, destination port unreachable; 'proto-unreachable'= Code 2, destination protocol unreachable; 'route-failed'= Code 5, source route failed;                                                                                                                                                                                                                      |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | src_any                  |                               | Any source host                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | src_host                 |                               | A single source host (Host address)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | src_subnet               |                               | Source Address                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | src_mask                 |                               | Source Mask 0=apply 255=ignore                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | src_object_group         |                               | Network object group (Source network object group name)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | src_eq                   |                               | Match only packets on a given source port (port number)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | src_gt                   |                               | Match only packets with a greater port number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | src_lt                   |                               | Match only packets with a lower port number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | src_range                |                               | match only packets in the range of port numbers (Starting Port Number)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | src_port_end             |                               | Ending Port Number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | dst_any                  |                               | Any destination host                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | dst_host                 |                               | A single destination host (Host address)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | dst_subnet               |                               | Destination Address                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | dst_mask                 |                               | Destination Mask 0=apply 255=ignore                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | dst_object_group         |                               | Destination network object group name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | dst_eq                   |                               | Match only packets on a given destination port (port number)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | dst_gt                   |                               | Match only packets with a greater port number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | dst_lt                   |                               | Match only packets with a lesser port number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | dst_range                |                               | Match only packets in the range of port numbers (Starting Destination Port Number)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | dst_port_end             |                               | Edning Destination Port Number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | fragments                |                               | IP fragments                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | vlan                     |                               | VLAN ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | ethernet                 |                               | Ethernet interface (Port number)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | trunk                    |                               | Ethernet trunk (trunk number)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | dscp                     |                               | DSCP                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | established              |                               | TCP established                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | acl_log                  |                               | Log matches against this entry                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | transparent_session_only |                               | Only log transparent sessions                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| uuid                         |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| user_tag                     |                               | Customized tag                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 







Examples
--------

.. code-block:: yaml+jinja

    



Return Values
-------------

modified_values (changed, dict, )
  Values modified (or potential changes if using check_mode) as a result of task operation


axapi_calls (always, list, )
  Sequential list of AXAPI calls made by the task


  endpoint (, str, ['/axapi/v3/slb/virtual_server', '/axapi/v3/file/ssl-cert'])
    The AXAPI endpoint being accessed.


  http_method (, str, ['POST', 'GET'])
    HTTP method being used by the primary task to interact with the AXAPI endpoint.


  request_body (, complex, )
    Params used to query the AXAPI


  response_body (, complex, )
    Response from the AXAPI






Status
------




- This module is not guaranteed to have a backwards compatible interface. *[preview]*


- This module is maintained by community.



Authors
~~~~~~~

- A10 Networks

