.. _automatic_update:

automatic-update
================

Automatic update configuration


automatic-update Specification
------------------------------

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

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

	 **Element Name**                      automatic-update

	 **Element URI**                       /axapi/v3/automatic-update

	 **Element Attributes**                automatic-update_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`208_automatic-update_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/automatic_update_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/automatic-update



.. raw:: html

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


:ref:`208_automatic-update_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/automatic_update_GET.txt
   :literal:




.. raw:: html

   </div></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/automatic-update



.. raw:: html

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


:ref:`208_automatic-update_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/automatic-update



.. raw:: html

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


:ref:`208_automatic-update_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/automatic_update_PUT.txt
   :literal:




.. raw:: html

   </div></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/automatic-update



.. raw:: html

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


:ref:`208_automatic-update_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/automatic_update_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _208_automatic-update_attributes:

automatic-update attributes
---------------------------

    **check-now**

        **Description:** check-now is a **JSON Block**.  Please see below for :ref:`208_check-now` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/automatic-update/check-now <automatic_update_check_now>`

    **checknow**

        **Description:** checknow is a **JSON Block**.  Please see below for :ref:`208_checknow` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/automatic-update/checknow <automatic_update_checknow>`

    **config-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/automatic-update/config/{feature-name} <automatic_update_config>`

    **glm-source-url**

        **Description** Change GLM source url

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1024 characters

        **Maximum Length:** 1 characters

    **info**

        **Description:** info is a **JSON Block**.  Please see below for :ref:`208_info` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/automatic-update/info <automatic_update_info>`

    **proxy-server**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/automatic-update/proxy-server <automatic_update_proxy_server>`

    **reset**

        **Description:** reset is a **JSON Block**.  Please see below for :ref:`208_reset` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/automatic-update/reset <automatic_update_reset>`

    **revert**

        **Description:** revert is a **JSON Block**.  Please see below for :ref:`208_revert` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/automatic-update/revert <automatic_update_revert>`

    **use-mgmt-port**

        **Description** Use management port to connect

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

.. _208_info:

info
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _208_reset:

reset
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **feature-name**

        **Description** 'app-fw': Application Firewall; 'ca-bundle': CA Certificate Bundle; 

        **Type:** string

        **Supported Values:** app-fw, ca-bundle

.. _208_checknow:

checknow
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _208_revert:

revert
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **feature-name**

        **Description** 'app-fw': Application Firewall; 'a10-threat-intel': A10 Threat intel class list; 'central-cert-pin-list': Central updated cert pinning list; 

        **Type:** string

        **Supported Values:** app-fw, a10-threat-intel, central-cert-pin-list

.. _208_proxy-server:

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

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

    **auth-type**

        **Description** 'ntlm': NTLM authentication(default); 'basic': Basic authentication; 

        **Type:** string

        **Supported Values:** ntlm, basic

        **Default:** ntlm

    **domain**

        **Description** Realm for NTLM authentication

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **encrypted**

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

    **https-port**

        **Description** Proxy server HTTPs port

        **Type:** number

        **Range:** 1-65535

    **password**

        **Description** Password for proxy authentication

        **Type:** boolean

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

        **Default:** 0

    **proxy-host**

        **Description** Proxy server hostname or IP address

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

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

.. _208_check-now:

check-now
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **feature-name**

        **Description** 'app-fw': Application Firewall; 'ca-bundle': CA Certificate Bundle; 'a10-threat-intel': A10 Threat intel class list; 'central-cert-pin-list': Central updated cert pinning list; 

        **Type:** string

        **Supported Values:** app-fw, ca-bundle, a10-threat-intel, central-cert-pin-list

    **from-staging-server**

        **Description** Get files from GLM Staging storage

        **Type:** boolean

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

        **Default:** 0

    **prod-ver**

        **Description** update to this specific version, if this option is not configured, update to the latest version

        **Type:** string

        **Maximum Length:** 70 characters

        **Maximum Length:** 1 characters

    **stage-ver**

        **Description** update this specific version

        **Type:** string

        **Maximum Length:** 70 characters

        **Maximum Length:** 1 characters

.. _208_config-list:

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

	 **Block object keys**             

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

    **daily**

        **Description** Every day

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** daily and weekly are mutually exclusive

    **day-time**

        **Description** Time of day to update (hh:mm) in 24 hour local time

        **Type:** string

        **Format:** time-hhmm

    **debug**

        **Description** Enable libcurl debug option

        **Type:** boolean

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

        **Default:** 0

    **disable-ssl-verify**

        **Description** Disable peer server certificate verification

        **Type:** boolean

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

        **Default:** 0

    **feature-name**

        **Description** 'app-fw': Application Firewall Configuration; 'ca-bundle': CA Certificate Bundle; 'a10-threat-intel': A10 Threat intel class list; 'central-cert-pin-list': Central updated cert pinning list; 

        **Type:** string

        **Supported Values:** app-fw, ca-bundle, a10-threat-intel, central-cert-pin-list

    **schedule**

        **Description** 

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

    **week-day**

        **Description** 'Monday': Monday; 'Tuesday': Tuesday; 'Wednesday': Wednesday; 'Thursday': Thursday; 'Friday': Friday; 'Saturday': Saturday; 'Sunday': Sunday; 

        **Type:** string

        **Supported Values:** Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

    **week-time**

        **Description** Time of day to update (hh:mm) in 24 hour local time

        **Type:** string

        **Format:** time-hhmm

    **weekly**

        **Description** Every week

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** weekly and daily are mutually exclusive