.. _a10_ddos_zone_profile_port_indicator_module:


a10_ddos_zone_profile_port_indicator
====================================

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


Synopsis
--------

DDoS zone profile indicator config






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                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
| port_protocol                |                               | Key to identify parent object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
| port_num                     |                               | Key to identify parent object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
| zone_profile_profile_name    |                               | Key to identify parent object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
| indicator_name               |                               | 'pkt-rate'= pkt-rate; 'pkt-drop-rate'= pkt-drop-rate; 'bit-rate'= bit-rate; 'pkt-drop-ratio'= pkt-drop-ratio; 'bytes-to-bytes-from-ratio'= bytes-to-bytes- from-ratio; 'concurrent-conns'= concurrent-conns; 'conn-miss-rate'= conn-miss- rate; 'syn-rate'= syn-rate; 'fin-rate'= fin-rate; 'rst-rate'= rst-rate; 'syn- ack-rate'= syn-ack-rate; 'small-window-ack-rate'= small-window-ack-rate; 'empty-ack-rate'= empty-ack-rate; 'small-payload-rate'= small-payload-rate; 'syn-fin-ratio'= syn-fin-ratio; 'cpu-utilization'= cpu-utilization; 'interface- utilization'= interface-utilization; 'learnt-sources'= learnt-sources; |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
| src_threshold_cfg            |                               | Field src_threshold_cfg                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| dict                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
|   | src_threshold_num        |                               | Indicator per-src threshold                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
|   | src_threshold_large_num  |                               | Indicator per-src threshold                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
|   | src_threshold_str        |                               | Indicator per-src threshold (Non-zero floating point)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
| zone_threshold_cfg           |                               | Field zone_threshold_cfg                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| dict                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
|   | zone_threshold_num       |                               | Threshold for the entire zone                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
|   | zone_threshold_large_num |                               | Threshold for the entire zone                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
|   | zone_threshold_str       |                               | Threshold for the entire zone (Non-zero floating point)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
| uuid                         |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
| user_tag                     |                               | Customized tag                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 







Examples
--------

.. code-block:: yaml+jinja

    



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

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


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


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


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


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


  response_body (, complex, )
    Response from the AXAPI






Status
------




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


- This module is maintained by community.



Authors
~~~~~~~

- A10 Networks

