.. _a10_system_icmp_rate_module:


a10_system_icmp_rate
====================

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


Synopsis
--------

Icmp rate limit statistics






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; 'over_limit_drop'= Over limit drops; 'limit_intf_drop'= Interfaces rate limit drops; 'limit_vserver_drop'= Virtual Server rate limit drops; 'limit_total_drop'= Total rate limit drops; 'lockup_time_left'= Lockup time left; 'curr_rate'= Current rate; 'v6_over_limit_drop'= Over limit drops (v6); 'v6_limit_intf_drop'= Interfaces rate limit drops (v6); 'v6_limit_vserver_drop'= Virtual Server rate limit drops (v6); 'v6_limit_total_drop'= Total rate limit drops (v6); 'v6_lockup_time_left'= Lockup time left (v6); 'v6_curr_rate'= Current rate (v6); |
|   |                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   | str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
| stats                     |                               | Field stats                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| dict                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
|   | over_limit_drop       |                               | Over limit drops                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   |                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   | str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
|   | limit_intf_drop       |                               | Interfaces rate limit drops                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   |                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   | str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
|   | limit_vserver_drop    |                               | Virtual Server rate limit drops                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   | str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
|   | limit_total_drop      |                               | Total rate limit drops                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   | str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
|   | lockup_time_left      |                               | Lockup time left                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   |                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   | str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
|   | curr_rate             |                               | Current rate                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|   |                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   | str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
|   | v6_over_limit_drop    |                               | Over limit drops (v6)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   | str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
|   | v6_limit_intf_drop    |                               | Interfaces rate limit drops (v6)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   |                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   | str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
|   | v6_limit_vserver_drop |                               | Virtual Server rate limit drops (v6)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   |                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   | str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
|   | v6_limit_total_drop   |                               | Total rate limit drops (v6)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   |                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   | str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
|   | v6_lockup_time_left   |                               | Lockup time left (v6)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   | str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 
|   | v6_curr_rate          |                               | Current rate (v6)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   | 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

