.. _scaleout_cluster_cluster_devices_device_id:

scaleout cluster cluster-devices device-id
==========================================

Configure Scaleout devices


device-id Specification
-----------------------

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

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

	 **Object Key(s)**                     *device-id*

	 **Collection Name**                   :ref:`2594_device-id_list`

	 **Collection URI**                    /axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/device-id

	                                       

	 **Element Name**                      device-id

	 **Element URI**                       /axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/device-id/{device-id}

	 **Element Attributes**                device-id_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`device-id schema <scaleout-cluster-cluster-devices-device-id/scaleout-cluster-cluster-devices-device-id.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/scaleout/cluster/{cluster-id}/cluster-devices/device-id



.. raw:: html

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


:ref:`2594_device-id_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/scaleout/cluster/{cluster-id}/cluster-devices/device-id



.. raw:: html

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


:ref:`2594_device-id_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/scaleout/cluster/{cluster-id}/cluster-devices/device-id/{device-id}



.. raw:: html

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


:ref:`2594_device-id_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/scaleout/cluster/{cluster-id}/cluster-devices/device-id



.. raw:: html

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


:ref:`2594_device-id_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/scaleout/cluster/{cluster-id}/cluster-devices/device-id/{device-id}



.. raw:: html

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


:ref:`2594_device-id_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/scaleout/cluster/{cluster-id}/cluster-devices/device-id/{device-id}



.. raw:: html

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


:ref:`2594_device-id_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/scaleout/cluster/{cluster-id}/cluster-devices/device-id



.. raw:: html

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


:ref:`2594_device-id_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/scaleout/cluster/{cluster-id}/cluster-devices/device-id/{device-id}



.. raw:: html

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


:ref:`2594_device-id_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2594_device-id_list:

device-id-list
--------------


    device-id-list is **JSON List** of :ref:`2594_device-id_attributes` 

        device-id-list : [

             { :ref:`2594_device-id_attributes` },

             { :ref:`2594_device-id_attributes` },

             ...

         ]

.. _2594_device-id_attributes:

device-id attributes
--------------------

    **action**

        **Description** 'enable': enable; 'disable': disable; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **ip**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters