gslb site slb-dev¶
Specify a SLB device for the GSLB site
slb-dev Specification¶
Type
Collection
Object Key(s)
device-name
Collection Name
Collection URI
/axapi/v3/gslb/site/{site-name}/slb-dev
Element Name
slb-dev
Element URI
/axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}
Element Attributes
slb-dev_attributes
Operational Data URI
/axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/oper
Schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Create Object | POST | /axapi/v3/gslb/site/{site-name}/slb-dev | ||
Create List | POST | /axapi/v3/gslb/site/{site-name}/slb-dev | ||
Get Object | GET | /axapi/v3/gslb/site/{site-name}/slb-dev/{device-name} | ||
Get List | GET | /axapi/v3/gslb/site/{site-name}/slb-dev | ||
Modify Object | POST | /axapi/v3/gslb/site/{site-name}/slb-dev/{device-name} | ||
Replace Object | PUT | /axapi/v3/gslb/site/{site-name}/slb-dev/{device-name} | ||
Replace List | PUT | /axapi/v3/gslb/site/{site-name}/slb-dev | ||
Delete Object | DELETE | /axapi/v3/gslb/site/{site-name}/slb-dev/{device-name} |
slb-dev-list¶
slb-dev-list is JSON List of slb-dev attributes
slb-dev-list : [
]
slb-dev attributes¶
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
dev-resolve-as
Description ‘resolve-to-ipv4’: Use A Query only to resolve FQDN (Default Query type); ‘resolve-to-ipv6’: Use AAAA Query only to resolve FQDN; ‘resolve-to-ipv4-and-ipv6’: Use A as well as AAAA Query to resolve FQDN;
Type: string
Supported Values: resolve-to-ipv4, resolve-to-ipv6, resolve-to-ipv4-and-ipv6
Default: resolve-to-ipv4
device-name
Description Specify SLB device name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
domain
Description Device hostname
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: domain ip-address and ipv6-address are mutually exclusive
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
Mutual Exclusion: ip-address and domain are mutually exclusive
ipv6-address
Description IPv6 address
Type: string
Format: ipv6-address
Mutual Exclusion: ipv6-address and domain are mutually exclusive
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 vip-server
Type: Object
Refernce Object: /axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server
vip-server¶
Specification
Type
object
vip-server-name-list
Type: List
Refernce Object: /axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server/vip-server-name/{vip-name}
vip-server-v4-list
Type: List
Refernce Object: /axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server/vip-server-v4/{ipv4}
vip-server-v6-list
Type: List
Refernce Object: /axapi/v3/gslb/site/{site-name}/slb-dev/{device-name}/vip-server/vip-server-v6/{ipv6}
vip-server_vip-server-v4-list¶
Specification
Type
list
Block object keys
ipv4
Description Specify IP address
Type: string
Format: ipv4-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vip-server_vip-server-v6-list¶
Specification
Type
list
Block object keys
ipv6
Description Specify IP address (IPv6 address)
Type: string
Format: ipv6-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vip-server_vip-server-name-list¶
Specification
Type
list
Block object keys
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
Refernce Object: /axapi/v3/gslb/service-ip
operational data¶
Counter |
Size |
Description |
|
---|---|---|---|
dev_gw_state |
string |
dev_gw_state |
|
dev_attr |
string |
dev_attr |
|
dev_ip_cnt |
number |
dev_ip_cnt |
|
dev_name |
string |
dev_name |
|
dev_ip |
string |
dev_ip |
|
dev-state |
string |
dev-state |
|
dev_session_num |
number |
dev_session_num |
|
dev_admin_preference |
number |
dev_admin_preference |
|
client-ldns-list |
client-ldns-list |
||
dev_session_util |
number |
dev_session_util |