.. _fw_server_oper:

fw server oper
==============

Operational Status for the object server


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

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

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

	 **Collection Name**                   :ref:`1658_server_list`

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

	                                       

	 **Element Name**                      server

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

	 **Element Attributes**                server_attributes

	 **Partition Visibility**              None

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



.. raw:: html

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


:ref:`1658_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/fw/server/{name}



.. raw:: html

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


:ref:`1658_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/fw/server/{name}/oper



.. raw:: html

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


:ref:`1658_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/fw/server/{name}



.. raw:: html

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


:ref:`1658_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/fw/server/{name}/oper



.. raw:: html

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


:ref:`1658_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/fw/server/{name}/oper



.. raw:: html

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


:ref:`1658_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/fw/server/{name}



.. raw:: html

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


:ref:`1658_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/fw/server/{name}/oper



.. raw:: html

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


:ref:`1658_server_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1658_server_list:

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


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

        server-list : [

             { :ref:`1658_server_attributes` },

             { :ref:`1658_server_attributes` },

             ...

         ]

.. _1658_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:`1658_oper` 

        **Type:** Object

    **port-list**

        **Type:** List

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

.. _1658_oper:

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

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

    **state**

        **Description** 

        **Type:** string

        **Supported Values:** UP, DOWN, DELETE, DISABLED, MAINTENANCE

.. _1658_port-list:

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

	 **Block object keys**             

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

    **oper**

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

        **Type:** Object

    **port-number**

        **Description** Port Number

        **Type:** number

        **Range:** 1-65534

    **protocol**

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

        **Type:** string

        **Supported Values:** tcp, udp

.. _1658_port-list_oper:

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

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

    **alloc_failed**

        **Description** 

        **Type:** number

    **ha_group_id**

        **Description** 

        **Type:** number

    **ip**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **ipv6**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **ports_consumed**

        **Description** 

        **Type:** number

    **ports_consumed_total**

        **Description** 

        **Type:** number

    **ports_freed_total**

        **Description** 

        **Type:** number

    **state**

        **Description** 

        **Type:** string

        **Supported Values:** UP, DOWN, DELETE, DISABLED, MAINTENANCE

    **vrid**

        **Description** 

        **Type:** number