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:

OperationMethodURIPayload

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

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

Maximum Length: 63 characters

Maximum Length: 1 characters

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

Reference Object: /axapi/v3/health/monitor

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

Type: List

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

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

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