gslb site¶

Specify a GSLB site

site Specification¶

Parameter Value

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

Partition Visibility shared

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
POST /axapi/v3/gslb/site/a/ip-server/ Payload: { "ip-server": { "ip-server-name": "a" } }
Create List	POST	/axapi/v3/gslb/site	site attributes
Get Object	GET	/axapi/v3/gslb/site/{site-name}	site attributes
GET /axapi/v3/gslb/site/a/ip-server/a Reponse: { "ip-server": { "ip-server-name": "a", "uuid": "42996402-5eac-11d9-b1b4-654a63d8be98", "a10-url": "/axapi/v3/gslb/site/a/ip-server/a" } }
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
PUT /axapi/v3/gslb/site/a/ip-server/a Payload: { "ip-server": { "ip-server-name": "a" } }
Replace List	PUT	/axapi/v3/gslb/site	site-list
Delete Object	DELETE	/axapi/v3/gslb/site/{site-name}	site attributes
DELETE /axapi/v3/gslb/site/a/ip-server/a Reponse: { "response": { "status": "OK" } }

site-list¶

site-list is JSON List of site attributes

site-list : [

{ site attributes },

{ site attributes },

…

]

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

controller

Description Specify the local controller for the GSLB site (Specify the hostname of the local controller)

Type: string

Maximum Length: 127 characters

Maximum Length: 1 characters

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

Type: Object

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

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

Type: List

proto-aging-fast

Description Fast GSLB Protocol aging

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

proto-aging-time

Description Specify GSLB Protocol aging time

Type: number

Range: 0-65535

Default: 0

site-name

Description Specify GSLB site name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

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 GSLB SNMP template name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

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

threshold

Description Specify the threshold for limit

Type: number

Range: 0-100

Default: 0

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

weight

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

Type: number

Range: 1-100

Default: 1

ip-server-list¶

Specification Value

Type list

Block object keys

ip-server-name

Description Specify the real server name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

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

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

slb-dev-list¶

Specification Value

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

Maximum Length: 63 characters

Maximum Length: 1 characters

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

ipv6-address

Description IPv6 address

Type: string

Format: ipv6-address

max-client

Description Specify maximum number of clients, default is 32768

Type: number

Range: 1-2147483647

Default: 32768

msg-format-acos-2x

Description Run GSLB Protocol in compatible mode with a ACOS 2.x GSLB peer

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

probe-timer

Description

Type: number

Range: 1-255

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

Description ‘rdt’: rdt; ‘site-rdt’: site-rdt;

Type: string

Supported Values: rdt, site-rdt

rdt-value

Description Specify Round-delay-time

Type: number

Range: 1-65535

session-number

Description

Type: number

Range: 0-16777214

session-utilization

Description

Type: number

Range: 1-100

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vip-server

Description: vip-server is a JSON Block. Please see below for slb-dev-list_vip-server

Type: Object

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

slb-dev-list_vip-server¶

Specification Value

Type object

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

Type: List

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

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 Value

Type list

Block object keys

ipv4

Description Specify IP address

Type: string

Format: ipv4-address

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

slb-dev-list_vip-server_vip-server-v4-list_sampling-enable¶

Specification Value

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 Value

Type list

Block object keys

ipv6

Description Specify IP address (IPv6 address)

Type: string

Format: ipv6-address

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

slb-dev-list_vip-server_vip-server-v6-list_sampling-enable¶

Specification Value

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 Value

Type list

Block object keys

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vip-name

Description Specify a VIP name for the SLB device

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

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

slb-dev-list_vip-server_vip-server-name-list_sampling-enable¶

Specification Value

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

multiple-geo-locations¶

Specification Value

Type list

Block object keys

geo-location

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

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

easy-rdt¶

Specification Value

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

ipv6-mask

Description Client IPv6 subnet mask, default is 128

Type: number

Range: 1-128

Default: 128

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

Maximum Length: 64 characters

Maximum Length: 1 characters

active-rdt¶

Specification Value

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

ipv6-mask

Description Client IPv6 subnet mask, default is 128

Type: number

Range: 1-128

Default: 128

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

Maximum Length: 64 characters

Maximum Length: 1 characters