.. _harmony_controller:

harmony-controller
==================

Harmony controller information


harmony-controller Specification
--------------------------------

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

	 **Element Name**                      harmony-controller

	 **Element URI**                       /axapi/v3/harmony-controller

	 **Element Attributes**                harmony-controller_attributes

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



.. raw:: html

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


harmony-controller_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _946_harmony-controller_attributes:

harmony-controller attributes
-----------------------------

    **profile**

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

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/harmony-controller/profile <harmony_controller_profile>`

    **telemetry**

        **Description:** telemetry is a **JSON Block**.  Please see below for :ref:`946_telemetry` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/harmony-controller/telemetry <harmony_controller_telemetry>`

.. _946_profile:

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

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

    **action**

        **Description** 'enable': Register the device to the controller; 'disable': Deregister the device from controller; 

        **Type:** string

        **Supported Values:** register, deregister

    **availability-zone**

        **Description** availablity zone of the thunder-device

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **host**

        **Description** Set harmony controller host adddress

        **Type:** string

        **Format:** host

    **metrics-export-interval**

        **Description** metrics export interval in seconds, default is 60 (metrics export interval in seconds, default is 60 seconds)

        **Type:** number

        **Range:** 15-300

        **Default:** 60

    **password-encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

    **port**

        **Description** Set port for remote Harmony Controller, default is 8443

        **Type:** number

        **Range:** 1-32767

        **Default:** 8443

    **provider**

        **Description** provider for the harmony-controller

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **region**

        **Description** region of the thunder-device

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **secret-value**

        **Description** The controller tenant password

        **Type:** string

        **Format:** password

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **thunder-mgmt-ip**

        **Description:** thunder-mgmt-ip is a **JSON Block**.  Please see below for :ref:`946_profile_thunder-mgmt-ip` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/harmony-controller/profile/thunder-mgmt-ip <harmony_controller_profile_thunder_mgmt_ip>`

    **use-mgmt-port**

        **Description** Use management port for connections

        **Type:** boolean

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

        **Default:** 0

    **user-name**

        **Description** user-name for the tenant

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _946_profile_thunder-mgmt-ip:

profile_thunder-mgmt-ip
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ip-address**

        **Description** IP address (IPv4 address)

        **Type:** string

        **Format:** ipv4-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _946_telemetry:

telemetry
^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **log-rate**

        **Description** Max number of session logs sent by the partition per second

        **Type:** number

        **Range:** 0-10000

        **Default:** 1

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters