slb virtual-server

Configure SLB virtual servers.

virtual-server Specification

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
Operational Data URI /axapi/v3/slb/virtual-server/{name}/oper
Schema virtual-server schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/slb/virtual-server/

virtual-server Attributes

Create List

POST

/axapi/v3/slb/virtual-server/

virtual-server Attributes

Get Object

GET

/axapi/v3/slb/virtual-server/{name}

virtual-server Attributes

Get List

GET

/axapi/v3/slb/virtual-server/

virtual-server-list

Modify Object

POST

/axapi/v3/slb/virtual-server/{name}

virtual-server Attributes

Replace Object

PUT

/axapi/v3/slb/virtual-server/{name}

virtual-server Attributes

Replace List

PUT

/axapi/v3/slb/virtual-server/

virtual-server-list

Delete Object

DELETE

/axapi/v3/slb/virtual-server/{name}

virtual-server Attributes

Get Oper

GET

/axapi/v3/slb/virtual-server/{name}/oper

operational data

virtual-server-list

virtual-server-list is JSON List of virtual-server Attributes

virtual-server-list : [

virtual-server Attributes

acl-id

Description: IPv4 access list that specifies the VIP addresses that can use this VIP configuration.

Type: number

Range: 1-199

Reference Object: /axapi/v3/access-list/standard

acl-name

Description: Name of an access list that specifies the VIP addresses that can use this VIP configuration.

Type: string

Reference Object: /axapi/v3/ip/access-list

arp-disable

Description: Disable ARP replies from a virtual server

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

description

Description: Add a description to a VIP. The string can contain blanks. Quotation marks are not required.

Type: string

Format: string-rlx

enable-disable-action

Description: Disable a virtual server.

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 collection of peak connection statistics for a virtual server.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-address

Description: Virtual IPv4 address(es) that clients will request.

Type: string

Format: ipv4-address

Mutual Exclusion: ip-address ipv6-address and use-if-ip are mutually exclusive

ipv6-acl

Description: IPv6 access list that specifies the VIP addresses that can use this VIP configuration.

Type: string

Reference Object: /axapi/v3/ipv6/access-list

ipv6-address

Description: Virtual IPv6 address(es) that clients will request.

Type: string

Format: ipv6-address

Mutual Exclusion: ipv6-address ip-address and use-if-ip are mutually exclusive

name

Description: Name to identify the virtual server on the ACOS device.

Type: string

Format: string-rlx

Required: Yes

netmask

Description: Configure a contiguous range of VIPs by entering the starting host address followed by the network mask length.

Type: string

Format: ipv4-netmask-brief

port-list

Description: port-list is a JSON List . Please see below for port-list

Type: List

Reference Object: /axapi/v3/slb/virtual-server/{name}/port/{port-number}+{protocol}

redistribution-flagged

Description: Flag this VIP to selectively enable or disable redistribution of it by OSPF.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

stats-data-action

Description: Disable or enable collection of statistical data for the virtual server.

Type: string

Supported Values: stats-data-enable, stats-data-disable

Default: stats-data-enable

template-logging

Description: Bind a logging template to the virtual server.

Type: string

Reference Object: /axapi/v3/ip/nat/template/logging

template-policy

Description: Bind a PBSLB policy template to the virtual server.

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/policy

template-scaleout

Description: Scaleout template (Scaleout template name)

Type: string

template-virtual-server

Description: Bind a virtual server template to the virtual server.

Type: string

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

uuid

Description: uuid of the object

Type: string

vrid

Description: Join a vrrp group (Specify ha VRRP-A vrid)

Type: number

Range: 1-31

port-list

Specification
Type list
Block object keys

acl-id-list

Description: acl-id-list is a JSON List . Please see below for l215_acl-id-list

Type: List

acl-name-list

Description: acl-name-list is a JSON List . Please see below for l215_acl-name-list

Type: List

action

Description: ‘enable’: Enable; ‘disable’: Disable;

Type: string

Supported Values: enable, disable

Default: enable

aflex-scripts

Description: aflex-scripts is a JSON List . Please see below for l215_aflex-scripts

Type: List

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

auth-cfg

Description: auth-cfg is a JSON Block . Please see below for l215_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-8000000

Default: 8000000

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

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

ha-conn-mirror

Description: Enable for HA Conn sync

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

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

Required: Yes

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

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

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; ‘ssl-proxy’: Generic SSL proxy; ‘ssli’: SSL insight; ‘tcp-proxy’: Generic TCP proxy; ‘tftp’: TFTP 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, ssl-proxy, ssli, tcp-proxy, tftp

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

redirect-to-https

Description: Redirect HTTP to HTTPS

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

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

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

Description: sampling-enable is a JSON List . Please see below for l215_sampling-enable

Type: List

scaleout-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

serv-sel-fail

Description: Use alternate virtual port when server selection failure

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

service-group

Description: Bind a Service Group to this Virtual Server (Service Group Name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/service-group

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

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

Reference Object: /axapi/v3/slb/template/cache

template-client-ssl

Description: Client SSL Template (Client SSL Config Name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/client-ssl

template-connection-reuse

Description: Connection Reuse Template (Connection Reuse Template Name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/connection-reuse

template-dblb

Description: DBLB Template (DBLB template name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/dblb

template-diameter

Description: Diameter Template (diameter template name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/diameter

template-dns

Description: DNS template (DNS template name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/dns

template-dynamic-service

Description: Dynamic Service Template (dynamic-service template name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/dynamic-service

template-external-service

Description: External service template (external-service template name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/external-service

template-fix

Description: FIX template (FIX Template Name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/fix

template-ftp

Description: FTP port template (Ftp template name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/ftp

template-http

Description: HTTP Template (HTTP Config Name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/http

template-http-policy

Description: http-policy template (http-policy template name)

Type: string

Reference Object: /axapi/v3/slb/template/http-policy

template-imap-pop3

Description: IMAP/POP3 Template (IMAP/POP3 Config Name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/imap-pop3

template-persist-cookie

Description: Cookie persistence (Cookie persistence template name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/persist/cookie

template-persist-destination-ip

Description: Destination IP persistence (Destination IP persistence template name)

Type: string

Reference Object: /axapi/v3/slb/template/persist/destination-ip

template-persist-source-ip

Description: Source IP persistence (Source IP persistence template name)

Type: string

Reference Object: /axapi/v3/slb/template/persist/source-ip

template-persist-ssl-sid

Description: SSL session ID persistence (Source IP Persistence Config name)

Type: string

Reference Object: /axapi/v3/slb/template/persist/ssl-sid

template-policy

Description: Policy Template (Policy template name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/policy

template-reqmod-icap

Description: ICAP reqmod template (reqmod-icap template name)

Type: string

Format: string-rlx

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

Reference Object: /axapi/v3/slb/template/respmod-icap

template-scaleout

Description: Scaleout template (Scaleout template name)

Type: string

template-server-ssl

Description: Server Side SSL Template (Server SSL Name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/server-ssl

template-sip

Description: SIP template

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/sip

template-smpp

Description: SMPP template

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/smpp

template-smtp

Description: SMTP Template (SMTP Config Name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/smtp

template-ssli

Description: SSLi template (SSLi Template Name)

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/ssli

template-tcp

Description: L4 TCP Template (TCP Config Name)

Type: string

Format: string-rlx

Default: default

Reference Object: /axapi/v3/slb/template/tcp

template-tcp-proxy

Description: TCP Proxy Template Name

Type: string

Format: string-rlx

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

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

Reference Object: /axapi/v3/slb/template/tcp-proxy

template-udp

Description: L4 UDP Template (UDP Config Name)

Type: string

Format: string-rlx

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

Default: default

Reference Object: /axapi/v3/slb/template/virtual-port

use-alternate-port

Description: Use alternate virtual port

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

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

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

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.acl-name-list

Specification
Type list
Block object keys

acl-name

Description: Apply an access list name (Named Access List)

Type: string

Reference Object: /axapi/v3/ip/access-list

acl-name-seq-num

Description: Specify ACL precedence (sequence-number)

Type: number

Range: 1-32

acl-name-src-nat-pool

Description: Policy based Source NAT (NAT Pool or Pool Group)

Type: string

Reference Object: /axapi/v3/ip/nat/pool

port-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘curr_conn’: Current connections; ‘total_l4_conn’: Total L4 connections; ‘total_l7_conn’: Total L7 connections; ‘total_tcp_conn’: Total TCP connections; ‘total_conn’: Total connections; ‘total_fwd_bytes’: Total forward bytes; ‘total_fwd_pkts’: Total forward packets; ‘total_rev_bytes’: Total reverse bytes; ‘total_rev_pkts’: Total reverse packets; ‘total_dns_pkts’: Total DNS packets; ‘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’: Permit number; ‘loc_deny’: Deny number; ‘loc_conn’: Connection number; ‘curr_ssl_conn’: Current SSL connections; ‘total_ssl_conn’: Total SSL connections;

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

port-list.acl-id-list

Specification
Type list
Block object keys

acl-id

Description: ACL id VPORT

Type: number

Range: 1-199

Reference Object: /axapi/v3/access-list/standard

acl-id-seq-num

Description: Specify ACL precedence (sequence-number)

Type: number

Range: 1-32

acl-id-src-nat-pool

Description: Policy based Source NAT (NAT Pool or Pool Group)

Type: string

Reference Object: /axapi/v3/ip/nat/pool

port-list.aflex-scripts

Specification
Type list
Block object keys

aflex

Description: Bind aFleX Script to the Virtual Port (aFleX Script Name)

Type: string

Format: string-rlx

port-list.auth-cfg

Specification
Type object

aaa-policy

Description: Specify AAA policy name to bind to the virtual port

Type: string

operational data

Name Type Description
conn-rate-unit enum Output contains one of the following values: - 100ms, second
icmpv6-rate-over-limit-drop number icmpv6-rate-over-limit-drop
curr-conn-rate number curr-conn-rate
state enum Output contains one of the following values: - All Up, Functional Up, Partial Up, Down, Disb, Unkn
curr-icmp-rate number curr-icmp-rate
icmpv6-lockup-time-left number icmpv6-lockup-time-left
mac string mac
curr-icmpv6-rate number curr-icmpv6-rate
icmp-rate-over-limit-drop number icmp-rate-over-limit-drop
icmp-lockup-time-left number icmp-lockup-time-left