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

Get Stats

GET

/axapi/v3/cgnv6/service-group/{name}/stats

stats data

Get Oper

GET

/axapi/v3/cgnv6/service-group/{name}/oper

operational data

service-group-list

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

service-group-list : [

service-group Attributes

health-check

Description: Health Check (Monitor Name)

Type: string

Reference Object: /axapi/v3/health/monitor

member-list

Description: member-list is a JSON List . Please see below for 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

Required: Yes

protocol

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

Type: string

Supported Values: tcp, udp

sampling-enable

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

Type: List

shared-group

Description: Share with a partition group (Partition Group Name)

Type: string

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

shared-partition

Description: Share with a single partition (Partition Name)

Type: string

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

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; ‘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

Required: Yes

Reference Object: /axapi/v3/cgnv6/server

port

Description: Port number

Type: number

Range: 0-65534

Default: 65534

Reference Object: /axapi/v3/cgnv6/server/port

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

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;

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

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

Name Type Description
state enum Output contains one of the following values: - All Up, Functional Up, Partial Up, Down, Disabled, Unknown
servers_down number servers_down
servers_up number servers_up
servers_disable number servers_disable
servers_total number servers_total