cgnv6 server port¶
Real Server Port
port Specification¶
Type Collection Object Key(s) port-number, protocol Collection Name port-list Collection URI /axapi/v3/cgnv6/server/{name}/port Element Name port Element URI /axapi/v3/cgnv6/server/{name}/port/{port-number}+{protocol} Element Attributes port_attributes Statistics Data URI /axapi/v3/cgnv6/server/{name}/port/{port-number}+{protocol}/stats Operational Data URI /axapi/v3/cgnv6/server/{name}/port/{port-number}+{protocol}/oper Schema port schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/cgnv6/server/{name}/port | ||
Create List | POST | /axapi/v3/cgnv6/server/{name}/port | ||
Get Object | GET | /axapi/v3/cgnv6/server/{name}/port/{port-number}+{protocol} | ||
Get List | GET | /axapi/v3/cgnv6/server/{name}/port | ||
Modify Object | POST | /axapi/v3/cgnv6/server/{name}/port/{port-number}+{protocol} | ||
Replace Object | PUT | /axapi/v3/cgnv6/server/{name}/port/{port-number}+{protocol} | ||
Replace List | PUT | /axapi/v3/cgnv6/server/{name}/port | ||
Delete Object | DELETE | /axapi/v3/cgnv6/server/{name}/port/{port-number}+{protocol} |
port-list¶
port-list is JSON List of port attributes
port-list : [
]
port attributes¶
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
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
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
sampling-enable
Type: Listuser-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; ‘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
stats data¶
| Counter | Size | Description | |
|---|---|---|---|
| es_resp_invalid_http | 8 | Total non-http response | |
| curr_req | 8 | Current requests | |
| total_rev_pkts_inspected_good_status_code | 8 | Total reverse packets with good status code inspected | |
| es_resp_count | 8 | Total proxy Response | |
| total_fwd_bytes | 8 | Forward bytes | |
| es_resp_other | 8 | Response status other | |
| fastest_rsp_time | 8 | Fastest response time | |
| total_fwd_pkts | 8 | Forward packets | |
| es_req_count | 8 | Total proxy request | |
| es_resp_500 | 8 | Response status 500 | |
| peak_conn | 8 | Peak connections | |
| total_req | 8 | Total requests | |
| es_resp_400 | 8 | Response status 400 | |
| es_resp_300 | 8 | Response status 300 | |
| curr_conn | 8 | Current connections | |
| es_resp_200 | 8 | Response status 200 | |
| total_rev_bytes | 8 | Reverse bytes | |
| response_time | 8 | Response time | |
| total_conn | 8 | Total connections | |
| total_rev_pkts | 8 | Reverse packets | |
| total_req_succ | 8 | Total request success | |
| last_total_conn | 8 | Last total connections | |
| total_rev_pkts_inspected | 8 | Total reverse packets inspected | |
| slowest_rsp_time | 8 | Slowest response time |
operational data¶
| Counter | Size | Description | |
|---|---|---|---|
| down_grace_period_allowed | number | down_grace_period_allowed | |
| nat-pool-addr-list | nat-pool-addr-list | ||
| drs-ip-nat-list | drs-ip-nat-list | ||
| drs-auto-nat-list | drs-auto-nat-list | ||
| auto-nat-addr-list | auto-nat-addr-list | ||
| aflow_queue_size | number | aflow_queue_size | |
| current_time | number | current_time | |
| state | enum | Output contains one of the following values: - Up, Down, Disabled, Maintenance, Unknown, DIS-UP, DIS-DOWN, DIS-MAINTENANCE, DIS-EXCEED-RATE, DIS-DAMP | |
| slow_start_conn_limit | number | slow_start_conn_limit | |
| resv_conn | number | resv_conn | |
| pool_name | string-rlx | pool_name | |
| hm-index | number | hm-index | |
| down_time_grace_period | number | down_time_grace_period | |
| inband_hm_reassign_num | number | inband_hm_reassign_num | |
| curr_observe_rate | number | curr_observe_rate | |
| curr_conn_rate | number | curr_conn_rate | |
| disable | number | disable | |
| aflow_conn_limit | number | aflow_conn_limit | |
| diameter_enabled | number | diameter_enabled | |
| soft_down_time | number | soft_down_time | |
| hm-key | number | hm-key | |
| es_resp_time | number | es_resp_time | |
| conn_rate_unit | string | conn_rate_unit |