cgnv6 service-group

Service Group

service-group Specification

Type	Collection
Object Key(s)	name
Collection Name	service-group-list
Collection URI	/axapi/v3/cgnv6/service-group
Element Name	service-group
Element URI	/axapi/v3/cgnv6/service-group/{name}
Element Attributes	service-group_attributes
Statistics Data URI	/axapi/v3/cgnv6/service-group/{name}/stats
Operational Data URI	/axapi/v3/cgnv6/service-group/{name}/oper
Schema	service-group schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/cgnv6/service-group	service-group attributes
Create List	POST	/axapi/v3/cgnv6/service-group	service-group attributes
Get Object	GET	/axapi/v3/cgnv6/service-group/{name}	service-group attributes
Get List	GET	/axapi/v3/cgnv6/service-group	service-group-list
Modify Object	POST	/axapi/v3/cgnv6/service-group/{name}	service-group attributes
Replace Object	PUT	/axapi/v3/cgnv6/service-group/{name}	service-group attributes
Replace List	PUT	/axapi/v3/cgnv6/service-group	service-group-list
Delete Object	DELETE	/axapi/v3/cgnv6/service-group/{name}	service-group attributes

service-group-list

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

service-group-list : [

{ service-group attributes },

{ service-group attributes },

…

]

service-group attributes

health-check

Description Health Check (Monitor Name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/health/monitor

member-list

Type: List

Reference Object: /axapi/v3/cgnv6/service-group/{name}/member/{name}+{port}

name

Description CGNV6 Service Name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

protocol

Description ‘tcp’: TCP LB service; ‘udp’: UDP LB service;

Type: string

Supported Values: tcp, udp

sampling-enable

Type: List

shared

Description Share with partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

shared-group

Description Share with a partition group (Partition Group Name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: shared-group and shared-partition are mutually exclusive

shared-partition

Description Share with a single partition (Partition Name)

Type: string

Maximum Length: 14 characters

Maximum Length: 1 characters

Mutual Exclusion: shared-partition and shared-group are mutually exclusive

traffic-replication-mirror-ip-repl

Description Replaces IP with server-IP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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; ‘server_selection_fail_drop’: Service selection fail drop; ‘server_selection_fail_reset’: Service selection fail reset; ‘service_peak_conn’: Service peak connection;

Type: string

Supported Values: all, server_selection_fail_drop, server_selection_fail_reset, service_peak_conn

member-list

Specification
Type	list
Block object keys

name

Description Member name

Type: string

Format: comp-string

Maximum Length: 127 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/cgnv6/server

port

Description Port number

Type: number

Range: 0-65534

Default: 65534

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

member-list_sampling-enable

Specification
Type	list
Block object keys

counters1

Description ‘all’: all; ‘curr_conn’: Current connections; ‘total_fwd_bytes’: Total forward bytes; ‘total_fwd_pkts’: Total forward packets; ‘total_rev_bytes’: Total reverse bytes; ‘total_rev_pkts’: Total reverse packets; ‘total_conn’: Total connections; ‘total_rev_pkts_inspected’: Total reverse packets inspected; ‘total_rev_pkts_inspected_status_code_2xx’: Total reverse packets inspected status code 2xx; ‘total_rev_pkts_inspected_status_code_non_5xx’: Total reverse packets inspected status code non 5xx; ‘curr_req’: Current requests; ‘total_req’: Total requests; ‘total_req_succ’: Total requests success; ‘peak_conn’: Peak connections; ‘response_time’: Response time; ‘fastest_rsp_time’: Fastest response time; ‘slowest_rsp_time’: Slowest response time; ‘curr_ssl_conn’: Current SSL connections; ‘total_ssl_conn’: Total SSL connections; ‘curr_conn_overflow’: Current connection counter overflow count; ‘state_flaps’: State flaps count;

Type: string

Supported Values: all, curr_conn, total_fwd_bytes, total_fwd_pkts, total_rev_bytes, total_rev_pkts, total_conn, total_rev_pkts_inspected, total_rev_pkts_inspected_status_code_2xx, total_rev_pkts_inspected_status_code_non_5xx, curr_req, total_req, total_req_succ, peak_conn, response_time, fastest_rsp_time, slowest_rsp_time, curr_ssl_conn, total_ssl_conn, curr_conn_overflow, state_flaps

stats data

	Counter	Size	Description
	server_selection_fail_drop	8	Service selection fail drop
	server_selection_fail_reset	8	Service selection fail reset
	service_peak_conn	8	Service peak connection

operational data

	Counter	Size	Description
	pri_affinity_priority	number	pri_affinity_priority
	stateless_type	number	stateless_type
	servers_down	number	servers_down
	servers_total	number	servers_total
	servers_disable	number	servers_disable
	stateless_state	number	stateless_state
	filter	enum	Output contains one of the following values: - sgm-sort-config
	stateless_current_rate	number	stateless_current_rate
	state	enum	Output contains one of the following values: - All Up, Functional Up, Down, Disb, Unkn
	sgm-list		sgm-list
	servers_up	number	servers_up
	stateless_current_usage	number	stateless_current_usage
	hm_dsr_enable_all_vip	number	hm_dsr_enable_all_vip