cgnv6 service-group¶
Service Group
service-group Specification¶
Type
Collection
Object Key(s)
name
Collection Name
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
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/cgnv6/service-group | ||
Create List | POST | /axapi/v3/cgnv6/service-group | ||
Get Object | GET | /axapi/v3/cgnv6/service-group/{name} | ||
Get List | GET | /axapi/v3/cgnv6/service-group | ||
Modify Object | POST | /axapi/v3/cgnv6/service-group/{name} | ||
Replace Object | PUT | /axapi/v3/cgnv6/service-group/{name} | ||
Replace List | PUT | /axapi/v3/cgnv6/service-group | ||
Delete Object | DELETE | /axapi/v3/cgnv6/service-group/{name} |
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
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/health/monitor
member-list
Type: List
Refernce 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
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
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
Refernce Object: /axapi/v3/cgnv6/server
port
Description Port number
Type: number
Range: 0-65534
Default: 65534
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
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 |