gslb site

Configure a GSLB site.

site Specification

Type Collection
Object Key(s) site-name
Collection Name site-list
Collection URI /axapi/v3/gslb/site/
Element Name site
Element URI /axapi/v3/gslb/site/{site-name}
Element Attributes site_attributes
Statistics Data URI /axapi/v3/gslb/site/{site-name}/stats
Operational Data URI /axapi/v3/gslb/site/{site-name}/oper
Schema site schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/gslb/site/

site Attributes

Create List

POST

/axapi/v3/gslb/site/

site Attributes

Get Object

GET

/axapi/v3/gslb/site/{site-name}

site Attributes

Get List

GET

/axapi/v3/gslb/site/

site-list

Modify Object

POST

/axapi/v3/gslb/site/{site-name}

site Attributes

Replace Object

PUT

/axapi/v3/gslb/site/{site-name}

site Attributes

Replace List

PUT

/axapi/v3/gslb/site/

site-list

Delete Object

DELETE

/axapi/v3/gslb/site/{site-name}

site Attributes

Get Stats

GET

/axapi/v3/gslb/site/{site-name}/stats

stats data

Get Oper

GET

/axapi/v3/gslb/site/{site-name}/oper

operational data

site-list

site-list is JSON List of site Attributes

site-list : [

site Attributes

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: Enables DNS auto-mapping for site resources.

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

bw-cost

Description: Enable the cost metric for bandwidth.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable

Description: Disables 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 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 ip-server-list

Type: List

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

limit

Description: Specifies the maximum amount the SNMP object queried by the GSLB ACOS device can increase since the previous query, in order for the site to remain eligible for selection.

Type: number

Range: 0-2147483647

multiple-geo-locations

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

Type: List

sampling-enable

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

Type: List

site-name

Description: Specify GSLB site name

Type: string

Required: Yes

slb-dev-list

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

Type: List

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

template

Description: Binds a template to the site.

Type: string

threshold

Description: For a site to regain eligibility when bw-cost is being compared, the SNMP object’s value must be below the threshold-percentage of the limit value. For example, if the limit value is 80,000 and the threshold is 90 percent, then the limit value must be 72,000 or less, in order for the site to become eligible again based. Once a site again becomes eligible, the SNMP object’s value is again allowed to increase up to the bandwidth 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: Assigns a weight to the site. If the Weighted-Site metric is enabled in the policy and all metrics before Weighted-Site result in a tie, the site with the highest weight is preferred.

Type: number

Range: 1-100

Default: 1

ip-server-list

Specification
Type list
Block object keys

ip-server-name

Description: Specify the real server name

Type: string

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

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

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

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 l698_vip-server

Type: Object

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

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 l698_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 l698_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 l698_vip-server-v6-list

Type: List

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

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 sampling-enable

Type: List

uuid

Description: uuid of the object

Type: string

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

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 sampling-enable

Type: List

uuid

Description: uuid of the object

Type: string

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

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

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

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

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

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

active-rdt

Specification
Type object

aging-time

Description: Specifies the maximum amount of time in minutes that a stored aRDT result can be used.

Type: number

Range: 1-15360

Default: 10

bind-geoloc

Description: Stores the aRDT measurements on a per geo-location basis. Without this option, the measurements are stored on a per site-SLB device basis.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ignore-count

Description: Specifies the ignore count if aRDT is out of range.

Type: number

Range: 0-15

Default: 5

limit

Description: Specifies the maximum aRDT allowed for the site. If the aRDT measurement for a site exceeds the configured limit, GSLB does not eliminate the site. Instead, GSLB moves to the next metric in the policy.

Type: number

Range: 1-16383

Default: 16383

mask

Description: Specifies the IPv4 client subnet mask length.

Type: string

Format: ipv4-netmask-brief

Default: /32

overlap

Description: Enables overlap matching mode. If there are overlapping addresses in the geo-location database, use this option to enable the ACOS device to find the most precise match.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

range-factor

Description: Specifies the maximum percentage a new aRDT measurement can differ from the previous measurement. If the new measurement differs from the previous measurement by more than the allowed percentage, the new measurement is discarded and the previous measurement is used again. For example, if the range-factor is set to 25, a new measurement that has a value from 75% to 125% of the previous value can be used. A measurement that is less than 75% or more than 125% of the previous measurement can not be used.

Type: number

Range: 0-1000

Default: 25

smooth-factor

Description: Blends the new measurement with the previous one, to even out the measurements. For example, if the smooth-factor is set to 10, 10% of the new measurement is used, along with 90% of the previous measurement. Similarly, if the smooth-factor is set to 50, 50% of the new measurement is used, along with 50% of the previous measurement.

Type: number

Range: 0-100

Default: 10

uuid

Description: uuid of the object

Type: string

stats data

Counter Size Description
hits 8 Number of times the site was selected

operational data

Name Type Description
state string state
type-last type-last
gslb-site string gslb-site