.. _fw_server_port: fw server port ============== Real Server Port port Specification ------------------ ===================================== ======================================================================================= **Parameter** **Value** ===================================== ======================================================================================= **Type** *Collection* **Object Key(s)** *port-number, protocol* **Collection Name** :ref:`1661_port_list` **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 **Partition Visibility** shared **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** :download:`port schema ` ===================================== ======================================================================================= **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/fw/server/{name}/port .. raw:: html :ref:`1661_port_attributes` .. raw:: html
Create List .. raw:: html POST .. raw:: html /axapi/v3/fw/server/{name}/port .. raw:: html :ref:`1661_port_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/fw/server/{name}/port/{port-number}+{protocol} .. raw:: html :ref:`1661_port_attributes` .. raw:: html
Get List .. raw:: html GET .. raw:: html /axapi/v3/fw/server/{name}/port .. raw:: html :ref:`1661_port_list` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/fw/server/{name}/port/{port-number}+{protocol} .. raw:: html :ref:`1661_port_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/fw/server/{name}/port/{port-number}+{protocol} .. raw:: html :ref:`1661_port_attributes` .. raw:: html
Replace List .. raw:: html PUT .. raw:: html /axapi/v3/fw/server/{name}/port .. raw:: html :ref:`1661_port_list` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/fw/server/{name}/port/{port-number}+{protocol} .. raw:: html :ref:`1661_port_attributes` .. raw:: html
.. _1661_port_list: port-list --------- port-list is **JSON List** of :ref:`1661_port_attributes` port-list : [ { :ref:`1661_port_attributes` }, { :ref:`1661_port_attributes` }, ... ] .. _1661_port_attributes: 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 **Reference Object:** :doc:`/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 **packet-capture-template** **Description** Name of the packet capture template to be bind with this object **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/fw-server-port-tmpl ` **port-number** **Description** Port Number **Type:** number **Range:** 1-65534 **protocol** **Description** 'tcp': TCP Port; 'udp': UDP Port; **Type:** string **Supported Values:** tcp, udp **sampling-enable** **Type:** List **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 .. _1661_sampling-enable: sampling-enable ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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