.. _slb_server_oper:

slb server oper
===============

Operational Status for the object server


server Specification
--------------------

	===================================== ===============================================================
	 **Parameter**                         **Value** 

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

	 **Collection Name**                   :ref:`2872_server_list`

	 **Collection URI**                    /axapi/v3/slb/server/{name}

	                                       

	 **Element Name**                      server

	 **Element URI**                       /axapi/v3/slb/server/{name}/oper

	 **Element Attributes**                server_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`server schema <slb-server-oper/slb-server-oper.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/slb/server/{name}



.. raw:: html

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


:ref:`2872_server_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/slb/server/{name}



.. raw:: html

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


:ref:`2872_server_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/slb/server/{name}/oper



.. raw:: html

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


:ref:`2872_server_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/slb/server/{name}



.. raw:: html

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


:ref:`2872_server_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/slb/server/{name}/oper



.. raw:: html

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


:ref:`2872_server_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/slb/server/{name}/oper



.. raw:: html

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


:ref:`2872_server_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/slb/server/{name}



.. raw:: html

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


:ref:`2872_server_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/slb/server/{name}/oper



.. raw:: html

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


:ref:`2872_server_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2872_server_list:

server-list
-----------


    server-list is **JSON List** of :ref:`2872_server_attributes` 

        server-list : [

             { :ref:`2872_server_attributes` },

             { :ref:`2872_server_attributes` },

             ...

         ]

.. _2872_server_attributes:

server attributes
-----------------

    **name**

        **Description** Server Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`2872_oper` 

        **Type:** Object

    **port-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/slb/server/{name}/port/{port-number}+{protocol} <slb_server>`

.. _2872_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **conn_rate_unit**

        **Description** 

        **Type:** string

    **creation_type**

        **Description** 

        **Type:** string

    **curr_conn_rate**

        **Description** 

        **Type:** number

    **curr_observe_rate**

        **Description** 

        **Type:** number

    **disable**

        **Description** 

        **Type:** number

    **dns_update_time**

        **Description** 

        **Type:** string

    **drs-list**

        **Type:** List

    **is_autocreate**

        **Description** 

        **Type:** number

    **server_ttl**

        **Description** 

        **Type:** number

    **slow_start_conn_limit**

        **Description** 

        **Type:** number

    **srv_gateway_arp**

        **Description** 

        **Type:** string

        **Format:** mac-address

        **Maximum Length:** 17 characters

        **Maximum Length:** 11 characters

    **state**

        **Description** 

        **Type:** string

        **Supported Values:** Up, Down, Disabled, Maintenance, Unknown, Functional Up, DIS-UP, DIS-DOWN, DIS-MAINTENANCE, DIS-EXCEED-RATE, DIS-UNKNOWN

    **weight**

        **Description** 

        **Type:** number

.. _2872_oper_drs-list:

oper_drs-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **drs-conn_rate_unit**

        **Description** 

        **Type:** string

    **drs-creation_type**

        **Description** 

        **Type:** string

    **drs-curr-conn**

        **Description** 

        **Type:** number

    **drs-curr-req**

        **Description** 

        **Type:** number

    **drs-curr_conn_rate**

        **Description** 

        **Type:** number

    **drs-curr_observe_rate**

        **Description** 

        **Type:** number

    **drs-disable**

        **Description** 

        **Type:** number

    **drs-dns_update_time**

        **Description** 

        **Type:** string

    **drs-host**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **drs-is_autocreate**

        **Description** 

        **Type:** number

    **drs-name**

        **Description** 

        **Type:** string

    **drs-peak-conn**

        **Description** 

        **Type:** number

    **drs-server-ipv6-addr**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **drs-server_ttl**

        **Description** 

        **Type:** number

    **drs-slow_start_conn_limit**

        **Description** 

        **Type:** number

    **drs-srv_gateway_arp**

        **Description** 

        **Type:** string

        **Format:** mac-address

        **Maximum Length:** 17 characters

        **Maximum Length:** 11 characters

    **drs-state**

        **Description** 

        **Type:** string

        **Supported Values:** Up, Down, Disabled, Maintenance, Unknown, Functional Up, DIS-UP, DIS-DOWN, DIS-MAINTENANCE, DIS-EXCEED-RATE, DIS-UNKNOWN

    **drs-tot-conn**

        **Description** 

        **Type:** number

    **drs-tot-fwd-bytes**

        **Description** 

        **Type:** number

    **drs-tot-fwd-pkts**

        **Description** 

        **Type:** number

    **drs-tot-req**

        **Description** 

        **Type:** number

    **drs-tot-req-suc**

        **Description** 

        **Type:** number

    **drs-tot-rev-bytes**

        **Description** 

        **Type:** number

    **drs-tot-rev-pkts**

        **Description** 

        **Type:** number

    **drs-weight**

        **Description** 

        **Type:** number

.. _2872_port-list:

port-list
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`2872_port-list_oper` 

        **Type:** Object

    **port-number**

        **Description** Port Number

        **Type:** number

        **Range:** 0-65534

    **protocol**

        **Description** 'tcp': TCP Port; 'udp': UDP Port; 

        **Type:** string

        **Supported Values:** tcp, udp

.. _2872_port-list_oper:

port-list_oper
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **aflow_conn_limit**

        **Description** 

        **Type:** number

    **aflow_queue_size**

        **Description** 

        **Type:** number

    **auto-nat-addr-list**

        **Type:** List

    **conn_rate_unit**

        **Description** 

        **Type:** string

    **curr_conn_rate**

        **Description** 

        **Type:** number

    **curr_observe_rate**

        **Description** 

        **Type:** number

    **current_time**

        **Description** 

        **Type:** number

    **diameter_enabled**

        **Description** 

        **Type:** number

    **disable**

        **Description** 

        **Type:** number

    **down_grace_period_allowed**

        **Description** 

        **Type:** number

    **down_time_grace_period**

        **Description** 

        **Type:** number

    **drs-auto-nat-list**

        **Type:** List

    **drs-ip-nat-list**

        **Type:** List

    **es_resp_time**

        **Description** 

        **Type:** number

    **hm-index**

        **Description** 

        **Type:** number

    **hm-key**

        **Description** 

        **Type:** number

    **inband_hm_reassign_num**

        **Description** 

        **Type:** number

    **nat-pool-addr-list**

        **Type:** List

    **pool_name**

        **Description** 

        **Type:** string

        **Format:** string-rlx

    **resv_conn**

        **Description** 

        **Type:** number

    **slow_start_conn_limit**

        **Description** 

        **Type:** number

    **soft_down_time**

        **Description** 

        **Type:** number

    **state**

        **Description** 

        **Type:** string

        **Supported Values:** Up, Down, Disabled, Maintenance, Unknown, DIS-UP, DIS-DOWN, DIS-MAINTENANCE, DIS-EXCEED-RATE, DIS-DAMP

.. _2872_port-list_oper_nat-pool-addr-list:

port-list_oper_nat-pool-addr-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **alloc_failed**

        **Description** 

        **Type:** number

    **nat_ip**

        **Description** 

        **Type:** string

    **ports_consumed**

        **Description** 

        **Type:** number

    **ports_consumed_total**

        **Description** 

        **Type:** number

    **ports_freed_total**

        **Description** 

        **Type:** number

.. _2872_port-list_oper_drs-ip-nat-list:

port-list_oper_drs-ip-nat-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **drs_name**

        **Description** 

        **Type:** string

    **drs_port**

        **Description** 

        **Type:** number

    **nat-pool-addr-list**

        **Type:** List

    **pool_name**

        **Description** 

        **Type:** string

        **Format:** string-rlx

.. _2872_port-list_oper_drs-ip-nat-list_nat-pool-addr-list:

port-list_oper_drs-ip-nat-list_nat-pool-addr-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **alloc_failed**

        **Description** 

        **Type:** number

    **nat_ip**

        **Description** 

        **Type:** string

    **ports_consumed**

        **Description** 

        **Type:** number

    **ports_consumed_total**

        **Description** 

        **Type:** number

    **ports_freed_total**

        **Description** 

        **Type:** number

.. _2872_port-list_oper_drs-auto-nat-list:

port-list_oper_drs-auto-nat-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **drs-auto-nat-address-list**

        **Type:** List

    **drs_name**

        **Description** 

        **Type:** string

    **drs_port**

        **Description** 

        **Type:** number

.. _2872_port-list_oper_drs-auto-nat-list_drs-auto-nat-address-list:

port-list_oper_drs-auto-nat-list_drs-auto-nat-address-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **alloc_failed**

        **Description** 

        **Type:** number

    **auto_nat_ip**

        **Description** 

        **Type:** string

    **ha_group_id**

        **Description** 

        **Type:** number

    **ip_rr**

        **Description** 

        **Type:** number

    **ports_consumed**

        **Description** 

        **Type:** number

    **ports_consumed_total**

        **Description** 

        **Type:** number

    **ports_freed_total**

        **Description** 

        **Type:** number

    **vrid**

        **Description** 

        **Type:** number

.. _2872_port-list_oper_auto-nat-addr-list:

port-list_oper_auto-nat-addr-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **alloc_failed**

        **Description** 

        **Type:** number

    **auto_nat_ip**

        **Description** 

        **Type:** string

    **ha_group_id**

        **Description** 

        **Type:** number

    **ip_rr**

        **Description** 

        **Type:** number

    **ports_consumed**

        **Description** 

        **Type:** number

    **ports_consumed_total**

        **Description** 

        **Type:** number

    **ports_freed_total**

        **Description** 

        **Type:** number

    **vrid**

        **Description** 

        **Type:** number