.. _a10_ddos_dst_zone_ip_proto_proto_name_level_module:


a10_ddos_dst_zone_ip_proto_proto_name_level
===========================================

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


Synopsis
--------

Policy Level Configuration






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                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
| proto_name_protocol          |                               | Key to identify parent object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
| zone_name                    |                               | Key to identify parent object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
| level_num                    |                               | '0'= Default policy level; '1'= Policy level 1; '2'= Policy level 2; '3'= Policy level 3; '4'= Policy level 4;                                                                                                                                                                                                                                                                                                                                                                                                    |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
| src_default_glid             |                               | Global limit ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
| glid_action                  |                               | 'drop'= Drop packets for glid exceed (Default); 'blacklist-src'= Blacklist-src for glid exceed; 'ignore'= Do nothing for glid exceed;                                                                                                                                                                                                                                                                                                                                                                             |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
| zone_escalation_score        |                               | Zone activation score of this level                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| int                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
| zone_violation_actions       |                               | Violation actions apply due to zone escalate from this level                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
| src_escalation_score         |                               | Source activation score of this level                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| int                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
| src_violation_actions        |                               | Violation actions apply due to source escalate from this level                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
| zone_template                |                               | Field zone_template                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| dict                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
|   | icmp_v4                  |                               | DDOS icmp-v4 template                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
|   | icmp_v6                  |                               | DDOS icmp-v6 template                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
|   | ip_proto                 |                               | DDOS ip-proto template                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
|   | encap                    |                               | DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
| uuid                         |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
| user_tag                     |                               | Customized tag                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
| indicator_list               |                               | Field indicator_list                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| list                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
|   | ntype                    |                               | 'pkt-rate'= rate of incoming packets; 'pkt-drop-rate'= rate of packets got dropped; 'bit-rate'= rate of incoming bits; 'pkt-drop-ratio'= ratio of incoming packet rate divided by the rate of dropping packets; 'bytes-to-bytes-from- ratio'= ratio of incoming packet rate divided by the rate of outgoing packets; 'frag-rate'= rate of incoming fragmented packets; 'cpu-utilization'= average data CPU utilization; 'interface-utilization'= outside interface utilization; 'learnt-sources'= learnt sources; |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
|   | data_packet_size         |                               | Expected minimal data size                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
|   | score                    |                               | Score corresponding to the indicator                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   | int                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
|   | 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                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
|   | src_violation_actions    |                               | Violation actions to use when this src indicator threshold reaches                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
|   | 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                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
|   | zone_violation_actions   |                               | Violation actions to use when this zone indicator threshold reaches                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   | 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

