gslb service-ip

Service IP

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

service-ip-list

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

service-ip-list : [

{ service-ip attributes },

{ service-ip attributes },

…

]

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 External IP address for NAT

Type: string

Format: ipv4-address

health-check

Description Health Check Monitor (Monitor Name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: health-check 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 and health-check are mutually exclusive

health-check-protocol-disable

Description Disable GSLB Protocol Health Monitor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-address

Description IP address

Type: string

Format: ipv4-address

ipv6

Description IPv6 address Mapping (Applicable only when service-ip has an IPv4 Address)

Type: string

Format: ipv6-address

ipv6-address

Description IPV6 address

Type: string

Format: ipv6-address

node-name

Description Service-IP Name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

port-list

Type: List

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

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

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

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

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

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