.. _license_manager:

license-manager
===============

Configure license manager


license-manager Specification
-----------------------------

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

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

	 **Element Name**                      license-manager

	 **Element URI**                       /axapi/v3/license-manager

	 **Element Attributes**                license-manager_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2220_license-manager_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/license_manager_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/license-manager



.. raw:: html

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


:ref:`2220_license-manager_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/license-manager



.. raw:: html

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


:ref:`2220_license-manager_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/license-manager



.. raw:: html

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


:ref:`2220_license-manager_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/license-manager



.. raw:: html

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


:ref:`2220_license-manager_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2220_license-manager_attributes:

license-manager attributes
--------------------------

    **bandwidth-base**

        **Description** Configure feature bandwidth base (Mb)

        **Type:** number

        **Range:** 10-102400

    **bandwidth-unrestricted**

        **Description** Set the bandwidth to maximum

        **Type:** boolean

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

        **Default:** 0

    **connect**

        **Description:** connect is a **JSON Block**.  Please see below for :ref:`2220_connect` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/license-manager/connect <license_manager_connect>`

    **host-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/license-manager/host/{host-ipv4}+{host-ipv6} <license_manager_host>`

    **instance-name**

        **Description** Configure instance name [format: (string).(string).(string).(string)]

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 7 characters

    **interval**

        **Description** Configure interval profile (1 monthly, 2 daily, 3 hourly)

        **Type:** number

        **Range:** 1-3

    **ng-waf-module**

        **Description:** ng-waf-module is a **JSON Block**.  Please see below for :ref:`2220_ng-waf-module` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/license-manager/ng-waf-module <license_manager_ng_waf_module>`

    **overage**

        **Description:** overage is a **JSON Block**.  Please see below for :ref:`2220_overage` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/license-manager/overage <license_manager_overage>`

    **reminder-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/license-manager/reminder/{reminder-value} <license_manager_reminder>`

    **sn**

        **Description** serial number

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **use-mgmt-port**

        **Description** Use management port to connect license server

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

.. _2220_connect:

connect
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **connect**

        **Description** Connect to license manager to activate

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

.. _2220_reminder-list:

reminder-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **reminder-value**

        **Description** Configure reminder for grace time (Hour)

        **Type:** number

        **Range:** 1-1000000

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2220_ng-waf-module:

ng-waf-module
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **access-key-id**

        **Description** access-key

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **secret-access-key**

        **Description** 

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2220_overage:

overage
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **bytes**

        **Description** Number of bytes

        **Type:** number

        **Range:** 1-1023

    **days**

        **Description** Number of days

        **Type:** number

        **Range:** 0-365

    **gb**

        **Description** Number of GB

        **Type:** number

        **Range:** 1-65535

    **hours**

        **Description** Number of hours

        **Type:** number

        **Range:** 0-23

    **kb**

        **Description** Number of KB

        **Type:** number

        **Range:** 1-1023

    **mb**

        **Description** Number of MB

        **Type:** number

        **Range:** 1-1023

    **minutes**

        **Description** Number of minutes

        **Type:** number

        **Range:** 0-59

    **seconds**

        **Description** Number of seconds

        **Type:** number

        **Range:** 0-59

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2220_host-list:

host-list
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **host-ipv4**

        **Description** license server ip address (length:1-31)

        **Type:** string

        **Format:** host

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **host-ipv6**

        **Description** Configure license manager server ipv6-address

        **Type:** string

        **Format:** ipv6-address

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **port**

        **Description** Configure the license manager port, default is 443

        **Type:** number

        **Range:** 1-65535

        **Default:** 443

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters