a10_slb_virtual_server_port
Synopsis
Virtual Port
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 |
||
virtual_server_name str/required |
Key to identify parent object |
||
port_number int/required |
Port |
||
protocol str/required |
‘tcp’= TCP LB service; ‘udp’= UDP Port; ‘others’= for no tcp/udp protocol, do IP load balancing; ‘diameter’= diameter port; ‘dns-tcp’= DNS service over TCP; ‘dns-udp’= DNS service over UDP; ‘fast-http’= Fast HTTP Port; ‘fix’= FIX Port; ‘ftp’= File Transfer Protocol Port; ‘ftp-proxy’= ftp proxy port; ‘http’= HTTP Port; ‘https’= HTTPS port; ‘imap’= imap proxy port; ‘mlb’= Message based load balancing; ‘mms’= Microsoft Multimedia Service Port; ‘mysql’= mssql port; ‘mssql’= mssql; ‘pop3’= pop3 proxy port; ‘radius’= RADIUS Port; ‘rtsp’= Real Time Streaming Protocol Port; ‘sip’= Session initiation protocol over UDP; ‘sip-tcp’= Session initiation protocol over TCP; ‘sips’= Session initiation protocol over TLS; ‘smpp-tcp’= SMPP service over TCP; ‘spdy’= spdy port; ‘spdys’= spdys port; ‘smtp’= SMTP Port; ‘mqtt’= MQTT Port; ‘mqtts’= MQTTS Port; ‘ssl-proxy’= Generic SSL proxy; ‘ssli’= SSL insight; ‘ssh’= SSH Port; ‘tcp- proxy’= Generic TCP proxy; ‘tftp’= TFTP Port; ‘fast-fix’= Fast FIX port; |
||
range int |
Virtual Port range (Virtual Port range value) |
||
alternate_port bool |
Alternate Virtual Port |
||
proxy_layer str |
‘v1’= Force using old proxy; ‘v2’= Force using new proxy; |
||
optimization_level str |
‘0’= No optimization; ‘1’= Optimization level 1 (Experimental); |
||
support_http2 bool |
Support HTTP2 |
||
ip_only_lb bool |
Enable IP-Only LB mode |
||
name str |
SLB Virtual Service Name |
||
conn_limit int |
Connection Limit |
||
reset bool |
Send client reset when connection number over limit |
||
no_logging bool |
Do not log connection over limit event |
||
use_alternate_port bool |
Use alternate virtual port |
||
alternate_port_number int |
Virtual Port |
||
alt_protocol1 str |
‘http’= HTTP Port; |
||
serv_sel_fail bool |
Use alternate virtual port when server selection failure |
||
when_down bool |
Use alternate virtual port when down |
||
alt_protocol2 str |
‘tcp’= TCP LB service; |
||
req_fail bool |
Use alternate virtual port when L7 request fail |
||
when_down_protocol2 bool |
Use alternate virtual port when down |
||
action str |
‘enable’= Enable; ‘disable’= Disable; |
||
l7_service_chain bool |
Field l7_service_chain |
||
def_selection_if_pref_failed str |
‘def-selection-if-pref-failed’= Use default server selection method if prefer method failed; ‘def-selection-if-pref-failed-disable’= Stop using default server selection method if prefer method failed; |
||
ha_conn_mirror bool |
Enable for HA Conn sync |
||
on_syn bool |
Enable for HA Conn sync for l4 tcp sessions on SYN |
||
skip_rev_hash bool |
Skip rev tuple hash insertion |
||
message_switching bool |
Message switching |
||
force_routing_mode bool |
Force routing mode |
||
one_server_conn bool |
Support server that allow only one connection |
||
rate int |
Specify the log message rate |
||
secs int |
Specify the interval in seconds |
||
reset_on_server_selection_fail bool |
Send client reset when server selection fails |
||
clientip_sticky_nat bool |
Prefer to use same source NAT address for a client |
||
extended_stats bool |
Enable extended statistics on virtual port |
||
gslb_enable bool |
Enable Global Server Load Balancing |
||
view int |
Specify a GSLB View (ID) |
||
snat_on_vip bool |
Enable source NAT traffic against VIP |
||
stats_data_action str |
‘stats-data-enable’= Enable statistical data collection for virtual port; ‘stats-data-disable’= Disable statistical data collection for virtual port; |
||
syn_cookie bool |
Enable syn-cookie |
||
expand bool |
expand syn-cookie with timestamp and wscale |
||
showtech_print_extended_stats bool |
Enable print extended stats in showtech for dns vports |
||
attack_detection bool |
Enable analytics |
||
acl_list list |
Field acl_list |
||
acl_id int |
ACL id VPORT |
||
acl_name str |
Apply an access list name (Named Access List) |
||
acl_id_shared int |
acl id |
||
acl_name_shared str |
Apply an access list name (Named Access List) |
||
acl_id_src_nat_pool str |
Policy based Source NAT (NAT Pool or Pool Group) |
||
acl_id_seq_num int |
Specify ACL precedence (sequence-number) |
||
shared_partition_pool_id bool |
Policy based Source NAT from shared partition |
||
acl_id_src_nat_pool_shared str |
Policy based Source NAT (NAT Pool or Pool Group) |
||
acl_id_seq_num_shared int |
Specify ACL precedence (sequence-number) |
||
v_acl_id_src_nat_pool str |
Policy based Source NAT (NAT Pool or Pool Group) |
||
v_acl_id_seq_num int |
Specify ACL precedence (sequence-number) |
||
v_shared_partition_pool_id bool |
Policy based Source NAT from shared partition |
||
v_acl_id_src_nat_pool_shared str |
Policy based Source NAT (NAT Pool or Pool Group) |
||
v_acl_id_seq_num_shared int |
Specify ACL precedence (sequence-number) |
||
acl_name_src_nat_pool str |
Policy based Source NAT (NAT Pool or Pool Group) |
||
acl_name_seq_num int |
Specify ACL precedence (sequence-number) |
||
shared_partition_pool_name bool |
Policy based Source NAT from shared partition |
||
acl_name_src_nat_pool_shared str |
Policy based Source NAT (NAT Pool or Pool Group) |
||
acl_name_seq_num_shared int |
Specify ACL precedence (sequence-number) |
||
v_acl_name_src_nat_pool str |
Policy based Source NAT (NAT Pool or Pool Group) |
||
v_acl_name_seq_num int |
Specify ACL precedence (sequence-number) |
||
v_shared_partition_pool_name bool |
Policy based Source NAT from shared partition |
||
v_acl_name_src_nat_pool_shared str |
Policy based Source NAT (NAT Pool or Pool Group) |
||
v_acl_name_seq_num_shared int |
Specify ACL precedence (sequence-number) |
||
template_policy str |
Policy Template (Policy template name) |
||
shared_partition_policy_template bool |
Reference a policy template from shared partition |
||
template_policy_shared str |
Policy Template Name |
||
aflex_scripts list |
Field aflex_scripts |
||
aflex str |
aFleX Script Name |
||
aflex_shared str |
aFleX Script Name |
||
no_auto_up_on_aflex bool |
Don’t automatically mark vport up when aFleX is bound |
||
enable_scaleout bool |
Field enable_scaleout |
||
scaleout_bucket_count int |
Number of traffic buckets |
||
scaleout_device_group int |
Device group id |
||
pool str |
Specify NAT pool or pool group |
||
shared_partition_pool bool |
Specify NAT pool or pool group from shared partition |
||
pool_shared str |
Specify NAT pool or pool group |
||
auto bool |
Configure auto NAT for the vport |
||
precedence bool |
Set auto NAT pool as higher precedence for source NAT |
||
ip_smart_rr bool |
Use IP address round-robin behavior |
||
use_cgnv6 bool |
Follow CGNv6 source NAT configuration |
||
enable_playerid_check bool |
Enable playerid checks on UDP packets once the AX is in active mode |
||
service_group str |
Bind a Service Group to this Virtual Server (Service Group Name) |
||
ipinip bool |
Enable IP in IP |
||
ip_map_list str |
Enter name of IP Map List to be bound (IP Map List Name) |
||
rtp_sip_call_id_match bool |
rtp traffic try to match the real server of sip smp call-id session |
||
use_rcv_hop_for_resp bool |
Use receive hop for response to client(For packets on default-vlan, also config ‘vlan-global enable-def-vlan-l2-forwarding’.) |
||
persist_type str |
‘src-dst-ip-swap-persist’= Create persist session after source IP and destination IP swap; ‘use-src-ip-for-dst-persist’= Use the source IP to create a destination persist session; ‘use-dst-ip-for-src-persist’= Use the destination IP to create source IP persist session; |
||
use_rcv_hop_group bool |
Set use-rcv-hop group |
||
server_group str |
Bind a use-rcv-hop-for-resp Server Group to this Virtual Server (Server Group Name) |
||
reselection str |
‘disable’= disable; |
||
eth_fwd str |
Ethernet interface number |
||
trunk_fwd str |
Trunk interface number |
||
eth_rev str |
Ethernet interface number |
||
trunk_rev str |
Trunk interface number |
||
template_sip str |
SIP Template Name |
||
p_template_sip_shared bool |
SIP Template Name |
||
template_sip_shared str |
SIP template |
||
template_smpp str |
SMPP template |
||
shared_partition_smpp_template bool |
Reference a smpp template from shared partition |
||
template_smpp_shared str |
SMPP Template Name |
||
template_dblb str |
DBLB Template (DBLB template name) |
||
shared_partition_dblb_template bool |
Reference a dblb template from shared partition |
||
template_dblb_shared str |
DBLB Template Name |
||
template_connection_reuse str |
Connection Reuse Template (Connection Reuse Template Name) |
||
shared_partition_connection_reuse_template bool |
Reference a connection reuse template from shared partition |
||
template_connection_reuse_shared str |
Connection Reuse Template Name |
||
template_dns str |
DNS template (DNS template name) |
||
shared_partition_dns_template bool |
Reference a dns template from shared partition |
||
template_dns_shared str |
DNS Template Name |
||
template_dynamic_service str |
Dynamic Service Template (dynamic-service template name) |
||
shared_partition_dynamic_service_template bool |
Reference a dynamic service template from shared partition |
||
template_dynamic_service_shared str |
Dynamic Service Template Name |
||
template_persist_source_ip str |
Source IP persistence (Source IP persistence template name) |
||
shared_partition_persist_source_ip_template bool |
Reference a persist source ip template from shared partition |
||
template_persist_source_ip_shared str |
Source IP Persistence Template Name |
||
template_persist_destination_ip str |
Destination IP persistence (Destination IP persistence template name) |
||
shared_partition_persist_destination_ip_template bool |
Reference a persist destination ip template from shared partition |
||
template_persist_destination_ip_shared str |
Destination IP Persistence Template Name |
||
template_persist_ssl_sid str |
SSL SID persistence (SSL SID persistence template name) |
||
shared_partition_persist_ssl_sid_template bool |
Reference a persist SSL SID template from shared partition |
||
template_persist_ssl_sid_shared str |
SSL SID Persistence Template Name |
||
template_persist_cookie str |
Cookie persistence (Cookie persistence template name) |
||
shared_partition_persist_cookie_template bool |
Reference a persist cookie template from shared partition |
||
template_persist_cookie_shared str |
Cookie Persistence Template Name |
||
template_imap_pop3 str |
IMAP/POP3 Template (IMAP/POP3 Config Name) |
||
shared_partition_imap_pop3_template bool |
Reference a IMAP/POP3 template from shared partition |
||
template_imap_pop3_shared str |
IMAP/POP3 Template Name |
||
template_smtp str |
SMTP Template (SMTP Config Name) |
||
shared_partition_smtp_template bool |
Reference a SMTP template from shared partition |
||
template_smtp_shared str |
SMTP Template Name |
||
template_mqtt str |
MQTT Template (MQTT Config Name) |
||
template_http str |
HTTP Template Name |
||
shared_partition_http_template bool |
Reference a HTTP template from shared partition |
||
template_http_shared str |
HTTP Template Name |
||
template_http_policy str |
http-policy template (http-policy template name) |
||
shared_partition_http_policy_template bool |
Reference a http policy template from shared partition |
||
template_http_policy_shared str |
Http Policy Template Name |
||
redirect_to_https bool |
Redirect HTTP to HTTPS |
||
template_external_service str |
External service template (external-service template name) |
||
shared_partition_external_service_template bool |
Reference a external service template from shared partition |
||
template_external_service_shared str |
External Service Template Name |
||
template_reqmod_icap str |
ICAP reqmod template (reqmod-icap template name) |
||
template_respmod_icap str |
ICAP respmod service template (respmod-icap template name) |
||
template_doh str |
DNS over HTTP(s) Template Name |
||
shared_partition_doh_template bool |
Reference a DNS over HTTP(s) template from shared partition |
||
template_doh_shared str |
DNS over HTTP(s) Template Name |
||
template_server_ssl str |
Server Side SSL Template Name |
||
shared_partition_server_ssl_template bool |
Reference a SSL Server template from shared partition |
||
template_server_ssl_shared str |
Server SSL Template Name |
||
template_client_ssl str |
Client SSL Template Name |
||
shared_partition_client_ssl_template bool |
Reference a Client SSL template from shared partition |
||
template_client_ssl_shared str |
Client SSL Template Name |
||
template_server_ssh str |
Server SSH Template (Server SSH Config Name) |
||
template_client_ssh str |
Client SSH Template (Client SSH Config Name) |
||
template_udp str |
L4 UDP Template |
||
shared_partition_udp bool |
Reference a UDP template from shared partition |
||
template_udp_shared str |
UDP Template Name |
||
template_tcp str |
TCP Template Name |
||
shared_partition_tcp bool |
Reference a tcp template from shared partition |
||
template_tcp_shared str |
TCP Template Name |
||
template_virtual_port str |
Virtual port template (Virtual port template name) |
||
shared_partition_virtual_port_template bool |
Reference a Virtual Port template from shared partition |
||
template_virtual_port_shared str |
Virtual Port Template Name |
||
template_ftp str |
FTP port template (Ftp template name) |
||
template_diameter str |
Diameter Template (diameter template name) |
||
shared_partition_diameter_template bool |
Reference a Diameter template from shared partition |
||
template_diameter_shared str |
Diameter Template Name |
||
template_cache str |
RAM caching template (Cache Template Name) |
||
shared_partition_cache_template bool |
Reference a Cache template from shared partition |
||
template_cache_shared str |
Cache Template Name |
||
template_ram_cache str |
RAM caching template (Cache Template Name) |
||
template_fix str |
FIX template (FIX Template Name) |
||
shared_partition_fix_template bool |
Reference a FIX template from shared partition |
||
template_fix_shared str |
FIX Template Name |
||
waf_template str |
WAF template (WAF Template Name) |
||
template_ssli str |
SSLi template (SSLi Template Name) |
||
template_tcp_proxy_client str |
TCP Proxy Config Client (TCP Proxy Config name) |
||
template_tcp_proxy_server str |
TCP Proxy Config Server (TCP Proxy Config name) |
||
template_tcp_proxy str |
TCP Proxy Template Name |
||
shared_partition_tcp_proxy_template bool |
Reference a TCP Proxy template from shared partition |
||
template_tcp_proxy_shared str |
TCP Proxy Template name |
||
use_default_if_no_server bool |
Use default forwarding if server selection failed |
||
template_scaleout str |
Scaleout template (Scaleout template name) |
||
no_dest_nat bool |
Disable destination NAT, this option only supports in wildcard VIP or when a connection is operated in SSLi + EP mode |
||
port_translation bool |
Enable port translation under no-dest-nat |
||
l7_hardware_assist bool |
FPGA assist L7 packet parsing |
||
auth_cfg dict |
Field auth_cfg |
||
aaa_policy str |
Specify AAA policy name to bind to the virtual port |
||
cpu_compute bool |
enable cpu compute on virtual port |
||
memory_compute bool |
enable dynamic memory compute on virtual port |
||
substitute_source_mac bool |
Substitute Source MAC Address to that of the outgoing interface |
||
ignore_global bool |
Ignore global substitute-source-mac |
||
aflex_table_entry_syn_disable bool |
Disable aFlex entry sync for this port |
||
aflex_table_entry_syn_enable bool |
Enable aFlex entry sync for this port |
||
gtp_session_lb bool |
Enable GTP Session Load Balancing |
||
reply_acme_challenge bool |
Reply ACME http-01 challenge. This option only takes effect in HTTP port 80 |
||
resolve_web_cat_list str |
Web Category List name |
||
uuid str |
uuid of the object |
||
user_tag str |
Customized tag |
||
sampling_enable list |
Field sampling_enable |
||
counters1 str |
‘all’= all; ‘curr_conn’= Current established connections; ‘total_l4_conn’= Total L4 connections established; ‘total_l7_conn’= Total L7 connections established; ‘total_tcp_conn’= Total TCP connections established; ‘total_conn’= Total connections established; ‘total_fwd_bytes’= Bytes processed in forward direction; ‘total_fwd_pkts’= Packets processed in forward direction; ‘total_rev_bytes’= Bytes processed in reverse direction; ‘total_rev_pkts’= Packets processed in reverse direction; ‘total_dns_pkts’= Total DNS packets processed; ‘total_mf_dns_pkts’= Total MF DNS packets; ‘es_total_failure_actions’= Total failure actions; ‘compression_bytes_before’= Data into compression engine; ‘compression_bytes_after’= Data out of compression engine; ‘compression_hit’= Number of requests compressed; ‘compression_miss’= Number of requests NOT compressed; ‘compression_miss_no_client’= Compression miss no client; ‘compression_miss_template_exclusion’= Compression miss template exclusion; ‘curr_req’= Current requests; ‘total_req’= Total requests; ‘total_req_succ’= Total successful requests; ‘peak_conn’= Peak connections; ‘curr_conn_rate’= Current connection rate; ‘last_rsp_time’= Last response time; ‘fastest_rsp_time’= Fastest response time; ‘slowest_rsp_time’= Slowest response time; ‘loc_permit’= Geo-location Permit count; ‘loc_deny’= Geo-location Deny count; ‘loc_conn’= Geo-location Connection count; ‘curr_ssl_conn’= Current SSL connections; ‘total_ssl_conn’= Total SSL connections; ‘backend-time-to-first- byte’= Backend Time from Request to Response First Byte; ‘backend-time-to-last- byte’= Backend Time from Request to Response Last Byte; ‘in-latency’= Request Latency at Thunder; ‘out-latency’= Response Latency at Thunder; ‘total_fwd_bytes_out’= Bytes processed in forward direction (outbound); ‘total_fwd_pkts_out’= Packets processed in forward direction (outbound); ‘total_rev_bytes_out’= Bytes processed in reverse direction (outbound); ‘total_rev_pkts_out’= Packets processed in reverse direction (outbound); ‘curr_req_rate’= Current request rate; ‘curr_resp’= Current response; ‘total_resp’= Total response; ‘total_resp_succ’= Total successful responses; ‘curr_resp_rate’= Current response rate; ‘dnsrrl_total_allowed’= DNS Response- Rate-Limiting Total Responses Allowed; ‘dnsrrl_total_dropped’= DNS Response- Rate-Limiting Total Responses Dropped; ‘dnsrrl_total_slipped’= DNS Response- Rate-Limiting Total Responses Slipped; ‘dnsrrl_bad_fqdn’= DNS Response-Rate- Limiting Bad FQDN; ‘throughput-bits-per-sec’= Throughput in bits/sec; ‘dynamic- memory-alloc’= dynamic memory (bytes) allocated by the vport; ‘dynamic-memory- free’= dynamic memory (bytes) allocated by the vport; ‘dynamic-memory’= dynamic memory (bytes) used by the vport(alloc-free); ‘ip_only_lb_fwd_bytes’= IP-Only- LB Bytes processed in forward direction; ‘ip_only_lb_rev_bytes’= IP-Only-LB Bytes processed in reverse direction; ‘ip_only_lb_fwd_pkts’= IP-Only-LB Packets processed in forward direction; ‘ip_only_lb_rev_pkts’= IP-Only-LB Packets processed in reverse direction; ‘total_dns_filter_type_drop’= Total DNS Filter Type Drop; ‘total_dns_filter_class_drop’= Total DNS Filter Class Drop; ‘dns_filter_type_a_drop’= DNS Filter Type A Drop; ‘dns_filter_type_aaaa_drop’= DNS Filter Type AAAA Drop; ‘dns_filter_type_cname_drop’= DNS Filter Type CNAME Drop; ‘dns_filter_type_mx_drop’= DNS Filter Type MX Drop; ‘dns_filter_type_ns_drop’= DNS Filter Type NS Drop; ‘dns_filter_type_srv_drop’= DNS Filter Type SRV Drop; ‘dns_filter_type_ptr_drop’= DNS Filter Type PTR Drop; ‘dns_filter_type_soa_drop’= DNS Filter Type SOA Drop; ‘dns_filter_type_txt_drop’= DNS Filter Type TXT Drop; ‘dns_filter_type_any_drop’= DNS Filter Type Any Drop; ‘dns_filter_type_others_drop’= DNS Filter Type OTHERS Drop; ‘dns_filter_class_internet_drop’= DNS Filter Class INTERNET Drop; ‘dns_filter_class_chaos_drop’= DNS Filter Class CHAOS Drop; ‘dns_filter_class_hesiod_drop’= DNS Filter Class HESIOD Drop; ‘dns_filter_class_none_drop’= DNS Filter Class NONE Drop; ‘dns_filter_class_any_drop’= DNS Filter Class ANY Drop; ‘dns_filter_class_others_drop’= DNS Filter Class OTHERS Drop; ‘dns_rpz_action_drop’= DNS RPZ Action Drop; ‘dns_rpz_action_pass_thru’= DNS RPZ Action Pass Through; ‘dns_rpz_action_tcp_only’= DNS RPZ Action TCP Only; ‘dns_rpz_action_nxdomain’= DNS RPZ Action NXDOMAIN; ‘dns_rpz_action_nodata’= DNS RPZ Action NODATA; ‘dns_rpz_action_local_data’= DNS RPZ Action Local Data; ‘dns_rpz_trigger_client_ip’= DNS RPZ Trigger Client IP; ‘dns_rpz_trigger_resp_ip’= DNS RPZ Trigger Response IP; ‘dns_rpz_trigger_ns_ip’= DNS RPZ Trigger NS IP; ‘dns_rpz_trigger_qname’= DNS RPZ Trigger Qname IP; ‘dns_rpz_trigger_ns_name’= DNS RPZ Trigger NS Name; ‘http1_client_idle_timeout’= HTTP1 Client Idle Timeout; ‘http2_client_idle_timeout’= HTTP2 Client Idle Timeout; ‘dnsrrl_total_tc’= DNS Response-Rate-Limiting Total Responses Replied With Truncated; |
||
packet_capture_template str |
Name of the packet capture template to be bind with this object |
||
oper dict |
Field oper |
||
state str |
Field state |
||
real_curr_conn int |
Field real_curr_conn |
||
int_curr_conn int |
Field int_curr_conn |
||
curr_conn_overflow int |
Field curr_conn_overflow |
||
loc_list str |
Field loc_list |
||
geo_location str |
Field geo_location |
||
level_str str |
Field level_str |
||
group_id int |
Field group_id |
||
loc_max_depth int |
Field loc_max_depth |
||
loc_success int |
Field loc_success |
||
loc_error int |
Field loc_error |
||
loc_override int |
Field loc_override |
||
loc_last str |
Field loc_last |
||
http_hits_list list |
Field http_hits_list |
||
http_vport_cpu_list list |
Field http_vport_cpu_list |
||
cpu_count int |
Field cpu_count |
||
http_host_hits bool |
Field http_host_hits |
||
http_url_hits bool |
Field http_url_hits |
||
http_vport bool |
Field http_vport |
||
clear_curr_conn bool |
Field clear_curr_conn |
||
port_number int |
Port |
||
protocol str |
‘tcp’= TCP LB service; ‘udp’= UDP Port; ‘others’= for no tcp/udp protocol, do IP load balancing; ‘diameter’= diameter port; ‘dns-tcp’= DNS service over TCP; ‘dns-udp’= DNS service over UDP; ‘fast-http’= Fast HTTP Port; ‘fix’= FIX Port; ‘ftp’= File Transfer Protocol Port; ‘ftp-proxy’= ftp proxy port; ‘http’= HTTP Port; ‘https’= HTTPS port; ‘imap’= imap proxy port; ‘mlb’= Message based load balancing; ‘mms’= Microsoft Multimedia Service Port; ‘mysql’= mssql port; ‘mssql’= mssql; ‘pop3’= pop3 proxy port; ‘radius’= RADIUS Port; ‘rtsp’= Real Time Streaming Protocol Port; ‘sip’= Session initiation protocol over UDP; ‘sip-tcp’= Session initiation protocol over TCP; ‘sips’= Session initiation protocol over TLS; ‘smpp-tcp’= SMPP service over TCP; ‘spdy’= spdy port; ‘spdys’= spdys port; ‘smtp’= SMTP Port; ‘mqtt’= MQTT Port; ‘mqtts’= MQTTS Port; ‘ssl-proxy’= Generic SSL proxy; ‘ssli’= SSL insight; ‘ssh’= SSH Port; ‘tcp- proxy’= Generic TCP proxy; ‘tftp’= TFTP Port; ‘fast-fix’= Fast FIX port; |
||
stats dict |
Field stats |
||
curr_conn str |
Current established connections |
||
total_l4_conn str |
Total L4 connections established |
||
total_l7_conn str |
Total L7 connections established |
||
total_tcp_conn str |
Total TCP connections established |
||
total_conn str |
Total connections established |
||
total_fwd_bytes str |
Bytes processed in forward direction |
||
total_fwd_pkts str |
Packets processed in forward direction |
||
total_rev_bytes str |
Bytes processed in reverse direction |
||
total_rev_pkts str |
Packets processed in reverse direction |
||
total_dns_pkts str |
Total DNS packets processed |
||
total_mf_dns_pkts str |
Total MF DNS packets |
||
es_total_failure_actions str |
Total failure actions |
||
compression_bytes_before str |
Data into compression engine |
||
compression_bytes_after str |
Data out of compression engine |
||
compression_hit str |
Number of requests compressed |
||
compression_miss str |
Number of requests NOT compressed |
||
compression_miss_no_client str |
Compression miss no client |
||
compression_miss_template_exclusion str |
Compression miss template exclusion |
||
curr_req str |
Current requests |
||
total_req str |
Total requests |
||
total_req_succ str |
Total successful requests |
||
peak_conn str |
Peak connections |
||
curr_conn_rate str |
Current connection rate |
||
last_rsp_time str |
Last response time |
||
fastest_rsp_time str |
Fastest response time |
||
slowest_rsp_time str |
Slowest response time |
||
loc_permit str |
Geo-location Permit count |
||
loc_deny str |
Geo-location Deny count |
||
loc_conn str |
Geo-location Connection count |
||
curr_ssl_conn str |
Current SSL connections |
||
total_ssl_conn str |
Total SSL connections |
||
backend_time_to_first_byte str |
Backend Time from Request to Response First Byte |
||
backend_time_to_last_byte str |
Backend Time from Request to Response Last Byte |
||
in_latency str |
Request Latency at Thunder |
||
out_latency str |
Response Latency at Thunder |
||
total_fwd_bytes_out str |
Bytes processed in forward direction (outbound) |
||
total_fwd_pkts_out str |
Packets processed in forward direction (outbound) |
||
total_rev_bytes_out str |
Bytes processed in reverse direction (outbound) |
||
total_rev_pkts_out str |
Packets processed in reverse direction (outbound) |
||
curr_req_rate str |
Current request rate |
||
curr_resp str |
Current response |
||
total_resp str |
Total response |
||
total_resp_succ str |
Total successful responses |
||
curr_resp_rate str |
Current response rate |
||
dnsrrl_total_allowed str |
DNS Response-Rate-Limiting Total Responses Allowed |
||
dnsrrl_total_dropped str |
DNS Response-Rate-Limiting Total Responses Dropped |
||
dnsrrl_total_slipped str |
DNS Response-Rate-Limiting Total Responses Slipped |
||
dnsrrl_bad_fqdn str |
DNS Response-Rate-Limiting Bad FQDN |
||
throughput_bits_per_sec str |
Throughput in bits/sec |
||
dynamic_memory str |
dynamic memory (bytes) used by the vport(alloc-free) |
||
ip_only_lb_fwd_bytes str |
IP-Only-LB Bytes processed in forward direction |
||
ip_only_lb_rev_bytes str |
IP-Only-LB Bytes processed in reverse direction |
||
ip_only_lb_fwd_pkts str |
IP-Only-LB Packets processed in forward direction |
||
ip_only_lb_rev_pkts str |
IP-Only-LB Packets processed in reverse direction |
||
total_dns_filter_type_drop str |
Total DNS Filter Type Drop |
||
total_dns_filter_class_drop str |
Total DNS Filter Class Drop |
||
dns_filter_type_a_drop str |
DNS Filter Type A Drop |
||
dns_filter_type_aaaa_drop str |
DNS Filter Type AAAA Drop |
||
dns_filter_type_cname_drop str |
DNS Filter Type CNAME Drop |
||
dns_filter_type_mx_drop str |
DNS Filter Type MX Drop |
||
dns_filter_type_ns_drop str |
DNS Filter Type NS Drop |
||
dns_filter_type_srv_drop str |
DNS Filter Type SRV Drop |
||
dns_filter_type_ptr_drop str |
DNS Filter Type PTR Drop |
||
dns_filter_type_soa_drop str |
DNS Filter Type SOA Drop |
||
dns_filter_type_txt_drop str |
DNS Filter Type TXT Drop |
||
dns_filter_type_any_drop str |
DNS Filter Type Any Drop |
||
dns_filter_type_others_drop str |
DNS Filter Type OTHERS Drop |
||
dns_filter_class_internet_drop str |
DNS Filter Class INTERNET Drop |
||
dns_filter_class_chaos_drop str |
DNS Filter Class CHAOS Drop |
||
dns_filter_class_hesiod_drop str |
DNS Filter Class HESIOD Drop |
||
dns_filter_class_none_drop str |
DNS Filter Class NONE Drop |
||
dns_filter_class_any_drop str |
DNS Filter Class ANY Drop |
||
dns_filter_class_others_drop str |
DNS Filter Class OTHERS Drop |
||
dns_rpz_action_drop str |
DNS RPZ Action Drop |
||
dns_rpz_action_pass_thru str |
DNS RPZ Action Pass Through |
||
dns_rpz_action_tcp_only str |
DNS RPZ Action TCP Only |
||
dns_rpz_action_nxdomain str |
DNS RPZ Action NXDOMAIN |
||
dns_rpz_action_nodata str |
DNS RPZ Action NODATA |
||
dns_rpz_action_local_data str |
DNS RPZ Action Local Data |
||
dns_rpz_trigger_client_ip str |
DNS RPZ Trigger Client IP |
||
dns_rpz_trigger_resp_ip str |
DNS RPZ Trigger Response IP |
||
dns_rpz_trigger_ns_ip str |
DNS RPZ Trigger NS IP |
||
dns_rpz_trigger_qname str |
DNS RPZ Trigger Qname IP |
||
dns_rpz_trigger_ns_name str |
DNS RPZ Trigger NS Name |
||
http1_client_idle_timeout str |
HTTP1 Client Idle Timeout |
||
http2_client_idle_timeout str |
HTTP2 Client Idle Timeout |
||
dnsrrl_total_tc str |
DNS Response-Rate-Limiting Total Responses Replied With Truncated |
||
port_number int |
Port |
||
protocol str |
‘tcp’= TCP LB service; ‘udp’= UDP Port; ‘others’= for no tcp/udp protocol, do IP load balancing; ‘diameter’= diameter port; ‘dns-tcp’= DNS service over TCP; ‘dns-udp’= DNS service over UDP; ‘fast-http’= Fast HTTP Port; ‘fix’= FIX Port; ‘ftp’= File Transfer Protocol Port; ‘ftp-proxy’= ftp proxy port; ‘http’= HTTP Port; ‘https’= HTTPS port; ‘imap’= imap proxy port; ‘mlb’= Message based load balancing; ‘mms’= Microsoft Multimedia Service Port; ‘mysql’= mssql port; ‘mssql’= mssql; ‘pop3’= pop3 proxy port; ‘radius’= RADIUS Port; ‘rtsp’= Real Time Streaming Protocol Port; ‘sip’= Session initiation protocol over UDP; ‘sip-tcp’= Session initiation protocol over TCP; ‘sips’= Session initiation protocol over TLS; ‘smpp-tcp’= SMPP service over TCP; ‘spdy’= spdy port; ‘spdys’= spdys port; ‘smtp’= SMTP Port; ‘mqtt’= MQTT Port; ‘mqtts’= MQTTS Port; ‘ssl-proxy’= Generic SSL proxy; ‘ssli’= SSL insight; ‘ssh’= SSH Port; ‘tcp- proxy’= Generic TCP proxy; ‘tftp’= TFTP Port; ‘fast-fix’= Fast FIX port; |
||
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.