.. _glm:

glm
===

Set GLM Connection values


glm Specification
-----------------

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

	 **Element Name**                      glm

	 **Element URI**                       /axapi/v3/glm

	 **Element Attributes**                glm_attributes

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



.. raw:: html

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


:ref:`701_glm_attributes`



.. raw:: html

   </td><td></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/glm



.. raw:: html

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


:ref:`701_glm_attributes`



.. raw:: html

   </td><td></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/glm



.. raw:: html

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


:ref:`701_glm_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/glm



.. raw:: html

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


:ref:`701_glm_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

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


DELETE



.. raw:: html

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


/axapi/v3/glm



.. raw:: html

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


:ref:`701_glm_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _701_glm_attributes:

glm attributes
--------------

    **allocate-bandwidth**

        **Description** Enter the requested bandwidth in Mbps for Capacity Pool

        **Type:** number

        **Range:** 2-204800

    **appliance-name**

        **Description** Helpful identifier for this appliance

        **Type:** string

        **Maximum Length:** 60 characters

        **Maximum Length:** 1 characters

    **check-expiration**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

    **enable-requests**

        **Description** Enable connection to the GLM

        **Type:** boolean

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

        **Default:** 0

    **enterprise**

        **Description** Enter the ELM hostname or IP

        **Type:** string

        **Maximum Length:** 60 characters

        **Maximum Length:** 4 characters

    **host**

        **Description** Configure GLM host default is glm.a10networks.com

        **Type:** string

        **Maximum Length:** 60 characters

        **Maximum Length:** 4 characters

    **interval**

        **Description** Enter the desired ping interval in hours

        **Type:** number

        **Range:** 1-8760

    **port**

        **Description** License request port (default 443)

        **Type:** number

        **Range:** 1-65535

    **proxy-server**

        **Description:** proxy-server is a **JSON Block**.  Please see below for :ref:`701_proxy-server` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/glm/proxy-server <glm_proxy_server>`

    **send**

        **Description:** send is a **JSON Block**.  Please see below for :ref:`701_send` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/glm/send <glm_send>`

    **token**

        **Description** License entitlement token

        **Type:** string

        **Maximum Length:** 60 characters

        **Maximum Length:** 8 characters

    **use-mgmt-port**

        **Description** Use management port to connect to GLM

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

.. _701_send:

send
^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **license-request**

        **Description** Do a single GLM license retrieval

        **Type:** boolean

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

        **Default:** 0

.. _701_proxy-server:

proxy-server
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **encrypted**

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

    **host**

        **Description** Proxy server hostname or IP address

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **password**

        **Description** Password for proxy authentication

        **Type:** boolean

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

        **Default:** 0

    **port**

        **Description** Proxy server port

        **Type:** number

        **Range:** 1-65535

    **secret-string**

        **Description** password value

        **Type:** string

        **Format:** password

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **username**

        **Description** Username for proxy authentication

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters