.. _scaleout_cluster_cluster_devices:

scaleout cluster cluster-devices
================================

Configure devices in the cluster


cluster-devices Specification
-----------------------------

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

	===================================== ======================================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      cluster-devices

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

	 **Element Attributes**                cluster-devices_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2596_cluster-devices_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/scaleout_cluster_cluster_devices_POST.txt
   :literal:




.. raw:: html

   </div></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



.. raw:: html

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


:ref:`2596_cluster-devices_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/scaleout_cluster_cluster_devices_GET.txt
   :literal:




.. raw:: html

   </div></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



.. raw:: html

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


:ref:`2596_cluster-devices_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



.. raw:: html

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


:ref:`2596_cluster-devices_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/scaleout_cluster_cluster_devices_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2596_cluster-devices_attributes:

cluster-devices attributes
--------------------------

    **cluster-discovery-timeout**

        **Description:** cluster-discovery-timeout is a **JSON Block**.  Please see below for :ref:`2596_cluster-discovery-timeout` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/cluster-discovery-timeout <scaleout_cluster>`

    **device-id-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/device-id/{device-id} <scaleout_cluster>`

    **enable**

        **Description** 

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **minimum-nodes**

        **Description:** minimum-nodes is a **JSON Block**.  Please see below for :ref:`2596_minimum-nodes` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/minimum-nodes <scaleout_cluster>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2596_cluster-discovery-timeout:

cluster-discovery-timeout
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2596_device-id-list:

device-id-list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

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

.. _2596_minimum-nodes:

minimum-nodes
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **minimum-nodes-num**

        **Description** Specify the minimum number of the node required to start service

        **Type:** number

        **Range:** 0-16

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters