cgnv6 server¶
CGNV6 logging Server
server Specification¶
Type
Collection
Object Key(s)
name
Collection Name
Collection URI
/axapi/v3/cgnv6/server
Element Name
server
Element URI
/axapi/v3/cgnv6/server/{name}
Element Attributes
server_attributes
Statistics Data URI
/axapi/v3/cgnv6/server/{name}/stats
Operational Data URI
/axapi/v3/cgnv6/server/{name}/oper
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/cgnv6/server | ||
Create List | POST | /axapi/v3/cgnv6/server | ||
Get Object | GET | /axapi/v3/cgnv6/server/{name} | ||
Get List | GET | /axapi/v3/cgnv6/server | ||
Modify Object | POST | /axapi/v3/cgnv6/server/{name} | ||
Replace Object | PUT | /axapi/v3/cgnv6/server/{name} | ||
Replace List | PUT | /axapi/v3/cgnv6/server | ||
Delete Object | DELETE | /axapi/v3/cgnv6/server/{name} |
server-list¶
server-list is JSON List of server attributes
server-list : [
]
server attributes¶
action
Description ‘enable’: Enable this Real Server; ‘disable’: Disable this Real Server;
Type: string
Supported Values: enable, disable
Default: enable
fqdn-name
Description Server hostname
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
health-check
Description Health Check Monitor (Health monitor name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: health-check and health-check-disable are mutually exclusive
Refernce Object: /axapi/v3/health/monitor
health-check-disable
Description Disable configured health check configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: health-check-disable and health-check are mutually exclusive
host
Description IP Address
Type: string
Format: ipv4-address
name
Description Server Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
port-list
Type: List
Refernce Object: /axapi/v3/cgnv6/server/{name}/port/{port-number}+{protocol}
resolve-as
Description ‘resolve-to-ipv4’: Use A Query only to resolve FQDN; ‘resolve-to-ipv6’: Use AAAA Query only to resolve FQDN; ‘resolve-to-ipv4-and-ipv6’: Use A as well as AAAA Query to resolve FQDN;
Type: string
Supported Values: resolve-to-ipv4, resolve-to-ipv6, resolve-to-ipv4-and-ipv6
Default: resolve-to-ipv4
server-ipv6-addr
Description IPV6 address
Type: string
Format: ipv6-address
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; ‘disable’: disable;
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 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
Refernce Object: /axapi/v3/health/monitor
health-check-disable
Description Disable health check
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: health-check-disable and health-check 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 and health-check are mutually exclusive
port-number
Description Port Number
Type: number
Range: 0-65534
protocol
Description ‘tcp’: TCP Port; ‘udp’: UDP Port;
Type: string
Supported Values: tcp, udp
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 |
|
|---|---|---|---|
peak-conn |
8 |
Peak connections |
|
curr-conn |
8 |
Current connections |
|
rev-pkt |
8 |
Reverse Packets |
|
fwd-pkt |
8 |
Forward packets |
|
total-conn |
8 |
Total connections |
operational data¶
Counter |
Size |
Description |
|
|---|---|---|---|
conn_rate_unit |
string |
conn_rate_unit |
|
weight |
number |
weight |
|
dns_update_time |
string |
dns_update_time |
|
creation_type |
string |
creation_type |
|
server_ttl |
number |
server_ttl |
|
curr_observe_rate |
number |
curr_observe_rate |
|
curr_conn_rate |
number |
curr_conn_rate |
|
state |
enum |
Output contains one of the following values: - UP, DOWN, DELETE, DISABLED, MAINTENANCE |
|
disable |
number |
disable |
|
drs-list |
drs-list |
||
slow_start_conn_limit |
number |
slow_start_conn_limit |
|
is_autocreate |
number |
is_autocreate |
|
srv_gateway_arp |
mac-address |
srv_gateway_arp |