.. _fw_server_port:

fw server port
==============

Real Server Port


port Specification
------------------

	===================================== =======================================================================================
	===================================== =======================================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *port-number, protocol*

	 **Collection Name**                   :ref:`813_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

	 **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 <fw-server-port/fw-server-port.txt>`
	===================================== =======================================================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/fw/server/{name}/port



.. raw:: html

   </td><td valign = 'top'>


:ref:`813_port_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/fw/server/{name}/port



.. raw:: html

   </td><td valign = 'top'>


:ref:`813_port_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/fw/server/{name}/port/{port-number}+{protocol}



.. raw:: html

   </td><td valign = 'top'>


:ref:`813_port_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/fw/server/{name}/port



.. raw:: html

   </td><td valign = 'top'>


:ref:`813_port_list`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/fw/server/{name}/port/{port-number}+{protocol}



.. raw:: html

   </td><td valign = 'top'>


:ref:`813_port_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/fw/server/{name}/port/{port-number}+{protocol}



.. raw:: html

   </td><td valign = 'top'>


:ref:`813_port_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/fw/server/{name}/port



.. raw:: html

   </td><td valign = 'top'>


:ref:`813_port_list`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/fw/server/{name}/port/{port-number}+{protocol}



.. raw:: html

   </td><td valign = 'top'>


:ref:`813_port_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _813_port_list:

port-list
---------


    port-list is **JSON List** of :ref:`813_port_attributes` 

        port-list : [

             { :ref:`813_port_attributes` },

             { :ref:`813_port_attributes` },

             ...

         ]

.. _813_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_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 <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

.. _813_sampling-enable:

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

.. _813_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - 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

.. _813_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - 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