slb virtual-server¶
Create a Virtual Server
virtual-server Specification¶
Parameter Value Type Collection Object Key(s) name Collection Name virtual-server-list Collection URI /axapi/v3/slb/virtual-server Element Name virtual-server Element URI /axapi/v3/slb/virtual-server/{name} Element Attributes virtual-server_attributes Partition Visibility shared Operational Data URI /axapi/v3/slb/virtual-server/{name}/oper Schema virtual-server schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/slb/virtual-server | ||
Create List | POST | /axapi/v3/slb/virtual-server | ||
Get Object | GET | /axapi/v3/slb/virtual-server/{name} | ||
Get List | GET | /axapi/v3/slb/virtual-server | ||
Modify Object | POST | /axapi/v3/slb/virtual-server/{name} | ||
Replace Object | PUT | /axapi/v3/slb/virtual-server/{name} | ||
Replace List | PUT | /axapi/v3/slb/virtual-server | ||
Delete Object | DELETE | /axapi/v3/slb/virtual-server/{name} |
virtual-server-list¶
virtual-server-list is JSON List of virtual-server attributes
virtual-server-list : [
]
virtual-server attributes¶
acl-id
Description acl id
Type: number
Range: 1-199
Mutual Exclusion: acl-id,acl-name, p-acl, and shared-partition-acl are mutually exclusive
Reference Object: /axapi/v3/access-list/standard
acl-id-shared
Description acl id
Type: number
Range: 1-199
Mutual Exclusion: acl-id-shared and acl-name-shared are mutually exclusive
Reference Object: /axapi/v3/access-list/standard
acl-name
Description Access List name (IPv4 Access List Name)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
Mutual Exclusion: acl-name,acl-id, p-acl, and shared-partition-acl are mutually exclusive
Reference Object: /axapi/v3/ip/access-list
acl-name-shared
Description Access List name (IPv4 Access List Name)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
Mutual Exclusion: acl-name-shared and acl-id-shared are mutually exclusive
Reference Object: /axapi/v3/ip/access-list
arp-disable
Description Disable Respond to Virtual Server ARP request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
description
Description Create a description for VIP
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
disable-vip-adv
Description Disable virtual server GARP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable-disable-action
Description ‘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;
Type: string
Supported Values: enable, disable, disable-when-all-ports-down, disable-when-any-port-down
Default: enable
ethernet
Description Ethernet interface
Type: number
Format: interface
extended-stats
Description Enable extended statistics on virtual server
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ha-dynamic
Description Dynamic failover based on vip status
Type: number
Range: 1-255
ip-address
Description IP Address
Type: string
Format: ipv4-address
Mutual Exclusion: ip-address, ipv6-address, and use-if-ip are mutually exclusive
ipv6-acl
Description ipv6 acl name
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
Mutual Exclusion: ipv6-acl, p-ipv6-acl, and shared-partition-ipv6-acl are mutually exclusive
Reference Object: /axapi/v3/ipv6/access-list
ipv6-acl-shared
Description ipv6 acl name
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/ipv6/access-list
ipv6-address
Description IPV6 address
Type: string
Format: ipv6-address
Mutual Exclusion: ipv6-address, ip-address, and use-if-ip are mutually exclusive
migrate-vip
Description: migrate-vip is a JSON Block. Please see below for migrate-vip
Type: Object
Reference Object: /axapi/v3/slb/virtual-server/{name}/migrate-vip
name
Description SLB Virtual Server Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
netmask
Description IP subnet mask
Type: string
Format: ipv4-netmask-brief
port-list
Type: List
Reference Object: /axapi/v3/slb/virtual-server/{name}/port/{port-number}+{protocol}
redistribute-route-map
Description Route map reference (Name of route-map)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
redistribution-flagged
Description Flag VIP for special redistribution handling
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
shared-partition-policy-template
Description Reference a policy template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-policy-template and template-policy are mutually exclusive
shared-partition-vs-template
Description Reference a virtual-server template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-vs-template and template-virtual-server are mutually exclusive
stats-data-action
Description ‘stats-data-enable’: Enable statistical data collection for virtual server; ‘stats-data-disable’: Disable statistical data collection for virtual server;
Type: string
Supported Values: stats-data-enable, stats-data-disable
Default: stats-data-enable
suppress-internal-loopback
Description Suppress VIP internal loopback programming
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
template-logging
Description NAT Logging template (NAT Logging template name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/ip/nat/template/logging
template-policy
Description Policy template (Policy template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-policy and shared-partition-policy-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/policy
template-policy-shared
Description Policy Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/policy
template-scaleout
Description Scaleout template (Scaleout template name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
template-virtual-server
Description Virtual server template (Virtual server template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-virtual-server and shared-partition-vs-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/virtual-server
template-virtual-server-shared
Description Virtual-Server Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/virtual-server
use-if-ip
Description Use Interface IP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: use-if-ip, ipv6-address, and ip-address are mutually exclusive
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vport-disable-action
Description ‘drop-packet’: Drop packet for disabled virtual-port;
Type: string
Supported Values: drop-packet
vrid
Description Join a vrrp group (Specify ha VRRP-A vrid)
Type: number
Range: 1-31
port-list¶
Specification Value Type list Block object keys acl-list
Type: Listaction
Description ‘enable’: Enable; ‘disable’: Disable;
Type: string
Supported Values: enable, disable
Default: enable
aflex-scripts
Type: Listaflex-table-entry-syn-disable
Description Disable aFlex entry sync for this port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: aflex-table-entry-syn-disable and aflex-table-entry-syn-enable are mutually exclusive
aflex-table-entry-syn-enable
Description Enable aFlex entry sync for this port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: aflex-table-entry-syn-enable and aflex-table-entry-syn-disable are mutually exclusive
alt-protocol1
Description ‘http’: HTTP Port;
Type: string
Supported Values: http
alt-protocol2
Description ‘tcp’: TCP LB service;
Type: string
Supported Values: tcp
alternate-port
Description Alternate Virtual Port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: alternate-port and range are mutually exclusive
alternate-port-number
Description Virtual Port
Type: number
Range: 0-65534
attack-detection
Description Enable analytics
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
auth-cfg
Description: auth-cfg is a JSON Block. Please see below for port-list_auth-cfg
Type: Object
auto
Description Configure auto NAT for the vport
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
clientip-sticky-nat
Description Prefer to use same source NAT address for a client
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
conn-limit
Description Connection Limit
Type: number
Range: 1-64000000
Default: 64000000
cpu-compute
Description enable cpu compute on virtual port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
def-selection-if-pref-failed
Description ‘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;
Type: string
Supported Values: def-selection-if-pref-failed, def-selection-if-pref-failed-disable
Default: def-selection-if-pref-failed
enable-playerid-check
Description Enable playerid checks on UDP packets once the AX is in active mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable-scaleout
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
eth-fwd
Description Ethernet interface number
Type: number
Format: interface
Mutual Exclusion: eth-fwd and trunk-fwd are mutually exclusive
eth-rev
Description Ethernet interface number
Type: number
Format: interface
Mutual Exclusion: eth-rev and trunk-rev are mutually exclusive
expand
Description expand syn-cookie with timestamp and wscale
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
extended-stats
Description Enable extended statistics on virtual port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
force-routing-mode
Description Force routing mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gslb-enable
Description Enable Global Server Load Balancing
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
gtp-session-lb
Description Enable GTP Session Load Balancing
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ha-conn-mirror
Description Enable for HA Conn sync
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ignore-global
Description Ignore global substitute-source-mac
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ip-map-list
Description Enter name of IP Map List to be bound (IP Map List Name)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
ip-only-lb
Description Enable IP-Only LB mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ip-smart-rr
Description Use IP address round-robin behavior
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipinip
Description Enable IP in IP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
l7-hardware-assist
Description FPGA assist L7 packet parsing
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
l7-service-chain
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
memory-compute
Description enable dynamic memory compute on virtual port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
message-switching
Description Message switching
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
name
Description SLB Virtual Service Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
no-auto-up-on-aflex
Description Don’t automatically mark vport up when aFleX is bound
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
no-dest-nat
Description Disable destination NAT, this option only supports in wildcard VIP or when a connection is operated in SSLi + EP mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
no-logging
Description Do not log connection over limit event
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
on-syn
Description Enable for HA Conn sync for l4 tcp sessions on SYN
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
one-server-conn
Description Support server that allow only one connection
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
optimization-level
Description ‘0’: No optimization; ‘1’: Optimization level 1 (Experimental);
Type: string
Supported Values: 0, 1
Default: 0
p-template-sip-shared
Description SIP Template Name
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: p-template-sip-shared and template-sip are mutually exclusive
packet-capture-template
Description Name of the packet capture template to be bind with this object
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/visibility/packet-capture/object-templates/slb-vport-tmpl
persist-type
Description ‘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;
Type: string
Supported Values: src-dst-ip-swap-persist, use-src-ip-for-dst-persist, use-dst-ip-for-src-persist
pool
Description Specify NAT pool or pool group
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: pool and shared-partition-pool are mutually exclusive
Reference Object: /axapi/v3/ip/nat/pool
pool-shared
Description Specify NAT pool or pool group
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/ip/nat/pool
port-number
Description Port
Type: number
Range: 0-65534
port-translation
Description Enable port translation under no-dest-nat
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
precedence
Description Set auto NAT pool as higher precedence for source NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
protocol
Description ‘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;
Type: string
Supported Values: tcp, udp, others, diameter, dns-tcp, dns-udp, fast-http, fix, ftp, ftp-proxy, http, https, imap, mlb, mms, mysql, mssql, pop3, radius, rtsp, sip, sip-tcp, sips, smpp-tcp, spdy, spdys, smtp, mqtt, mqtts, ssl-proxy, ssli, ssh, tcp-proxy, tftp, fast-fix
proxy-layer
Description ‘v1’: Force using old proxy; ‘v2’: Force using new proxy;
Type: string
Supported Values: v1, v2
range
Description Virtual Port range (Virtual Port range value)
Type: number
Range: 0-254
Default: 0
Mutual Exclusion: range and alternate-port are mutually exclusive
rate
Description Specify the log message rate
Type: number
Range: 0-2147483647
redirect-to-https
Description Redirect HTTP to HTTPS
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
reply-acme-challenge
Description Reply ACME http-01 challenge. This option only takes effect in HTTP port 80
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
req-fail
Description Use alternate virtual port when L7 request fail
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
reselection
Description ‘disable’: disable;
Type: string
Supported Values: disable
reset
Description Send client reset when connection number over limit
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
reset-on-server-selection-fail
Description Send client reset when server selection fails
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
resolve-web-cat-list
Description Web Category List name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/web-category/category-list
rtp-sip-call-id-match
Description rtp traffic try to match the real server of sip smp call-id session
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sampling-enable
Type: Listscaleout-bucket-count
Description Number of traffic buckets
Type: number
Range: 1-256
Default: 32
scaleout-device-group
Description Device group id
Type: number
Range: 1-16
secs
Description Specify the interval in seconds
Type: number
Range: 1-100
serv-sel-fail
Description Use alternate virtual port when server selection failure
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-group
Description Bind a use-rcv-hop-for-resp Server Group to this Virtual Server (Server Group Name)
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/server-group
service-group
Description Bind a Service Group to this Virtual Server (Service Group Name)
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/service-group
shared-partition-cache-template
Description Reference a Cache template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-cache-template and template-cache are mutually exclusive
shared-partition-client-ssl-template
Description Reference a Client SSL template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-client-ssl-template and template-client-ssl are mutually exclusive
shared-partition-connection-reuse-template
Description Reference a connection reuse template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-connection-reuse-template and template-connection-reuse are mutually exclusive
shared-partition-dblb-template
Description Reference a dblb template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-dblb-template and template-dblb are mutually exclusive
shared-partition-diameter-template
Description Reference a Diameter template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-diameter-template and template-diameter are mutually exclusive
shared-partition-dns-template
Description Reference a dns template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-dns-template and template-dns are mutually exclusive
shared-partition-doh-template
Description Reference a DNS over HTTP(s) template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-doh-template and template-doh are mutually exclusive
shared-partition-dynamic-service-template
Description Reference a dynamic service template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-dynamic-service-template and template-dynamic-service are mutually exclusive
shared-partition-external-service-template
Description Reference a external service template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-external-service-template and template-external-service are mutually exclusive
shared-partition-fix-template
Description Reference a FIX template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-fix-template and template-fix are mutually exclusive
shared-partition-http-policy-template
Description Reference a http policy template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-http-policy-template and template-http-policy are mutually exclusive
shared-partition-http-template
Description Reference a HTTP template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-http-template and template-http are mutually exclusive
shared-partition-imap-pop3-template
Description Reference a IMAP/POP3 template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-imap-pop3-template and template-imap-pop3 are mutually exclusive
shared-partition-persist-cookie-template
Description Reference a persist cookie template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-persist-cookie-template and template-persist-cookie are mutually exclusive
shared-partition-persist-destination-ip-template
Description Reference a persist destination ip template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-persist-destination-ip-template and template-persist-destination-ip are mutually exclusive
shared-partition-persist-source-ip-template
Description Reference a persist source ip template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-persist-source-ip-template and template-persist-source-ip are mutually exclusive
shared-partition-persist-ssl-sid-template
Description Reference a persist SSL SID template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-persist-ssl-sid-template and template-persist-ssl-sid are mutually exclusive
shared-partition-policy-template
Description Reference a policy template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-policy-template and template-policy are mutually exclusive
shared-partition-pool
Description Specify NAT pool or pool group from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-pool and pool are mutually exclusive
shared-partition-server-ssl-template
Description Reference a SSL Server template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-server-ssl-template and template-server-ssl are mutually exclusive
shared-partition-smpp-template
Description Reference a smpp template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-smpp-template and template-smpp are mutually exclusive
shared-partition-smtp-template
Description Reference a SMTP template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-smtp-template and template-smtp are mutually exclusive
shared-partition-tcp
Description Reference a tcp template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-tcp and template-tcp are mutually exclusive
shared-partition-tcp-proxy-template
Description Reference a TCP Proxy template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-tcp-proxy-template and template-tcp-proxy are mutually exclusive
shared-partition-udp
Description Reference a UDP template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-udp and template-udp are mutually exclusive
shared-partition-virtual-port-template
Description Reference a Virtual Port template from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-virtual-port-template and template-virtual-port are mutually exclusive
showtech-print-extended-stats
Description Enable print extended stats in showtech for dns vports
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
skip-rev-hash
Description Skip rev tuple hash insertion
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
snat-on-vip
Description Enable source NAT traffic against VIP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
stats-data-action
Description ‘stats-data-enable’: Enable statistical data collection for virtual port; ‘stats-data-disable’: Disable statistical data collection for virtual port;
Type: string
Supported Values: stats-data-enable, stats-data-disable
Default: stats-data-enable
substitute-source-mac
Description Substitute Source MAC Address to that of the outgoing interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
support-http2
Description Support HTTP2
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
syn-cookie
Description Enable syn-cookie
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
template-cache
Description RAM caching template (Cache Template Name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-cache and shared-partition-cache-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/cache
template-cache-shared
Description Cache Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/cache
template-client-ssh
Description Client SSH Template (Client SSH Config Name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/client-ssh
template-client-ssl
Description Client SSL Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-client-ssl and shared-partition-client-ssl-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/client-ssl
template-client-ssl-shared
Description Client SSL Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/client-ssl
template-connection-reuse
Description Connection Reuse Template (Connection Reuse Template Name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-connection-reuse and shared-partition-connection-reuse-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/connection-reuse
template-connection-reuse-shared
Description Connection Reuse Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/connection-reuse
template-dblb
Description DBLB Template (DBLB template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-dblb and shared-partition-dblb-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/dblb
template-dblb-shared
Description DBLB Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/dblb
template-diameter
Description Diameter Template (diameter template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-diameter and shared-partition-diameter-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/diameter
template-diameter-shared
Description Diameter Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/diameter
template-dns
Description DNS template (DNS template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-dns and shared-partition-dns-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/dns
template-dns-shared
Description DNS Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/dns
template-doh
Description DNS over HTTP(s) Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-doh and shared-partition-doh-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/doh
template-doh-shared
Description DNS over HTTP(s) Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/doh
template-dynamic-service
Description Dynamic Service Template (dynamic-service template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-dynamic-service and shared-partition-dynamic-service-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/dynamic-service
template-dynamic-service-shared
Description Dynamic Service Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/dynamic-service
template-external-service
Description External service template (external-service template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-external-service and shared-partition-external-service-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/external-service
template-external-service-shared
Description External Service Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/external-service
template-fix
Description FIX template (FIX Template Name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-fix and shared-partition-fix-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/fix
template-fix-shared
Description FIX Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/fix
template-ftp
Description FTP port template (Ftp template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/ftp
template-http
Description HTTP Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-http and shared-partition-http-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/http
template-http-policy
Description http-policy template (http-policy template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-http-policy and shared-partition-http-policy-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/http-policy
template-http-policy-shared
Description Http Policy Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/http-policy
template-http-shared
Description HTTP Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/http
template-imap-pop3
Description IMAP/POP3 Template (IMAP/POP3 Config Name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-imap-pop3 and shared-partition-imap-pop3-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/imap-pop3
template-imap-pop3-shared
Description IMAP/POP3 Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/imap-pop3
template-mqtt
Description MQTT Template (MQTT Config Name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/mqtt
template-persist-cookie
Description Cookie persistence (Cookie persistence template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-persist-cookie and shared-partition-persist-cookie-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/persist/cookie
template-persist-cookie-shared
Description Cookie Persistence Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/persist/cookie
template-persist-destination-ip
Description Destination IP persistence (Destination IP persistence template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-persist-destination-ip and shared-partition-persist-destination-ip-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/persist/destination-ip
template-persist-destination-ip-shared
Description Destination IP Persistence Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/persist/destination-ip
template-persist-source-ip
Description Source IP persistence (Source IP persistence template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-persist-source-ip and shared-partition-persist-source-ip-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/persist/source-ip
template-persist-source-ip-shared
Description Source IP Persistence Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/persist/source-ip
template-persist-ssl-sid
Description SSL SID persistence (SSL SID persistence template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-persist-ssl-sid and shared-partition-persist-ssl-sid-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/persist/ssl-sid
template-persist-ssl-sid-shared
Description SSL SID Persistence Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/persist/ssl-sid
template-policy
Description Policy Template (Policy template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-policy and shared-partition-policy-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/policy
template-policy-shared
Description Policy Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/policy
template-ram-cache
Description RAM caching template (Cache Template Name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/cache
template-reqmod-icap
Description ICAP reqmod template (reqmod-icap template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/reqmod-icap
template-respmod-icap
Description ICAP respmod service template (respmod-icap template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/respmod-icap
template-scaleout
Description Scaleout template (Scaleout template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
template-server-ssh
Description Server SSH Template (Server SSH Config Name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/server-ssh
template-server-ssl
Description Server Side SSL Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-server-ssl and shared-partition-server-ssl-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/server-ssl
template-server-ssl-shared
Description Server SSL Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/server-ssl
template-sip
Description SIP Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-sip and p-template-sip-shared are mutually exclusive
Reference Object: /axapi/v3/slb/template/sip
template-sip-shared
Description SIP template
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/sip
template-smpp
Description SMPP template
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-smpp and shared-partition-smpp-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/smpp
template-smpp-shared
Description SMPP Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/smpp
template-smtp
Description SMTP Template (SMTP Config Name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-smtp and shared-partition-smtp-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/smtp
template-smtp-shared
Description SMTP Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/smtp
template-ssli
Description SSLi template (SSLi Template Name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/ssli
template-tcp
Description TCP Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Default: default
Mutual Exclusion: template-tcp and shared-partition-tcp are mutually exclusive
Reference Object: /axapi/v3/slb/template/tcp
template-tcp-proxy
Description TCP Proxy Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: template-tcp-proxy and shared-partition-tcp-proxy-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/tcp-proxy
template-tcp-proxy-client
Description TCP Proxy Config Client (TCP Proxy Config name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/tcp-proxy
template-tcp-proxy-server
Description TCP Proxy Config Server (TCP Proxy Config name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/tcp-proxy
template-tcp-proxy-shared
Description TCP Proxy Template name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/tcp-proxy
template-tcp-shared
Description TCP Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Default: default
Reference Object: /axapi/v3/slb/template/tcp
template-udp
Description L4 UDP Template
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Default: default
Mutual Exclusion: template-udp and shared-partition-udp are mutually exclusive
Reference Object: /axapi/v3/slb/template/udp
template-udp-shared
Description UDP Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Default: default
Reference Object: /axapi/v3/slb/template/udp
template-virtual-port
Description Virtual port template (Virtual port template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Default: default
Mutual Exclusion: template-virtual-port and shared-partition-virtual-port-template are mutually exclusive
Reference Object: /axapi/v3/slb/template/virtual-port
template-virtual-port-shared
Description Virtual Port Template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/virtual-port
trunk-fwd
Description Trunk interface number
Type: number
Format: interface
Mutual Exclusion: trunk-fwd and eth-fwd are mutually exclusive
trunk-rev
Description Trunk interface number
Type: number
Format: interface
Mutual Exclusion: trunk-rev and eth-rev are mutually exclusive
use-alternate-port
Description Use alternate virtual port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
use-cgnv6
Description Follow CGNv6 source NAT configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
use-default-if-no-server
Description Use default forwarding if server selection failed
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
use-rcv-hop-for-resp
Description Use receive hop for response to client(For packets on default-vlan, also config “vlan-global enable-def-vlan-l2-forwarding”.)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
use-rcv-hop-group
Description Set use-rcv-hop group
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
view
Description Specify a GSLB View (ID)
Type: number
Range: 1-31
waf-template
Description WAF template (WAF Template Name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/waf/template
when-down
Description Use alternate virtual port when down
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
when-down-protocol2
Description Use alternate virtual port when down
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
port-list_sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘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;
Type: string
Supported Values: all, curr_conn, total_l4_conn, total_l7_conn, total_tcp_conn, total_conn, total_fwd_bytes, total_fwd_pkts, total_rev_bytes, total_rev_pkts, total_dns_pkts, total_mf_dns_pkts, es_total_failure_actions, compression_bytes_before, compression_bytes_after, compression_hit, compression_miss, compression_miss_no_client, compression_miss_template_exclusion, curr_req, total_req, total_req_succ, peak_conn, curr_conn_rate, last_rsp_time, fastest_rsp_time, slowest_rsp_time, loc_permit, loc_deny, loc_conn, curr_ssl_conn, total_ssl_conn, backend-time-to-first-byte, backend-time-to-last-byte, in-latency, out-latency, total_fwd_bytes_out, total_fwd_pkts_out, total_rev_bytes_out, total_rev_pkts_out, curr_req_rate, curr_resp, total_resp, total_resp_succ, curr_resp_rate, dnsrrl_total_allowed, dnsrrl_total_dropped, dnsrrl_total_slipped, dnsrrl_bad_fqdn, throughput-bits-per-sec, dynamic-memory-alloc, dynamic-memory-free, dynamic-memory, ip_only_lb_fwd_bytes, ip_only_lb_rev_bytes, ip_only_lb_fwd_pkts, ip_only_lb_rev_pkts, total_dns_filter_type_drop, total_dns_filter_class_drop, dns_filter_type_a_drop, dns_filter_type_aaaa_drop, dns_filter_type_cname_drop, dns_filter_type_mx_drop, dns_filter_type_ns_drop, dns_filter_type_srv_drop, dns_filter_type_ptr_drop, dns_filter_type_soa_drop, dns_filter_type_txt_drop, dns_filter_type_any_drop, dns_filter_type_others_drop, dns_filter_class_internet_drop, dns_filter_class_chaos_drop, dns_filter_class_hesiod_drop, dns_filter_class_none_drop, dns_filter_class_any_drop, dns_filter_class_others_drop, dns_rpz_action_drop, dns_rpz_action_pass_thru, dns_rpz_action_tcp_only, dns_rpz_action_nxdomain, dns_rpz_action_nodata, dns_rpz_action_local_data, dns_rpz_trigger_client_ip, dns_rpz_trigger_resp_ip, dns_rpz_trigger_ns_ip, dns_rpz_trigger_qname, dns_rpz_trigger_ns_name, http1_client_idle_timeout, http2_client_idle_timeout, dnsrrl_total_tc
port-list_acl-list¶
Specification Value Type list Block object keys acl-id
Description ACL id VPORT
Type: number
Range: 1-199
Mutual Exclusion: acl-id, p-acl, and shared-partition-acl are mutually exclusive
Reference Object: /axapi/v3/access-list/standard
acl-id-seq-num
Description Specify ACL precedence (sequence-number)
Type: number
Range: 1-32
acl-id-seq-num-shared
Description Specify ACL precedence (sequence-number)
Type: number
Range: 1-32
acl-id-shared
acl-id-src-nat-pool
Description Policy based Source NAT (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: acl-id-src-nat-pool and shared-partition-pool-id are mutually exclusive
Reference Object: /axapi/v3/ip/nat/pool
acl-id-src-nat-pool-shared
Description Policy based Source NAT (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/ip/nat/pool
acl-name
Description Apply an access list name (Named Access List)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/ip/access-list
acl-name-seq-num
Description Specify ACL precedence (sequence-number)
Type: number
Range: 1-32
acl-name-seq-num-shared
Description Specify ACL precedence (sequence-number)
Type: number
Range: 1-32
acl-name-shared
Description Apply an access list name (Named Access List)
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/ip/access-list
acl-name-src-nat-pool
Description Policy based Source NAT (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: acl-name-src-nat-pool, shared-partition-pool-name, and v-shared-partition-pool-name are mutually exclusive
Reference Object: /axapi/v3/ip/nat/pool
acl-name-src-nat-pool-shared
Description Policy based Source NAT (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/ip/nat/pool
shared-partition-pool-id
Description Policy based Source NAT from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-pool-id and acl-id-src-nat-pool are mutually exclusive
shared-partition-pool-name
Description Policy based Source NAT from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared-partition-pool-name and acl-name-src-nat-pool are mutually exclusive
v-acl-id-seq-num
Description Specify ACL precedence (sequence-number)
Type: number
Range: 1-32
v-acl-id-seq-num-shared
Description Specify ACL precedence (sequence-number)
Type: number
Range: 1-32
v-acl-id-src-nat-pool
Description Policy based Source NAT (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: v-acl-id-src-nat-pool and v-shared-partition-pool-id are mutually exclusive
Reference Object: /axapi/v3/ip/nat/pool
v-acl-id-src-nat-pool-shared
Description Policy based Source NAT (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/ip/nat/pool
v-acl-name-seq-num
Description Specify ACL precedence (sequence-number)
Type: number
Range: 1-32
v-acl-name-seq-num-shared
Description Specify ACL precedence (sequence-number)
Type: number
Range: 1-32
v-acl-name-src-nat-pool
Description Policy based Source NAT (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/ip/nat/pool
v-acl-name-src-nat-pool-shared
Description Policy based Source NAT (NAT Pool or Pool Group)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/ip/nat/pool
v-shared-partition-pool-id
Description Policy based Source NAT from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: v-shared-partition-pool-id and v-acl-id-src-nat-pool are mutually exclusive
v-shared-partition-pool-name
Description Policy based Source NAT from shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: v-shared-partition-pool-name and acl-name-src-nat-pool are mutually exclusive
port-list_aflex-scripts¶
Specification Value Type list Block object keys aflex
Description aFleX Script Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
aflex-shared
Description aFleX Script Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port-list_auth-cfg¶
Specification Value Type object aaa-policy
Description Specify AAA policy name to bind to the virtual port
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/aam/aaa-policy
migrate-vip¶
Specification Value Type object cancel-migration
Description Cancel migration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: cancel-migration and finish-migration are mutually exclusive
finish-migration
Description Complete the migration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: finish-migration and cancel-migration are mutually exclusive
target-data-cpu
Description Number of CPUs on the target platform
Type: number
Range: 1-75
target-floating-ipv4
Description Specify IP address
Type: string
Format: ipv4-address
Mutual Exclusion: target-floating-ipv4 and target-floating-ipv6 are mutually exclusive
target-floating-ipv6
Description Specify IPv6 address
Type: string
Format: ipv6-address
Mutual Exclusion: target-floating-ipv6 and target-floating-ipv4 are mutually exclusive
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters