a10_slb_virtual_server
Synopsis
Create a Virtual Server
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 |
||
name str/required |
SLB Virtual Server Name |
||
ipv6_address str |
IPV6 address |
||
ip_address str |
IP Address |
||
netmask str |
IP subnet mask |
||
ipv6_acl str |
ipv6 acl name |
||
ipv6_acl_shared str |
ipv6 acl name |
||
acl_id int |
acl id |
||
acl_name str |
Access List name (IPv4 Access List Name) |
||
acl_id_shared int |
acl id |
||
acl_name_shared str |
Access List name (IPv4 Access List Name) |
||
use_if_ip bool |
Use Interface IP |
||
ethernet str |
Ethernet interface |
||
description str |
Create a description for VIP |
||
enable_disable_action str |
‘enable’= Enable Virtual Server (default); ‘disable’= Disable Virtual Server; ‘disable-when-all-ports-down’= Disable Virtual Server when all member ports are down; ‘disable-when-any-port-down’= Disable Virtual Server when any member port is down; |
||
redistribution_flagged bool |
Flag VIP for special redistribution handling |
||
vport_disable_action str |
‘drop-packet’= Drop packet for disabled virtual-port; |
||
suppress_internal_loopback bool |
Suppress VIP internal loopback programming |
||
arp_disable bool |
Disable Respond to Virtual Server ARP request |
||
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 |
||
template_virtual_server str |
Virtual server template (Virtual server template name) |
||
shared_partition_vs_template bool |
Reference a virtual-server template from shared partition |
||
template_virtual_server_shared str |
Virtual-Server Template Name |
||
template_logging str |
NAT Logging template (NAT Logging template name) |
||
template_scaleout str |
Scaleout template (Scaleout template name) |
||
stats_data_action str |
‘stats-data-enable’= Enable statistical data collection for virtual server; ‘stats-data-disable’= Disable statistical data collection for virtual server; |
||
extended_stats bool |
Enable extended statistics on virtual server |
||
vrid int |
Join a vrrp group (Specify ha VRRP-A vrid) |
||
disable_vip_adv bool |
Disable virtual server GARP |
||
ha_dynamic int |
Dynamic failover based on vip status |
||
redistribute_route_map str |
Route map reference (Name of route-map) |
||
gaming_protocol_compliance bool |
Enable Gaming Protocol Compliance Check |
||
uuid str |
uuid of the object |
||
user_tag str |
Customized tag |
||
migrate_vip dict |
Field migrate_vip |
||
target_data_cpu int |
Number of CPUs on the target platform |
||
target_floating_ipv4 str |
Specify IP address |
||
target_floating_ipv6 str |
Specify IPv6 address |
||
cancel_migration bool |
Cancel migration |
||
finish_migration bool |
Complete the migration |
||
uuid str |
uuid of the object |
||
port_list list |
Field port_list |
||
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; ‘http- over-quic’= HTTP3-over-quic 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 |
||
when_server_selection_failed str |
‘send-504’= Stay functional up and response with HTTP 504; |
||
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 |
||
showtech_print_extended_stats bool |
Enable print extended stats in showtech |
||
expand bool |
expand syn-cookie with timestamp and wscale |
||
attack_detection bool |
Enable analytics |
||
acl_list list |
Field acl_list |
||
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 |
||
no_auto_up_on_aflex bool |
Don’t automatically mark vport up when aFleX is bound |
||
enable_scaleout bool |
Field enable_scaleout |
||
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 |
||
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 |
||
template_quic_client str |
QUIC Config Client (QUIC Config name) |
||
template_quic_server str |
QUIC Config Server (QUIC Config name) |
||
template_quic str |
QUIC Template Name |
||
shared_partition_quic_template bool |
Reference a QUIC template from shared partition |
||
template_quic_shared str |
QUIC 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 |
||
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 |
||
ng_waf bool |
Next-gen WAF |
||
fast_dns_cache str |
‘force-enable’= Always enable; ‘force-disable’= Always disable; ‘depends-on- config’= Depends on configurations; |
||
fast_path str |
‘force’= Force fast path in SLB processing; ‘disable’= Disable fast path in SLB processing; |
||
uuid str |
uuid of the object |
||
user_tag str |
Customized tag |
||
sampling_enable list |
Field sampling_enable |
||
packet_capture_template str |
Name of the packet capture template to be bind with this object |
||
oper dict |
Field oper |
||
mac str |
Field mac |
||
state str |
Field state |
||
curr_conn_rate int |
Field curr_conn_rate |
||
conn_rate_unit str |
Field conn_rate_unit |
||
curr_icmp_rate int |
Field curr_icmp_rate |
||
icmp_lockup_time_left int |
Field icmp_lockup_time_left |
||
icmp_rate_over_limit_drop int |
Field icmp_rate_over_limit_drop |
||
curr_icmpv6_rate int |
Field curr_icmpv6_rate |
||
icmpv6_lockup_time_left int |
Field icmpv6_lockup_time_left |
||
icmpv6_rate_over_limit_drop int |
Field icmpv6_rate_over_limit_drop |
||
migration_status str |
Field migration_status |
||
peak_conn int |
Field peak_conn |
||
ip_address str |
Field ip_address |
||
ipv6_address str |
Field ipv6_address |
||
curr_conn_overflow int |
Field curr_conn_overflow |
||
ip_only_lb_fwd_bytes int |
Field ip_only_lb_fwd_bytes |
||
ip_only_lb_rev_bytes int |
Field ip_only_lb_rev_bytes |
||
ip_only_lb_fwd_pkts int |
Field ip_only_lb_fwd_pkts |
||
ip_only_lb_rev_pkts int |
Field ip_only_lb_rev_pkts |
||
name str |
SLB Virtual Server Name |
||
migrate_vip dict |
Field migrate_vip |
||
port_list list |
Field port_list |
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.