cgnv6 server

CGNV6 logging Server.

server Specification

Type Collection
Object Key(s) name
Collection Name server-list
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 server schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/cgnv6/server/

server Attributes

Create List

POST

/axapi/v3/cgnv6/server/

server Attributes

Get Object

GET

/axapi/v3/cgnv6/server/{name}

server Attributes

Get List

GET

/axapi/v3/cgnv6/server/

server-list

Modify Object

POST

/axapi/v3/cgnv6/server/{name}

server Attributes

Replace Object

PUT

/axapi/v3/cgnv6/server/{name}

server Attributes

Replace List

PUT

/axapi/v3/cgnv6/server/

server-list

Delete Object

DELETE

/axapi/v3/cgnv6/server/{name}

server Attributes

Get Stats

GET

/axapi/v3/cgnv6/server/{name}/stats

stats data

Get Oper

GET

/axapi/v3/cgnv6/server/{name}/oper

operational data

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

health-check

Description: Health Check Monitor (Health monitor name)

Type: string

Mutual Exclusion: health-check and health-check-disable are mutually exclusive

Reference 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

Required: Yes

port-list

Description: port-list is a JSON List . Please see below for port-list

Type: List

Reference Object: /axapi/v3/cgnv6/server/{name}/port/{port-number}+{protocol}

sampling-enable

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

Type: List

server-ipv6-addr

Description: IPV6 address

Type: string

Format: ipv6-address

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

port-list

Specification
Type list
Block object keys

action

Description: ‘enable’: enable; ‘disable’: disable;

Type: string

Supported Values: enable, disable

Default: enable

health-check

Description: Health Check (Monitor Name)

Type: string

Mutual Exclusion: health-check and health-check-disable are mutually exclusive

Reference 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

port-number

Description: Port Number

Type: number

Range: 0-65534

protocol

Description: ‘tcp’: TCP Port; ‘udp’: UDP Port;

Type: string

Supported Values: tcp, udp

sampling-enable

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

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

port-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘curr_conn’: Current connections; ‘curr_req’: Current requests; ‘total_req’: Total requests; ‘total_req_succ’: Total request success; ‘total_fwd_bytes’: Forward bytes; ‘total_fwd_pkts’: Forward packets; ‘total_rev_bytes’: Reverse bytes; ‘total_rev_pkts’: Reverse packets; ‘total_conn’: Total connections; ‘last_total_conn’: Last total connections; ‘peak_conn’: Peak connections; ‘es_resp_200’: Response status 200; ‘es_resp_300’: Response status 300; ‘es_resp_400’: Response status 400; ‘es_resp_500’: Response status 500; ‘es_resp_other’: Response status other; ‘es_req_count’: Total proxy request; ‘es_resp_count’: Total proxy Response; ‘es_resp_invalid_http’: Total non-http response; ‘total_rev_pkts_inspected’: Total reverse packets inspected; ‘total_rev_pkts_inspected_good_status_code’: Total reverse packets with good status code inspected; ‘response_time’: Response time; ‘fastest_rsp_time’: Fastest response time; ‘slowest_rsp_time’: Slowest response time;

Type: string

Supported Values: all, curr_conn, curr_req, total_req, total_req_succ, total_fwd_bytes, total_fwd_pkts, total_rev_bytes, total_rev_pkts, total_conn, last_total_conn, peak_conn, es_resp_200, es_resp_300, es_resp_400, es_resp_500, es_resp_other, es_req_count, es_resp_count, es_resp_invalid_http, total_rev_pkts_inspected, total_rev_pkts_inspected_good_status_code, response_time, fastest_rsp_time, slowest_rsp_time

sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘curr-conn’: Current connections; ‘total-conn’: Total connections; ‘fwd-pkt’: Forward packets; ‘rev-pkt’: Reverse Packets; ‘peak-conn’: Peak connections;

Type: string

Supported Values: all, curr-conn, total-conn, fwd-pkt, rev-pkt, peak-conn

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

Name Type Description
state enum Output contains one of the following values: - UP, DOWN, DELETE, DISABLED, MAINTENANCE