gslb

Global server load balance commands. Global Server Load Balancing (GSLB) uses Domain Name Service (DNS) technology and extends load balancing to global geographic scale.

GSLB provides the following key advantages:

  • Protects businesses from down time due to site failures
  • Ensures business continuity and applications availability
  • Provides faster performance and improved user experience by directing users to the nearest site
  • Increases data center efficiency and provides a better return on investment by distributing load to multiple sites
  • Provides flexible policies for selecting fairness and distribution to multiple sites

gslb Specification

Type Intermediate Resource
Element Name gslb
Element URI /axapi/v3/gslb
Element Attributes gslb_attributes
Schema gslb schema

Operations Allowed:

Operation Method URI Payload

Get Object

GET

/axapi/v3/gslb

gslb_attributes

gslb Attributes

active-rdt

Description: active-rdt is a JSON Block . Please see below for active-rdt

Type: Object

Reference Object: /axapi/v3/gslb/active-rdt

dns

Description: dns is a JSON Block . Please see below for dns

Type: Object

Reference Object: /axapi/v3/gslb/dns

geo-location-list

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

Type: List

Reference Object: /axapi/v3/gslb/geo-location/{geo-locn-obj-name}

group-list

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

Type: List

Reference Object: /axapi/v3/gslb/group/{name}

ip-list-list

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

Type: List

Reference Object: /axapi/v3/gslb/ip-list/{gslb-ip-list-obj-name}

policy-list

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

Type: List

Reference Object: /axapi/v3/gslb/policy/{name}

protocol

Description: protocol is a JSON Block . Please see below for protocol

Type: Object

Reference Object: /axapi/v3/gslb/protocol

service-group-list

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

Type: List

Reference Object: /axapi/v3/gslb/service-group/{service-group-name}

service-ip-list

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

Type: List

Reference Object: /axapi/v3/gslb/service-ip/{node-name}

site-list

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

Type: List

Reference Object: /axapi/v3/gslb/site/{site-name}

system

Description: system is a JSON Block . Please see below for system

Type: Object

Reference Object: /axapi/v3/gslb/system

template

Description: template is a JSON Block . Please see below for template

Type: Object

Reference Object: /axapi/v3/gslb/template

zone-list

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

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}

protocol

Specification
Type object

auto-detect

Description: Automatically detect SLB Config

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

enable-list

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

Type: List

Reference Object: /axapi/v3/gslb/protocol/enable/{type}

limit

Description: limit is a JSON Block . Please see below for l719_limit

Type: Object

Reference Object: /axapi/v3/gslb/protocol/limit

ping-site

Description: name of site or ip address to ping

Type: string

status-interval

Description: Specify GSLB Message Protocol update period (The GSLB Protocol update interval (seconds), default is 30)

Type: number

Range: 1-1800

use-mgmt-port

Description: Use management port for connections

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

protocol.limit

Specification
Type object

ardt-query

Description: Query Messages of Active RDT, default is 200 (Number)

Type: number

Range: 0-1000000

Default: 200

ardt-response

Description: Response Messages of Active RDT, default is 1000 (Number)

Type: number

Range: 0-1000000

Default: 1000

ardt-session

Description: Sessions of Active RDT, default is 32768 (Number)

Type: number

Range: 0-1000000

Default: 32768

conn-response

Description: Response Messages of Connection Load, default is no limit (Number)

Type: number

Range: 0-1000000

Default: 0

message

Description: Amount of Messages, default is 10000 (Number)

Type: number

Range: 0-1000000

Default: 10000

response

Description: Amount of Response Messages, default is 3600 (Number)

Type: number

Range: 0-1000000

Default: 3600

uuid

Description: uuid of the object

Type: string

protocol.enable-list

Specification
Type list
Block object keys

type

Description: ‘controller’: Enable/Disable GSLB protocol as GSLB controller; ‘device’: Enable/Disable GSLB protocol as site device;

Type: string

Supported Values: controller, device

uuid

Description: uuid of the object

Type: string

template

Specification
Type object

csv-list

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

Type: List

Reference Object: /axapi/v3/gslb/template/csv/{csv-name}

snmp-list

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

Type: List

Reference Object: /axapi/v3/gslb/template/snmp/{snmp-name}

template.snmp-list

Specification
Type list
Block object keys

auth-key

Description: Specify authentication key (Specify key)

Type: string

Format: string-rlx

auth-proto

Description: ‘sha’: SHA; ‘md5’: MD5;

Type: string

Supported Values: sha, md5

Default: md5

community

Description: Specify community for version 2c (Community name)

Type: string

Format: string-rlx

context-engine-id

Description: Specify context engine ID

Type: string

Format: string-rlx

context-name

Description: Specify context name

Type: string

Format: string-rlx

host

Description: Specify host (Host name or ip address)

Type: string

Format: string-rlx

interface

Description: Specify Interface ID

Type: number

Range: 0-2147483647

interval

Description: Specify interval, default is 3 (Interval, unit: second, default is 3)

Type: number

Range: 1-999

Default: 3

oid

Description: Specify OID

Type: string

port

Description: Specify port, default is 161 (Port Number, default is 161)

Type: number

Range: 1-65535

Default: 161

priv-key

Description: Specify privacy key (Specify key)

Type: string

Format: string-rlx

priv-proto

Description: ‘aes’: AES; ‘des’: DES;

Type: string

Supported Values: aes, des

Default: des

security-engine-id

Description: Specify security engine ID

Type: string

Format: string-rlx

security-level

Description: ‘no-auth’: No authentication; ‘auth-no-priv’: Authentication, but no privacy; ‘auth-priv’: Authentication and privacy;

Type: string

Supported Values: no-auth, auth-no-priv, auth-priv

Default: no-auth

snmp-name

Description: Specify name of snmp template

Type: string

user-tag

Description: Customized tag

Type: string

Format: string-rlx

username

Description: Specify username (User name)

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

version

Description: ‘v1’: Version 1; ‘v2c’: Version 2c; ‘v3’: Version 3;

Type: string

Supported Values: v1, v2c, v3

Default: v3

template.csv-list

Specification
Type list
Block object keys

csv-name

Description: Specify name of csv template

Type: string

delim-char

Description: enter a delimiter character, default ”,”

Type: string

Format: string-rlx

Default: ,

Mutual Exclusion: delim-char and delim-num are mutually exclusive

delim-num

Description: enter a delimiter number, default 44 (”,”)

Type: number

Range: 0-255

Default: 44

Mutual Exclusion: delim-num and delim-char are mutually exclusive

ipv6-enable

Description: Support IPv6 IP ranges

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

multiple-fields

Description: multiple-fields is a JSON List . Please see below for l719_multiple-fields

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

template.csv-list.multiple-fields

Specification
Type list
Block object keys

csv-type

Description: ‘ip-from’: Beginning address of IP range or subnet; ‘ip-to-mask’: Ending address of IP range or Mask; ‘continent’: Continent; ‘country’: Country; ‘state’: State or province; ‘city’: City;

Type: string

Supported Values: ip-from, ip-to-mask, continent, country, state, city

field

Description: Field index number (Index of Field)

Type: number

Range: 1-64

service-group-list

Specification
Type list
Block object keys

disable

Description: Disable all members

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable-site-list

Description: disable-site-list is a JSON List . Please see below for l719_disable-site-list

Type: List

member

Description: member is a JSON List . Please see below for l719_member

Type: List

service-group-name

Description: Specify Service Group name

Type: string

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

service-group-list.disable-site-list

Specification
Type list
Block object keys

disable-site

Description: Site name

Type: string

service-group-list.member

Specification
Type list
Block object keys

member-name

Description: Service name

Type: string

Format: string-rlx

system

Specification
Type object

age-interval

Description: Interval to age runtime statistics. 0: never age, default is 10 (Time, unit: sec, default is 10)

Type: number

Range: 0-120

Default: 10

geo-location-iana

Description: Load built-in IANA table

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

gslb-group

Description: GSLB Group

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

gslb-load-file-list

Description: gslb-load-file-list is a JSON List . Please see below for l719_gslb-load-file-list

Type: List

gslb-service-ip

Description: GSLB Service-IP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

gslb-site

Description: GSLB Site

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

hostname

Description: System’s Network Name

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-ttl

Description: TTL of IP packets, default is 0 (IP TTL value, default is 0)

Type: number

Range: 0-255

Default: 0

module

Description: Specify Auto Map Module

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

slb-device

Description: SLB Device

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

slb-server

Description: SLB Server

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

slb-virtual-server

Description: SLB Virtual Server

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ttl

Description: Specify Auto Map TTL (TTL, default is 300)

Type: number

Range: 1-65535

Default: 300

uuid

Description: uuid of the object

Type: string

wait

Description: Disable GSLB until timeout if system is not ready (Time, unit: sec, default is 0)

Type: number

Range: 0-16384

Default: 0

system.gslb-load-file-list

Specification
Type list
Block object keys

geo-location-load-filename

Description: Specify file to be loaded

Type: string

Format: string-rlx

template-name

Description: CSV template to load this file

Type: string

Reference Object: /axapi/v3/gslb/template/csv

geo-location-list

Specification
Type list
Block object keys

geo-locn-multiple-addresses

Description: geo-locn-multiple-addresses is a JSON List . Please see below for l719_geo-locn-multiple-addresses

Type: List

geo-locn-obj-name

Description: Specify geo-location name, section range is (1-15)

Type: string

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

geo-location-list.geo-locn-multiple-addresses

Specification
Type list
Block object keys

first-ip-address

Description: Specify IP information (Specify IP address)

Type: string

Format: ipv4-address

first-ipv6-address

Description: Specify IPv6 address

Type: string

Format: ipv6-address

geol-ipv4-mask

Description: Specify IPv4 mask

Type: string

Format: ipv4-netmask

Mutual Exclusion: geol-ipv4-mask and ip-addr2 are mutually exclusive

geol-ipv6-mask

Description: Specify IPv6 mask

Type: number

Range: 0-128

Mutual Exclusion: geol-ipv6-mask and ipv6-addr2 are mutually exclusive

ip-addr2

Description: Specify IP address range

Type: string

Format: ipv4-address

Mutual Exclusion: ip-addr2 and geol-ipv4-mask are mutually exclusive

ipv6-addr2

Description: Specify IPv6 address range

Type: string

Format: ipv6-address

Mutual Exclusion: ipv6-addr2 and geol-ipv6-mask are mutually exclusive

policy-list

Specification
Type list
Block object keys

active-rdt

Description: active-rdt is a JSON Block . Please see below for active-rdt

Type: Object

Reference Object: /axapi/v3/gslb/policy/{name}/active-rdt

active-servers

Description: Select Service-IP with the highest number of active servers

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

active-servers-enable

Description: Enable Select Service-IP with the highest number of active servers

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

active-servers-fail-break

Description: Break when no active server

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

admin-ip-enable

Description: Enable admin ip

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

admin-ip-top-only

Description: Return highest priority server only

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: admin-ip-top-only and ordered-ip-top-only are mutually exclusive

admin-preference

Description: Select Service-IP for the device having maximum admin preference

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

alias-admin-preference

Description: Select alias name having maximum admin preference

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

auto-map

Description: auto-map is a JSON Block . Please see below for l719_auto-map

Type: Object

Reference Object: /axapi/v3/gslb/policy/{name}/auto-map

bw-cost

Description: Select site with minimum bandwidth cost

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

bw-cost-enable

Description: Enable bw cost

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

bw-cost-fail-break

Description: Break when exceed limit

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

capacity

Description: capacity is a JSON Block . Please see below for l719_capacity

Type: Object

Reference Object: /axapi/v3/gslb/policy/{name}/capacity

connection-load

Description: connection-load is a JSON Block . Please see below for l719_connection-load

Type: Object

Reference Object: /axapi/v3/gslb/policy/{name}/connection-load

dns

Description: dns is a JSON Block . Please see below for dns

Type: Object

Reference Object: /axapi/v3/gslb/policy/{name}/dns

edns

Description: edns is a JSON Block . Please see below for l719_edns

Type: Object

Reference Object: /axapi/v3/gslb/policy/{name}/edns

geo-location-list

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

Type: List

Reference Object: /axapi/v3/gslb/policy/{name}/geo-location/{name}

geo-location-match

Description: geo-location-match is a JSON Block . Please see below for l719_geo-location-match

Type: Object

Reference Object: /axapi/v3/gslb/policy/{name}/geo-location-match

geographic

Description: Select Service-IP by geographic

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

health-check

Description: Select Service-IP by health status

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

ip-list

Description: Specify IP List (IP List Name)

Type: string

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

least-response

Description: Least response selection

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

metric-fail-break

Description: Break if no valid Service-IP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

metric-force-check

Description: Always check Service-IP for all enabled metrics

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

metric-order

Description: Specify order of metric

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

metric-type

Description:

Type: string

Format: enum-list

name

Description: Specify policy name

Type: string

Default: default

num-session-enable

Description: Enable Select Service-IP for device having maximum number of available sessions

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

num-session-tolerance

Description: The difference between the available sessions, default is 10 (Tolerance)

Type: number

Range: 0-100

Default: 10

ordered-ip-top-only

Description: Return highest priority server only

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: ordered-ip-top-only and admin-ip-top-only are mutually exclusive

round-robin

Description: Round robin selection, enabled by default

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

weighted-alias

Description: Select alias name by weighted preference

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

weighted-ip

Description: Select Service-IP by weighted preference

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

weighted-ip-enable

Description: Enable Select Service-IP by weighted preference

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

weighted-ip-total-hits

Description: Weighted by total hits

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

weighted-site

Description: Select Service-IP by weighted site preference

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

weighted-site-enable

Description: Enable Select Service-IP by weighted site preference

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

weighted-site-total-hits

Description: Weighted by total hits

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

policy-list.auto-map

Specification
Type object

all

Description: All modules

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: all and module-type are mutually exclusive

module-disable

Description: Specify Disable Auto Map Module

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

module-type

Description:

Type: string

Format: enum-list

Mutual Exclusion: module-type and all are mutually exclusive

ttl

Description: Specify Auto Map TTL (TTL, default is 300)

Type: number

Range: 1-65535

Default: 300

uuid

Description: uuid of the object

Type: string

policy-list.edns

Specification
Type object

client-subnet-geographic

Description: Use client subnet for geo-location

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

policy-list.active-rdt

Specification
Type object

difference

Description: The difference between the round-delay-time, default is 0

Type: number

Range: 0-16383

Default: 0

enable

Description: Enable the active rdt

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-break

Description: Break when no valid RDT

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ignore-id

Description: Ignore IP Address specified in IP List by ID

Type: number

Range: 0-31

keep-tracking

Description: Keep tracking client even round-delay-time samples are ready

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

limit

Description: Limit of allowed RDT, default is 16383 (Limit, unit: millisecond)

Type: number

Range: 1-16383

Default: 16383

samples

Description: Specify samples number for round-delay-time (Number of samples,default is 5)

Type: number

Range: 1-8

Default: 5

single-shot

Description: Single Shot RDT

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

skip

Description: Skip query if round-delay-time samples are not ready (Specify maximum skip count,default is 3)

Type: number

Range: 1-31

Default: 3

timeout

Description: Specify timeout if round-delay-time samples are not ready (Specify timeout, unit:sec,default is 3)

Type: number

Range: 1-255

Default: 3

tolerance

Description: The difference percentage between the round-delay-time, default is 10 (Tolerance)

Type: number

Range: 0-100

Default: 10

uuid

Description: uuid of the object

Type: string

policy-list.capacity

Specification
Type object

capacity-enable

Description: Enable capacity

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

capacity-fail-break

Description: Break when exceed threshold

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

threshold

Description: Specify capacity threshold, default is 90

Type: number

Range: 0-100

Default: 90

uuid

Description: uuid of the object

Type: string

policy-list.geo-location-match

Specification
Type object

geo-type-overlap

Description: ‘global’: Global Geo-location; ‘policy’: Policy Geo-location;

Type: string

Supported Values: global, policy

match-first

Description: ‘global’: Global Geo-location; ‘policy’: Policy Geo-location;

Type: string

Supported Values: global, policy

Default: global

overlap

Description: Enable overlap mode to do longest match

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

policy-list.dns

Specification
Type object

action

Description: Apply DNS action for service

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

action-type

Description: ‘drop’: Drop query; ‘reject’: Send refuse response; ‘ignore’: Send empty response;

Type: string

Supported Values: drop, reject, ignore

active-only

Description: Only keep active servers

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

active-only-fail-safe

Description: Continue if no candidate

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

aging-time

Description: Specify aging-time, default is TTL in DNS record, unit: second (Aging time, default 0 means using TTL in DNS record as aging time)

Type: number

Range: 0-1000000000

Default: 0

backup-alias

Description: Return alias name when fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

backup-server

Description: Return fallback server when fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

block-action

Description: Specify Action

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

block-type

Description:

Type: string

Format: enum-list

block-value

Description: block-value is a JSON List . Please see below for l719_block-value

Type: List

cache

Description: Cache DNS Server response

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cname-detect

Description: Apply GSLB for DNS Server response when service is Canonical Name (CNAME)

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

delegation

Description: Zone Delegation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dns-addition-mx

Description: Append MX Records in Addition Section

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dns-auto-map

Description: Automatically build DNS Infrastructure

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

external-ip

Description: Return DNS response with external IP address

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

external-soa

Description: Return DNS response with external SOA Record

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

geoloc-action

Description: Apply DNS action by geo-location

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

geoloc-alias

Description: Return alias name by geo-location

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

geoloc-policy

Description: Apply different policy by geo-location

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

hint

Description: ‘none’: None; ‘answer’: Append Hint Records in DNS Answer Section; ‘addition’: Append Hint Records in DNS Addition Section;

Type: string

Supported Values: none, answer, addition

Default: addition

ip-replace

Description: Replace DNS Server Response with GSLB Service-IPs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6

Description: ipv6 is a JSON List . Please see below for l719_ipv6

Type: List

logging

Description: ‘none’: None; ‘query’: DNS Query; ‘response’: DNS Response; ‘both’: Both DNS Query and Response;

Type: string

Supported Values: none, query, response, both

proxy-block-port-range-list

Description: proxy-block-port-range-list is a JSON List . Please see below for l719_proxy-block-port-range-list

Type: List

selected-only

Description: Only keep selected servers

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

selected-only-value

Description: Answer Number

Type: number

Range: 1-128

server

Description: Run GSLB as DNS server mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-addition-mx

Description: Append MX Records in Addition Section

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-any

Description: Provide All Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-authoritative

Description: As authoritative server

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-auto-ns

Description: Provide PTR Records automatically

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-auto-ptr

Description: Provide PTR Records automatically

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-full-list

Description: Append All A Records in Authoritative Section

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-mode-only

Description: Only run GSLB as DNS server mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-mx

Description: Provide MX Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-ns

Description: Provide NS Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-ns-list

Description: Append All NS Records in Authoritative Section

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-ptr

Description: Provide PTR Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-sec

Description: Provide DNSSEC support

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-srv

Description: Provide SRV Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-txt

Description: Provide TXT Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sticky

Description: Make DNS Record sticky for certain time

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sticky-aging-time

Description: Specify aging-time, unit: min, default is 5 (Aging time)

Type: number

Range: 1-65535

Default: 5

sticky-ipv6-mask

Description: Specify IPv6 mask length, default is 128

Type: number

Range: 1-128

Default: 128

sticky-mask

Description: Specify IP mask, default is /32 default /32

Type: string

Format: ipv4-netmask-brief

ttl

Description: Specify the TTL value contained in DNS record (TTL value, unit: second, default is 10)

Type: number

Range: 0-1000000000

Default: 10

Mutual Exclusion: ttl and use-server-ttl are mutually exclusive

use-server-ttl

Description: Use DNS Server Response TTL value in GSLB Proxy mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: use-server-ttl and ttl are mutually exclusive

uuid

Description: uuid of the object

Type: string

policy-list.dns.ipv6

Specification
Type list
Block object keys

dns-ipv6-mapping-type

Description: ‘addition’: Append Mapped Record in DNS Addition Section; ‘answer’: Append Mapped Record in DNS Answer Section; ‘exclusive’: Only return AAAA Record; ‘replace’: Replace Record with Mapped Record;

Type: string

Supported Values: addition, answer, exclusive, replace

dns-ipv6-option

Description: ‘mix’: Return both AAAA Record and A Record; ‘smart’: Return AAAA Record by DNS Query Type; ‘mapping’: Map A Record to AAAA Record;

Type: string

Supported Values: mix, smart, mapping

policy-list.dns.block-value

Specification
Type list
Block object keys

block-value

Description: Specify Type Number

Type: number

Range: 1-255

policy-list.dns.proxy-block-port-range-list

Specification
Type list
Block object keys

proxy-block-range-from

Description: Specify Type Range (From)

Type: number

proxy-block-range-to

Description: To

Type: number

policy-list.geo-location-list

Specification
Type list
Block object keys

ip-multiple-fields

Description: ip-multiple-fields is a JSON List . Please see below for l719_ip-multiple-fields

Type: List

ipv6-multiple-fields

Description: ipv6-multiple-fields is a JSON List . Please see below for l719_ipv6-multiple-fields

Type: List

name

Description: Specify geo-location name, section range is (1-15)

Type: string

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

policy-list.geo-location-list.ip-multiple-fields

Specification
Type list
Block object keys

ip-addr2-sub

Description: Specify IP address range

Type: string

Format: ipv4-address

ip-mask-sub

Description: Specify IP/mask format (Specify IP address mask)

Type: string

Format: ipv4-netmask-brief

ip-sub

Description: Specify IP information

Type: string

Format: ipv4-address

policy-list.geo-location-list.ipv6-multiple-fields

Specification
Type list
Block object keys

ipv6-addr2-sub

Description: Specify IPv6 address range

Type: string

Format: ipv6-address

ipv6-mask-sub

Description: Specify IPv6/mask format (Specify IP address mask)

Type: number

Range: 0-128

ipv6-sub

Description: Specify IPv6 information

Type: string

Format: ipv6-address

policy-list.connection-load

Specification
Type object

connection-load-enable

Description: Enable connection-load

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

connection-load-fail-break

Description: Break when exceed limit

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

connection-load-interval

Description: Interval between two samples, Unit: second (Interval value,default is 5)

Type: number

Range: 1-60

Default: 5

connection-load-limit

Description: The value of the connection-load limit, default is unlimited

Type: number

Range: 1-999999999

connection-load-samples

Description: Specify samples for connection-load (Number of samples used to calculate the connection load, default is 5)

Type: number

Range: 1-8

Default: 5

limit

Description: Limit of maxinum connection load, default is unlimited

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

site-list

Specification
Type list
Block object keys

active-rdt

Description: active-rdt is a JSON Block . Please see below for active-rdt

Type: Object

Reference Object: /axapi/v3/gslb/site/{site-name}/active-rdt

auto-map

Description: Enable DNS Auto Mapping

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

bw-cost

Description: Specify cost of band-width

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable

Description: Disable all servers in the GSLB site

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

easy-rdt

Description: easy-rdt is a JSON Block . Please see below for l719_easy-rdt

Type: Object

Reference Object: /axapi/v3/gslb/site/{site-name}/easy-rdt

ip-server-list

Description: ip-server-list is a JSON List . Please see below for l719_ip-server-list

Type: List

Reference Object: /axapi/v3/gslb/site/{site-name}/ip-server/{ip-server-name}

limit

Description: Specify the limit for bandwidth, default is unlimited

Type: number

Range: 0-2147483647

multiple-geo-locations

Description: multiple-geo-locations is a JSON List . Please see below for l719_multiple-geo-locations

Type: List

sampling-enable

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

Type: List

site-name

Description: Specify GSLB site name

Type: string

slb-dev-list

Description: slb-dev-list is a JSON List . Please see below for l719_slb-dev-list

Type: List

Reference Object: /axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}

template

Description: Specify template to collect site information (Specify template name)

Type: string

threshold

Description: Specify the threshold for limit

Type: number

Range: 0-100

Default: 0

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

weight

Description: Specify a weight for the GSLB site (Weight, default is 1)

Type: number

Range: 1-100

Default: 1

site-list.ip-server-list

Specification
Type list
Block object keys

ip-server-name

Description: Specify the real server name

Type: string

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

site-list.ip-server-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the IP was selected;

Type: string

Supported Values: all, hits

site-list.slb-dev-list

Specification
Type list
Block object keys

admin-preference

Description: Specify administrative preference (Specify admin-preference value,default is 100)

Type: number

Range: 0-255

Default: 100

auto-detect

Description: ‘ip’: Service IP only; ‘port’: Service Port only; ‘ip-and-port’: Both service IP and service port; ‘disabled’: disable auto-detect;

Type: string

Supported Values: ip, port, ip-and-port, disabled

Default: ip-and-port

auto-map

Description: Enable DNS Auto Mapping

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

client-ip

Description: Specify client IP address

Type: string

Format: ipv4-address

device-name

Description: Specify SLB device name

Type: string

gateway-ip-addr

Description: IP address

Type: string

Format: ipv4-address

health-check-action

Description: ‘health-check’: Enable health Check; ‘health-check-disable’: Disable health check;

Type: string

Supported Values: health-check, health-check-disable

Default: health-check

ip-address

Description: IP address

Type: string

Format: ipv4-address

max-client

Description: Specify maximum number of clients, default is 32768

Type: number

Range: 1-2147483647

Default: 32768

proto-aging-fast

Description: Fast GSLB Protocol aging

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

proto-aging-time

Description: Specify GSLB Protocol aging time, default is 60

Type: number

Range: 1-65535

Default: 60

proto-compatible

Description: Run GSLB Protocol in compatible mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rdt-value

Description: Specify Round-delay-time

Type: number

Range: 1-65535

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

vip-server

Description: vip-server is a JSON Block . Please see below for l719_vip-server

Type: Object

Reference Object: /axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server

site-list.slb-dev-list.vip-server

Specification
Type object

vip-server-name-list

Description: vip-server-name-list is a JSON List . Please see below for l719_vip-server-name-list

Type: List

Reference Object: /axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server/vip-server-name/{vip-name}

vip-server-v4-list

Description: vip-server-v4-list is a JSON List . Please see below for l719_vip-server-v4-list

Type: List

Reference Object: /axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server/vip-server-v4/{ipv4}

vip-server-v6-list

Description: vip-server-v6-list is a JSON List . Please see below for l719_vip-server-v6-list

Type: List

Reference Object: /axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server/vip-server-v6/{ipv6}

site-list.slb-dev-list.vip-server.vip-server-v4-list

Specification
Type list
Block object keys

ipv4

Description: Specify IP address

Type: string

Format: ipv4-address

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

site-list.slb-dev-list.vip-server.vip-server-v4-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘dev_vip_hits’: Number of times the service-ip was selected;

Type: string

Supported Values: all, dev_vip_hits

site-list.slb-dev-list.vip-server.vip-server-v6-list

Specification
Type list
Block object keys

ipv6

Description: Specify IP address (IPv6 address)

Type: string

Format: ipv6-address

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

site-list.slb-dev-list.vip-server.vip-server-v6-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘dev_vip_hits’: Number of times the service-ip was selected;

Type: string

Supported Values: all, dev_vip_hits

site-list.slb-dev-list.vip-server.vip-server-name-list

Specification
Type list
Block object keys

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

vip-name

Description: Specify a VIP name for the SLB device

Type: string

Reference Object: /axapi/v3/gslb/service-ip

site-list.slb-dev-list.vip-server.vip-server-name-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘dev_vip_hits’: Number of times the service-ip was selected;

Type: string

Supported Values: all, dev_vip_hits

site-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the site was selected;

Type: string

Supported Values: all, hits

site-list.multiple-geo-locations

Specification
Type list
Block object keys

geo-location

Description: Specify the geographic location of the GSLB site (Specify geo-location for this site)

Type: string

site-list.easy-rdt

Specification
Type object

aging-time

Description: Aging Time, Unit: min, default is 10

Type: number

Range: 1-15360

Default: 10

bind-geoloc

Description: Bind RDT to geo-location

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ignore-count

Description: Ignore count if RDT is out of range, default is 5

Type: number

Range: 0-15

Default: 5

limit

Description: Limit of valid RDT, default is 16383 (Limit, unit: millisecond)

Type: number

Range: 1-16383

Default: 16383

mask

Description: Client IP subnet mask, default is 32

Type: string

Format: ipv4-netmask-brief

Default: /32

overlap

Description: Enable overlap for geo-location to do longest match

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

range-factor

Description: Factor of RDT Range, default is 25 (Range Factor of Smooth RDT)

Type: number

Range: 0-1000

Default: 25

smooth-factor

Description: Factor of Smooth RDT, default is 10

Type: number

Range: 0-100

Default: 10

uuid

Description: uuid of the object

Type: string

site-list.active-rdt

Specification
Type object

aging-time

Description: Aging Time, Unit: min, default is 10

Type: number

Range: 1-15360

Default: 10

bind-geoloc

Description: Bind RDT to geo-location

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ignore-count

Description: Ignore count if RDT is out of range, default is 5

Type: number

Range: 0-15

Default: 5

limit

Description: Limit of valid RDT, default is 16383 (Limit, unit: millisecond)

Type: number

Range: 1-16383

Default: 16383

mask

Description: Client IP subnet mask, default is 32

Type: string

Format: ipv4-netmask-brief

Default: /32

overlap

Description: Enable overlap for geo-location to do longest match

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

range-factor

Description: Factor of RDT Range, default is 25 (Range Factor of Smooth RDT)

Type: number

Range: 0-1000

Default: 25

smooth-factor

Description: Factor of Smooth RDT, default is 10

Type: number

Range: 0-100

Default: 10

uuid

Description: uuid of the object

Type: string

ip-list-list

Specification
Type list
Block object keys

gslb-ip-list-addr-list

Description: gslb-ip-list-addr-list is a JSON List . Please see below for l719_gslb-ip-list-addr-list

Type: List

gslb-ip-list-filename

Description: Load IP List file (IP List filename)

Type: string

Format: string-rlx

gslb-ip-list-obj-name

Description: Specify IP List name

Type: string

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

ip-list-list.gslb-ip-list-addr-list

Specification
Type list
Block object keys

id

Description: ID Number

Type: number

Range: 0-31

ip

Description: Specify IP address

Type: string

Format: ipv4-address

ip-mask

Description: IP mask

Type: string

Format: ipv4-netmask

dns

Specification
Type object

action

Description: ‘none’: No action (default); ‘drop’: Drop query; ‘reject’: Send refuse response; ‘ignore’: Send empty response;

Type: string

Supported Values: none, drop, reject, ignore

Default: none

logging

Description: ‘none’: No logging (default); ‘query’: DNS Query; ‘response’: DNS Response; ‘both’: Both DNS Query and Response;

Type: string

Supported Values: none, query, response, both

Default: none

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

dns.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘total-query’: Total number of DNS queries received; ‘total-response’: Total number of DNS replies sent to clients; ‘bad-packet-query’: Number of queries with incorrect data length; ‘bad-packet-response’: Number of replies with incorrect data length; ‘bad-header-query’: Number of queries with incorrect header; ‘bad-header-response’: Number of replies with incorrect header; ‘bad-format-query’: Number of queries with incorrect format; ‘bad-format-response’: Number of replies with incorrect format; ‘bad-service-query’: Number of queries with unknown service; ‘bad-service-response’: Number of replies with unknown service; ‘bad-class-query’: Number of queries with incorrect class; ‘bad-class-response’: Number of replies with incorrect class; ‘bad-type-query’: Number of queries with incorrect type; ‘bad-type-response’: Number of replies with incorrect type; ‘no_answer’: Number of replies with unknown server IP;

Type: string

Supported Values: all, total-query, total-response, bad-packet-query, bad-packet-response, bad-header-query, bad-header-response, bad-format-query, bad-format-response, bad-service-query, bad-service-response, bad-class-query, bad-class-response, bad-type-query, bad-type-response, no_answer

group-list

Specification
Type list
Block object keys

auto-map-learn

Description: IP Address learned from other controller

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

auto-map-primary

Description: Primary Controller’s IP address

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

auto-map-smart

Description: Choose Best IP address

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

config-anywhere

Description: Every member can do config

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

config-merge

Description: Merge old master’s config when new one take over

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

config-save

Description: Accept config-save message from master

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

data-interface

Description: Data Interface IP Address

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

dns-discover

Description: Discover member via DNS Protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

enable

Description: Join GSLB Group

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

learn

Description: Learn neighbour information from other controllers

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

mgmt-interface

Description: Management Interface IP Address

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

name

Description: Specify Group domain name

Type: string

Default: default

primary-list

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

Type: List

priority

Description: Specify Local Priority, default is 100

Type: number

Range: 1-255

Default: 100

standalone

Description: Run GSLB Group in standalone mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

suffix

Description: Set DNS Suffix (Name)

Type: string

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

group-list.primary-list

Specification
Type list
Block object keys

primary

Description: Specify Primary controller’s IP address

Type: string

Format: ipv4-address

zone-list

Specification
Type list
Block object keys

disable

Description: Disable all services in the GSLB zone

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dns-mx-record-list

Description: dns-mx-record-list is a JSON List . Please see below for l719_dns-mx-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/dns-mx-record/{mx-name}

dns-ns-record-list

Description: dns-ns-record-list is a JSON List . Please see below for l719_dns-ns-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/dns-ns-record/{ns-name}

dns-soa-record

Description: dns-soa-record is a JSON Block . Please see below for l719_dns-soa-record

Type: Object

name

Description: Specify the name for the DNS zone

Type: string

Format: string-rlx

policy

Description: Specify the policy for this zone (Specify policy name)

Type: string

Default: default

service-list

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

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}

template

Description: template is a JSON Block . Please see below for template

Type: Object

ttl

Description: Specify the zone ttl value (TTL value, unit: second, default is 10)

Type: number

Range: 0-1000000000

Default: 10

Mutual Exclusion: ttl and use-server-ttl are mutually exclusive

use-server-ttl

Description: Use DNS Server Response TTL value in GSLB Proxy mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: use-server-ttl and ttl are mutually exclusive

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

zone-list.dns-ns-record-list

Specification
Type list
Block object keys

ns-name

Description: Specify Domain Name

Type: string

sampling-enable

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

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

uuid

Description: uuid of the object

Type: string

zone-list.dns-ns-record-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

zone-list.dns-mx-record-list

Specification
Type list
Block object keys

mx-name

Description: Specify Domain Name

Type: string

priority

Description: Specify Priority

Type: number

Range: 0-65535

sampling-enable

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

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

uuid

Description: uuid of the object

Type: string

zone-list.dns-mx-record-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

zone-list.template

Specification
Type object

dnssec

Description: Specify DNSSEC template (Specify template name)

Type: string

zone-list.dns-soa-record

Specification
Type object

ex-expire

Description: Specify Expire Time Interval, default is 1209600

Type: number

Range: 0-2147483647

Default: 1209600

ex-mail

Description: Mailbox

Type: string

ex-refresh

Description: Specify Refresh Time Interval, default is 3600

Type: number

Range: 0-2147483647

Default: 3600

ex-retry

Description: Specify Retry Time Interval, default is 900

Type: number

Range: 0-2147483647

Default: 900

ex-serial

Description: Specify Serial Number, default is Current Time (Time Interval)

Type: number

Range: 0-2147483647

ex-soa-ttl

Description: Specify Negative caching TTL, default is Zone TTL

Type: number

Range: 0-2147483647

expire

Description: Specify Expire Time Interval, default is 1209600

Type: number

Range: 0-2147483647

Default: 1209600

external

Description: Specify External SOA Record (DNS Server Name)

Type: string

mail

Description: Mailbox

Type: string

refresh

Description: Specify Refresh Time Interval, default is 3600

Type: number

Range: 0-2147483647

Default: 3600

retry

Description: Specify Retry Time Interval, default is 900

Type: number

Range: 0-2147483647

Default: 900

serial

Description: Specify Serial Number, default is Current Time (Time Interval)

Type: number

Range: 0-2147483647

soa-name

Description: DNS Server Name

Type: string

soa-ttl

Description: Specify Negative caching TTL, default is Zone TTL

Type: number

Range: 0-2147483647

zone-list.service-list

Specification
Type list
Block object keys

action

Description: ‘drop’: Drop query; ‘forward’: Forward packet; ‘ignore’: Send empty response; ‘reject’: Send refuse response;

Type: string

Supported Values: drop, forward, ignore, reject

disable

Description: Disable

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dns-a-record

Description: dns-a-record is a JSON Block . Please see below for l719_dns-a-record

Type: Object

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-a-record

dns-cname-record-list

Description: dns-cname-record-list is a JSON List . Please see below for l719_dns-cname-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-cname-record/{alias-name}

dns-mx-record-list

Description: dns-mx-record-list is a JSON List . Please see below for l719_dns-mx-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-mx-record/{mx-name}

dns-ns-record-list

Description: dns-ns-record-list is a JSON List . Please see below for l719_dns-ns-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-ns-record/{ns-name}

dns-ptr-record-list

Description: dns-ptr-record-list is a JSON List . Please see below for l719_dns-ptr-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-ptr-record/{ptr-name}

dns-record-list

Description: dns-record-list is a JSON List . Please see below for l719_dns-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-record/{type}

dns-srv-record-list

Description: dns-srv-record-list is a JSON List . Please see below for l719_dns-srv-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-srv-record/{srv-name}+{port}

dns-txt-record-list

Description: dns-txt-record-list is a JSON List . Please see below for l719_dns-txt-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-txt-record/{record-name}

forward-type

Description: ‘both’: Forward both query and response; ‘query’: Forward query; ‘response’: Forward response;

Type: string

Supported Values: both, query, response

geo-location-list

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

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/geo-location/{geo-name}

health-check-gateway

Description: ‘enable’: Enable Gateway Status Check; ‘disable’: Disable Gateway Status Check;

Type: string

Supported Values: enable, disable

Default: enable

health-check-port

Description: health-check-port is a JSON List . Please see below for l719_health-check-port

Type: List

policy

Description: Specify policy for this service (Specify policy name)

Type: string

sampling-enable

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

Type: List

service-name

Description: Specify the service name for the zone, * for wildcard

Type: string

Format: string-rlx

service-port

Description: Port number of the service

Type: number

Range: 0-65534

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

zone-list.service-list.dns-a-record

Specification
Type object

dns-a-record-ipv4-list

Description: dns-a-record-ipv4-list is a JSON List . Please see below for l719_dns-a-record-ipv4-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-a-record/dns-a-record-ipv4/{dns-a-record-ip}

dns-a-record-ipv6-list

Description: dns-a-record-ipv6-list is a JSON List . Please see below for l719_dns-a-record-ipv6-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-a-record/dns-a-record-ipv6/{dns-a-record-ipv6}

dns-a-record-srv-list

Description: dns-a-record-srv-list is a JSON List . Please see below for l719_dns-a-record-srv-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-a-record/dns-a-record-srv/{svrname}

zone-list.service-list.dns-a-record.dns-a-record-ipv6-list

Specification
Type list
Block object keys

admin-ip

Description: Specify admin priority of Service-IP (Specify the priority)

Type: number

Range: 1-255

as-backup

Description: As backup when fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

as-replace

Description: Return this Service-IP when enable ip-replace

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable

Description: Disable this Service-IP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dns-a-record-ipv6

Description: IPV6 address

Type: string

Format: ipv6-address

no-resp

Description: Don’t use this Service-IP as DNS response

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sampling-enable

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

Type: List

static

Description: Return this Service-IP in DNS server mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ttl

Description: Specify TTL for Service-IP

Type: number

Range: 0-2147483647

Default: 0

uuid

Description: uuid of the object

Type: string

weight

Description: Specify weight for Service-IP (Weight value)

Type: number

Range: 1-100

zone-list.service-list.dns-a-record.dns-a-record-ipv6-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

zone-list.service-list.dns-a-record.dns-a-record-ipv4-list

Specification
Type list
Block object keys

admin-ip

Description: Specify admin priority of Service-IP (Specify the priority)

Type: number

Range: 1-255

as-backup

Description: As backup when fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

as-replace

Description: Return this Service-IP when enable ip-replace

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable

Description: Disable this Service-IP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dns-a-record-ip

Description: Specify IP address

Type: string

Format: ipv4-address

no-resp

Description: Don’t use this Service-IP as DNS response

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sampling-enable

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

Type: List

static

Description: Return this Service-IP in DNS server mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ttl

Description: Specify TTL for Service-IP

Type: number

Range: 0-2147483647

Default: 0

uuid

Description: uuid of the object

Type: string

weight

Description: Specify weight for Service-IP (Weight value)

Type: number

Range: 1-100

zone-list.service-list.dns-a-record.dns-a-record-ipv4-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

zone-list.service-list.dns-a-record.dns-a-record-srv-list

Specification
Type list
Block object keys

admin-ip

Description: Specify admin priority of Service-IP (Specify the priority)

Type: number

Range: 1-255

as-backup

Description: As backup when fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

as-replace

Description: Return this Service-IP when enable ip-replace

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable

Description: Disable this Service-IP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

no-resp

Description: Don’t use this Service-IP as DNS response

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sampling-enable

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

Type: List

static

Description: Return this Service-IP in DNS server mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

svrname

Description: Specify name

Type: string

ttl

Description: Specify TTL for Service-IP

Type: number

Range: 0-2147483647

Default: 0

uuid

Description: uuid of the object

Type: string

weight

Description: Specify weight for Service-IP (Weight value)

Type: number

Range: 1-100

zone-list.service-list.dns-a-record.dns-a-record-srv-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

zone-list.service-list.health-check-port

Specification
Type list
Block object keys

health-check-port

Description: Check Related Port Status (Port Number)

Type: number

Range: 0-65534

zone-list.service-list.dns-txt-record-list

Specification
Type list
Block object keys

record-name

Description: Specify the Object Name for TXT Data

Type: string

sampling-enable

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

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

Default: 0

txt-data

Description: Specify TXT Data

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

zone-list.service-list.dns-txt-record-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

zone-list.service-list.dns-mx-record-list

Specification
Type list
Block object keys

mx-name

Description: Specify Domain Name

Type: string

priority

Description: Specify Priority

Type: number

Range: 0-65535

sampling-enable

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

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

Default: 0

uuid

Description: uuid of the object

Type: string

zone-list.service-list.dns-mx-record-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

zone-list.service-list.dns-record-list

Specification
Type list
Block object keys

data

Description: Specify DNS Data

Type: string

Format: string-rlx

type

Description: Specify DNS Type

Type: number

Range: 1-65535

uuid

Description: uuid of the object

Type: string

zone-list.service-list.dns-ns-record-list

Specification
Type list
Block object keys

ns-name

Description: Specify Domain Name

Type: string

sampling-enable

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

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

Default: 0

uuid

Description: uuid of the object

Type: string

zone-list.service-list.dns-ns-record-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

zone-list.service-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘received-query’: Number of DNS queries received for the service; ‘sent-response’: Number of DNS replies sent to clients for the service; ‘proxy-mode-response’: Number of DNS replies sent to clients by the ACOS device as a DNS proxy for the service; ‘cache-mode-response’: Number of cached DNS replies sent to clients by the ACOS device for the service. (This statistic applies only if the DNS cache; ‘server-mode-response’: Number of DNS replies sent to clients by the ACOS device as a DNS server for the service. (This statistic applies only if the D; ‘sticky-mode-response’: Number of DNS replies sent to clients by the ACOS device to keep the clients on the same site. (This statistic applies only if; ‘backup-mode-response’: help Number of DNS replies sent to clients by the ACOS device in backup mode;

Type: string

Supported Values: all, received-query, sent-response, proxy-mode-response, cache-mode-response, server-mode-response, sticky-mode-response, backup-mode-response

zone-list.service-list.dns-srv-record-list

Specification
Type list
Block object keys

port

Description: Specify Port (Port Number)

Type: number

Range: 0-65534

priority

Description: Specify Priority

Type: number

Range: 0-65535

sampling-enable

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

Type: List

srv-name

Description: Specify Domain Name

Type: string

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

uuid

Description: uuid of the object

Type: string

weight

Description: Specify Weight, default is 10

Type: number

Range: 1-100

Default: 10

zone-list.service-list.dns-srv-record-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

zone-list.service-list.dns-ptr-record-list

Specification
Type list
Block object keys

ptr-name

Description: Specify Domain Name

Type: string

sampling-enable

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

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

Default: 0

uuid

Description: uuid of the object

Type: string

zone-list.service-list.dns-ptr-record-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

zone-list.service-list.dns-cname-record-list

Specification
Type list
Block object keys

admin-preference

Description: Specify Administrative Preference, default is 100

Type: number

Range: 0-255

Default: 100

alias-name

Description: Specify the alias name

Type: string

as-backup

Description: As backup when fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

weight

Description: Specify Weight, default is 1

Type: number

Range: 1-100

Default: 1

zone-list.service-list.geo-location-list

Specification
Type list
Block object keys

action

Description: Action for this geo-location

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: action and policy are mutually exclusive

action-type

Description: ‘allow’: Allow query from this geo-location; ‘drop’: Drop query from this geo-location; ‘forward’: Forward packet for this geo-location; ‘ignore’: Send empty response to this geo-location; ‘reject’: Send refuse response to this geo-location;

Type: string

Supported Values: allow, drop, forward, ignore, reject

alias

Description: alias is a JSON List . Please see below for l719_alias

Type: List

forward-type

Description: ‘both’: Forward both query and response; ‘query’: Forward query from this geo-location; ‘response’: Forward response to this geo-location;

Type: string

Supported Values: both, query, response

geo-name

Description: Specify the geo-location

Type: string

policy

Description: Policy for this geo-location (Specify the policy name)

Type: string

Mutual Exclusion: policy and action are mutually exclusive

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

zone-list.service-list.geo-location-list.alias

Specification
Type list
Block object keys

alias

Description: Send CNAME response for this geo-location (Specify a CNAME record)

Type: string

active-rdt

Specification
Type object

domain

Description: Specify Query Domain (Specify Domain Name)

Type: string

interval

Description: Specify Query Interval, unit: second, default is 1

Type: number

Range: 1-16383

Default: 1

port

Description: Specify local port to send probe packet, default is 0 (no port)

Type: number

Range: 0-65535

Default: 0

retry

Description: Specify Retry Count, default is 3

Type: number

Range: 0-16

Default: 3

sleep

Description: Specify Sleep Time when query fail, unit: second, default is 3

Type: number

Range: 1-300

Default: 3

timeout

Description: Specify Query Timeout, unit: msec, default is 3000

Type: number

Range: 1-16383

Default: 3000

track

Description: Specify Tracking Time, unit: second, default is 60

Type: number

Range: 3-16383

Default: 60

uuid

Description: uuid of the object

Type: string

service-ip-list

Specification
Type list
Block object keys

action

Description: ‘enable’: Enable this GSLB server; ‘disable’: Disable this GSLB server;

Type: string

Supported Values: enable, disable

Default: enable

external-ip

Description: External IP address for NAT

Type: string

Format: ipv4-address

health-check

Description: Health Check Monitor (Monitor Name)

Type: string

Mutual Exclusion: health-check and health-check-disable are mutually exclusive

health-check-disable

Description: Disable Health Check Monitor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: health-check-disable and health-check are mutually exclusive

health-check-protocol-disable

Description: Disable GSLB Protocol Health Monitor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-address

Description: IP address

Type: string

Format: ipv4-address

ipv6

Description: IPv6 address Mapping

Type: string

Format: ipv6-address

ipv6-address

Description: IPV6 address

Type: string

Format: ipv6-address

node-name

Description: Service-IP Name

Type: string

port-list

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

Type: List

Reference Object: /axapi/v3/gslb/service-ip/{node-name}/port/{port-num}+{port-proto}

sampling-enable

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

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

service-ip-list.port-list

Specification
Type list
Block object keys

action

Description: ‘enable’: Enable this GSLB server port; ‘disable’: Disable this GSLB server port;

Type: string

Supported Values: enable, disable

Default: enable

follow-port-protocol

Description: ‘tcp’: TCP Port; ‘udp’: UDP Port;

Type: string

Supported Values: tcp, udp

health-check

Description: Health Check Monitor (Monitor Name)

Type: string

Mutual Exclusion: health-check health-check-follow-port and health-check-disable are mutually exclusive

health-check-disable

Description: Disable Health Check Monitor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: health-check-disable health-check and health-check-follow-port are mutually exclusive

health-check-follow-port

Description: Specify which port to follow for health status (Port Number)

Type: number

Range: 1-65534

Mutual Exclusion: health-check-follow-port health-check and health-check-disable are mutually exclusive

health-check-protocol-disable

Description: Disable GSLB Protocol Health Monitor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

port-num

Description: Port Number

Type: number

Range: 0-65534

port-proto

Description: ‘tcp’: TCP Port; ‘udp’: UDP Port;

Type: string

Supported Values: tcp, udp

sampling-enable

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

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

service-ip-list.port-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘active’: Active Servers; ‘current’: Current Connections;

Type: string

Supported Values: all, active, current

service-ip-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the service IP has been selected; ‘recent’: Recent hits;

Type: string

Supported Values: all, hits, recent