.. _system_config_mgmt:

system config-mgmt
==================

Setting of Configuration Management


config-mgmt Specification
-------------------------

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

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

	 **Element Name**                      config-mgmt

	 **Element URI**                       /axapi/v3/system/config-mgmt

	 **Element Attributes**                config-mgmt_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`config-mgmt schema <system-config-mgmt/system-config-mgmt.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/system/config-mgmt



.. raw:: html

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


:ref:`3310_config-mgmt_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/system_config_mgmt_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/system/config-mgmt



.. raw:: html

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


:ref:`3310_config-mgmt_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/system_config_mgmt_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/system/config-mgmt



.. raw:: html

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


:ref:`3310_config-mgmt_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/system/config-mgmt



.. raw:: html

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


:ref:`3310_config-mgmt_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3310_config-mgmt_attributes:

config-mgmt attributes
----------------------

    **delete-referenced-tagged-objects**

        **Description** 'enable': Allow deletion of referenced tagged objects. Default option.; 'disable': Block deletion of referenced tagged objects; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **mpm**

        **Description:** mpm is a **JSON Block**.  Please see below for :ref:`3310_mpm` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/config-mgmt/mpm <system_config_mgmt_mpm>`

    **pu-sync-detection**

        **Description:** pu-sync-detection is a **JSON Block**.  Please see below for :ref:`3310_pu-sync-detection` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/system/config-mgmt/pu-sync-detection <system_config_mgmt_pu_sync_detection>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3310_pu-sync-detection:

pu-sync-detection
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **action**

        **Description** 'enable': Enable pu-sync-detection feature; 'disable': Disable pu-sync-detection feature; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **interval**

        **Description** Time interval (seconds) for detection. Default is 30 seconds.

        **Type:** number

        **Range:** 30-86400

        **Default:** 30

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3310_mpm:

mpm
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **max-workers**

        **Description** Set max workers count. Default is 1

        **Type:** number

        **Range:** 1-50

        **Default:** 1

    **min-idle-workers**

        **Description** Set minimum idle workers count. Default is 1

        **Type:** number

        **Range:** 1-50

        **Default:** 1

    **start-workers**

        **Description** Set starting workers count. Default is 1

        **Type:** number

        **Range:** 1-50

        **Default:** 1

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters