.. _a10_slb_rate_limit_log_module:


a10_slb_rate_limit_log
======================

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


Synopsis
--------

Configure rate limit logging






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                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| uuid                        |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                             |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| str                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| sampling_enable             |                               | Field sampling_enable                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                             |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| list                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | counters1               |                               | 'all'= all; 'total_log_times'= Total log times; 'total_log_msg'= Total log messages; 'local_log_msg'= Local log messages; 'remote_log_msg'= Remote log messages; 'local_log_rate'= Local rate (per sec); 'remote_log_rate'= Remote rate (per sec); 'msg_too_big'= Log message too big; 'buff_alloc_fail'= Buffer alloc fail; 'no_route'= No route; 'buff_send_fail'= Buffer send fail; 'alloc_conn'= Log-session alloc; 'free_conn'= Log-session free; 'conn_alloc_fail'= Log-session alloc fail; 'no_repeat_msg'= No repeat message; 'local_log_dropped'= Local log dropped due to rate-limit; |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| oper                        |                               | Field oper                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|                             |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| dict                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | rate_limit_log_cpu_list |                               | Field rate_limit_log_cpu_list                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | list                    |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | cpu_count               |                               | Field cpu_count                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | int                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
| stats                       |                               | Field stats                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                             |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| dict                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | total_log_times         |                               | Total log times                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | total_log_msg           |                               | Total log messages                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | local_log_msg           |                               | Local log messages                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | remote_log_msg          |                               | Remote log messages                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | local_log_rate          |                               | Local rate (per sec)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | remote_log_rate         |                               | Remote rate (per sec)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | msg_too_big             |                               | Log message too big                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | buff_alloc_fail         |                               | Buffer alloc fail                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | no_route                |                               | No route                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | buff_send_fail          |                               | Buffer send fail                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | alloc_conn              |                               | Log-session alloc                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | free_conn               |                               | Log-session free                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | conn_alloc_fail         |                               | Log-session alloc fail                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | no_repeat_msg           |                               | No repeat message                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | str                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
|   | local_log_dropped       |                               | Local log dropped due to rate-limit                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   | 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

