a10_template_limit_policy
Synopsis
Create a Limit Policy
Parameters
Parameters |
Choices/Defaults |
Comment |
|
---|---|---|---|
state str/required |
[‘noop’, ‘present’, ‘absent’] |
State of the object to be created. |
|
ansible_host str/required |
Host for AXAPI authentication |
||
ansible_username str/required |
Username for AXAPI authentication |
||
ansible_password str/required |
Password for AXAPI authentication |
||
ansible_port int/required |
Port for AXAPI authentication |
||
a10_device_context_id int |
[‘1-8’] |
Device ID for aVCS configuration |
|
a10_partition str |
Destination/target partition for object/command |
||
policy_number int/required |
Limit Policy Number |
||
parent int |
Specify the parent of limit-policy |
||
max_min_fair bool |
Enable max-min-fairness |
||
limit_concurrent_sessions int |
Enable Concurrent Session Limit (Number of Concurrent Sessions) |
||
log bool |
Log when Session Limit is exceeded |
||
limit_scope str |
‘aggregate’= Rule Level; ‘subscriber-ip’= Subscriber IP Level; ‘subscriber- prefix’= Subscriber Prefix Level; |
||
prefix_length int |
Prefix length |
||
uuid str |
uuid of the object |
||
user_tag str |
Customized tag |
||
limit_pps dict |
Field limit_pps |
||
uplink int |
Uplink PPS limit (Number of Packets per second) |
||
uplink_burstsize int |
PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets) |
||
uplink_relaxed bool |
Relax the limitation when the policy has more tokens from the parent of policy |
||
downlink int |
Downlink PPS limit (Number of Packets per second) |
||
ddos_protection_factor int |
Enable DDoS Protection (Multiplier of the downlink PPS) |
||
downlink_burstsize int |
PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets) |
||
downlink_relaxed bool |
Relax the limitation when the policy has more tokens from the parent of policy |
||
total int |
Total PPS limit (Number of Packets per second) |
||
total_burstsize int |
PPS Token Bucket Size (Must Exceed Configured Rate) (In Packets) |
||
total_relaxed bool |
Relax the limitation when the policy has more tokens from the parent of policy |
||
uuid str |
uuid of the object |
||
limit_throughput dict |
Field limit_throughput |
||
uplink int |
Uplink Throughput limit (Mega Bits per second) |
||
uplink_burstsize int |
Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second) |
||
uplink_relaxed bool |
Relax the limitation when the policy has more tokens from the parent of policy |
||
downlink int |
Downlink Throughput limit (Mega Bits per second) |
||
downlink_burstsize int |
Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second) |
||
downlink_relaxed bool |
Relax the limitation when the policy has more tokens from the parent of policy |
||
total int |
Total Throughput limit (Mega Bits per second) |
||
total_burstsize int |
Token Bucket Size (Must Exceed Configured Rate) (In Mega Bits per second) |
||
total_relaxed bool |
Relax the limitation when the policy has more tokens from the parent of policy |
||
uuid str |
uuid of the object |
||
limit_cps dict |
Field limit_cps |
||
value int |
Connections Per Second Rate Limit (Number of Connections per second) |
||
burstsize int |
CPS Token Bucket Size (Must Exceed Configured Rate) (In Connections per second) |
||
relaxed bool |
Relax the limitation when the policy has more tokens from the parent of policy |
||
uuid str |
uuid of the object |
Examples
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.