.. _a10_system_throughput_module:


a10_system_throughput
=====================

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


Synopsis
--------

System throughput






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; 'global-system-throughput-bits-per-sec'= Global System egress throughput in bits/sec; 'global-system-ingress-throughput-bits-per-sec'= Global System ingress throughput in bits/sec; 'per-part-throughput-bits-per-sec'= Partition throughput in bits/sec; 'global-client-ssl-count'= global ssl count; 'global-server-ssl-count'= global server ssl count; 'global-client-ssl- connections-per-sec'= global ssl conneciton per sec; 'global-server-ssl- connections-per-sec'= global server ssl conneciton; |
|   |                                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   | str                                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 
| stats                                             |                               | Field stats                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                                                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| dict                                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 
|   | global_system_throughput_bits_per_sec         |                               | Global System egress throughput in bits/sec                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   |                                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   | str                                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 
|   | global_system_ingress_throughput_bits_per_sec |                               | Global System ingress throughput in bits/sec                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   | str                                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 
|   | per_part_throughput_bits_per_sec              |                               | Partition throughput in bits/sec                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   | str                                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 
|   | global_client_ssl_count                       |                               | global ssl count                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   | str                                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 
|   | global_server_ssl_count                       |                               | global server ssl count                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|   |                                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   | str                                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 
|   | global_client_ssl_connections_per_sec         |                               | global ssl conneciton per sec                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|   |                                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   | str                                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 
|   | global_server_ssl_connections_per_sec         |                               | global server ssl conneciton                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   | 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

