fw server port¶
Real Server Port
port Specification¶
Type
Collection
Object Key(s)
port-number, protocol
Collection Name
Collection URI
/axapi/v3/fw/server/{name}/port
Element Name
port
Element URI
/axapi/v3/fw/server/{name}/port/{port-number}+{protocol}
Element Attributes
port_attributes
Statistics Data URI
/axapi/v3/fw/server/{name}/port/{port-number}+{protocol}/stats
Operational Data URI
/axapi/v3/fw/server/{name}/port/{port-number}+{protocol}/oper
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/fw/server/{name}/port | ||
Create List | POST | /axapi/v3/fw/server/{name}/port | ||
Get Object | GET | /axapi/v3/fw/server/{name}/port/{port-number}+{protocol} | ||
Get List | GET | /axapi/v3/fw/server/{name}/port | ||
Modify Object | POST | /axapi/v3/fw/server/{name}/port/{port-number}+{protocol} | ||
Replace Object | PUT | /axapi/v3/fw/server/{name}/port/{port-number}+{protocol} | ||
Replace List | PUT | /axapi/v3/fw/server/{name}/port | ||
Delete Object | DELETE | /axapi/v3/fw/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
health-check
Description Health Check (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 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: 1-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 |
|
|---|---|---|---|
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 |
|
|---|---|---|---|
alloc_failed |
number |
alloc_failed |
|
vrid |
number |
vrid |
|
ha_group_id |
number |
ha_group_id |
|
ip |
ipv4-address |
ip |
|
ports_consumed |
number |
ports_consumed |
|
state |
enum |
Output contains one of the following values: - UP, DOWN, DELETE, DISABLED, MAINTENANCE |
|
ipv6 |
ipv6-address |
ipv6 |
|
ports_freed_total |
number |
ports_freed_total |
|
ports_consumed_total |
number |
ports_consumed_total |