.. _configure:

configure
=========

Configure sync Commands


configure Specification
-----------------------

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

	===================================== ==================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      configure

	 **Element URI**                       /axapi/v3/configure

	 **Element Attributes**                configure_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`configure schema <configure/configure.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'>


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/configure



.. raw:: html

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


configure_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _650_configure_attributes:

configure attributes
--------------------

    **sync**

        **Description:** sync is a **JSON Block**.  Please see below for :ref:`650_sync` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/configure/sync <configure_sync>`

.. _650_sync:

sync
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **address**

        **Description** Specify the destination ip address to sync

        **Type:** string

        **Format:** ipv4-address

    **all-partitions**

        **Description** All partition configurations

        **Type:** boolean

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

        **Default:** 0

    **auto-authentication**

        **Description** Authenticate with local username and password

        **Type:** boolean

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

        **Default:** 0

    **partition-name**

        **Description** Partition name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/partition <partition>`

    **private-key**

        **Description** Use private key for authentication

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **pwd**

        **Description** 

        **Type:** string

        **Format:** password

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **pwd-enc**

        **Description** 

    **shared**

        **Description** Shared partition

        **Type:** boolean

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

        **Default:** 0

    **type**

        **Description** 'running': Sync local running to peer's running configuration; 'all': Sync local running to peer's running configuration, and local startup to peer's startup configuration; 

        **Type:** string

        **Supported Values:** running, all

    **usr**

        **Description** 

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters