gslb service-ip

Configure a service IP, which can be a virtual server’s or real server’s IP address.

service-ip Specification

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

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/gslb/service-ip/

service-ip Attributes

Create List

POST

/axapi/v3/gslb/service-ip/

service-ip Attributes

Get Object

GET

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

service-ip Attributes

Get List

GET

/axapi/v3/gslb/service-ip/

service-ip-list

Modify Object

POST

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

service-ip Attributes

Replace Object

PUT

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

service-ip Attributes

Replace List

PUT

/axapi/v3/gslb/service-ip/

service-ip-list

Delete Object

DELETE

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

service-ip Attributes

Get Stats

GET

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

stats data

Get Oper

GET

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

operational data

service-ip-list

service-ip-list is JSON List of service-ip Attributes

service-ip-list : [

service-ip Attributes

action

Description: ‘enable’: Enable this GSLB server; ‘disable’: Disable this GSLB server;

Type: string

Supported Values: enable, disable

Default: enable

external-ip

Description: Assigns an external IP address to the service IP. The external IP address allows a service IP that has an internal IP address to be reached from outside the internal network.

Type: string

Format: ipv4-address

health-check

Description: Name of the health check monitor.

Type: string

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

health-check-disable

Description: Disables the health-check monitor.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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

health-check-protocol-disable

Description: Disables the GSLB protocol health monitor.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-address

Description: IPv4 address of the virtual server or real server.

Type: string

Format: ipv4-address

ipv6

Description: Maps the specified IPv6 address to an IPv4 service IP. This option also requires IPv6 DNS AAAA support to be enabled in the GSLB policy.

Type: string

Format: ipv6-address

ipv6-address

Description: IPv6 address of the virtual server or real server.

Type: string

Format: ipv6-address

node-name

Description: Name of the service.

Type: string

Required: Yes

port-list

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

Type: List

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

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

port-list

Specification
Type list
Block object keys

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

port-proto

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

Type: string

Supported Values: tcp, udp

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

port-list.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

sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the service IP has been selected; ‘recent’: Recent hits;

Type: string

Supported Values: all, hits, recent

stats data

Counter Size Description
hits 8 Number of times the service IP has been selected
recent 8 Recent hits

operational data

Name Type Description
use_gslb_state number use_gslb_state
gslb-protocol number gslb-protocol
ip string ip
dynamic number dynamic
manually-health-check number manually-health-check
disabled number disabled
state string state
service-ip string service-ip
port-count number port-count
local-protocol number local-protocol
virtual-server number virtual-server