gslb service-ip port

Server Port

port Specification

Type Collection
Object Key(s) port-num, port-proto
Collection Name port-list
Collection URI /axapi/v3/gslb/service-ip/{node-name}/port/
Element Name port
Element URI /axapi/v3/gslb/service-ip/{node-name}/port/{port-num}+{port-proto}
Element Attributes port_attributes
Statistics Data URI /axapi/v3/gslb/service-ip/{node-name}/port/{port-num}+{port-proto}/stats
Operational Data URI /axapi/v3/gslb/service-ip/{node-name}/port/{port-num}+{port-proto}/oper
Schema port schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/gslb/service-ip/{node-name}/port/

port Attributes

Create List

POST

/axapi/v3/gslb/service-ip/{node-name}/port/

port Attributes

Get Object

GET

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

port Attributes

Get List

GET

/axapi/v3/gslb/service-ip/{node-name}/port/

port-list

Modify Object

POST

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

port Attributes

Replace Object

PUT

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

port Attributes

Replace List

PUT

/axapi/v3/gslb/service-ip/{node-name}/port/

port-list

Delete Object

DELETE

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

port Attributes

Get Stats

GET

/axapi/v3/gslb/service-ip/{node-name}/port/{port-num}+{port-proto}/stats

stats data

Get Oper

GET

/axapi/v3/gslb/service-ip/{node-name}/port/{port-num}+{port-proto}/oper

operational data

port-list

port-list is JSON List of port Attributes

port-list : [

port Attributes

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

Required: Yes

port-proto

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

Type: string

Supported Values: tcp, udp

Required: Yes

sampling-enable

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

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

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

stats data

Counter Size Description
active 8 Active Servers
current 8 Current Connections

operational data

Name Type Description
use_gslb_state number use_gslb_state
gslb-protocol number gslb-protocol
service-port number service-port
dynamic number dynamic
tcp number tcp
disabled number disabled
state string state
local-protocol number local-protocol
manually-health-check number manually-health-check