.. _call_home:

call-home
=========

Call home information


call-home Specification
-----------------------

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

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

	 **Element Name**                      call-home

	 **Element URI**                       /axapi/v3/call-home

	 **Element Attributes**                call-home_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


call-home_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _231_call-home_attributes:

call-home attributes
--------------------

    **profile**

        **Description:** profile is a **JSON Block**.  Please see below for :ref:`231_profile` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/call-home/profile <call_home_profile>`

.. _231_profile:

profile
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **action**

        **Description** 'register': Register the device to the portal; 'deregister': Deregister the device from the portal; 

        **Type:** string

        **Supported Values:** register, deregister

        **Default:** register

    **export-policy**

        **Description** 'restrictive': Export minimal information about system and config, default policy; 'permissive': Export as much as possible information about system, config and solution data; 

        **Type:** string

        **Supported Values:** restrictive, permissive

        **Default:** restrictive

    **ipv4**

        **Description** set IPV4 address for the host

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** ipv4, name, and ipv6 are mutually exclusive

    **ipv6**

        **Description** set IPV6 address for the host

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** ipv6, name, and ipv4 are mutually exclusive

    **name**

        **Description** set hostname url for the host

        **Type:** string

        **Format:** host

        **Mutual Exclusion:** name, ipv4, and ipv6 are mutually exclusive

    **port**

        **Description** Set port for the call home portal

        **Type:** number

        **Range:** 1-32767

    **time**

        **Description** Set export time of the data. default 0 (12 AM), default 0

        **Type:** number

        **Range:** 0-59

        **Default:** 0

    **use-mgmt-port**

        **Description** Use management port for connections

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters