.. _ntp:

ntp
===

Network Time Protocol configuration


ntp Specification
-----------------

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

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

	 **Element Name**                      ntp

	 **Element URI**                       /axapi/v3/ntp

	 **Element Attributes**                ntp_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


ntp_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2393_ntp_attributes:

ntp attributes
--------------

    **auth-key-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ntp/auth-key/{key} <ntp_auth_key>`

    **ntp-global**

        **Description:** ntp-global is a **JSON Block**.  Please see below for :ref:`2393_ntp-global` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ntp/ntp-global <ntp_ntp_global>`

    **server**

        **Description:** server is a **JSON Block**.  Please see below for :ref:`2393_server` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ntp/server <ntp_server>`

    **trusted-key-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ntp/trusted-key/{key} <ntp_trusted_key>`

.. _2393_auth-key-list:

auth-key-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **alg-type**

        **Description** 'M': encryption using MD5; 'SHA': encryption using SHA; 'SHA1': encryption using SHA1; 

        **Type:** string

        **Supported Values:** M, SHA, SHA1

    **asc-key**

        **Description** 

        **Type:** string

        **Format:** password

        **Maximum Length:** 20 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** asc-key and hex-key are mutually exclusive

    **encrypted**

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

        **Mutual Exclusion:** encrypted and hex-encrypted are mutually exclusive

    **hex-encrypted**

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

        **Mutual Exclusion:** hex-encrypted and encrypted are mutually exclusive

    **hex-key**

        **Description** 

        **Type:** string

        **Format:** password

        **Maximum Length:** 40 characters

        **Maximum Length:** 21 characters

        **Mutual Exclusion:** hex-key and asc-key are mutually exclusive

    **key**

        **Description** authentication key

        **Type:** number

        **Range:** 1-65535

    **key-type**

        **Description** 'ascii': key string in ASCII form; 'hex': key string in hex form; 

        **Type:** string

        **Supported Values:** ascii, hex

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2393_trusted-key-list:

trusted-key-list
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **key**

        **Description** trusted key

        **Type:** number

        **Range:** 1-65535

        **Reference Object:** :doc:`/axapi/v3/ntp/auth-key <ntp_auth_key>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2393_ntp-global:

ntp-global
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **allow-data-ports**

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

.. _2393_server:

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

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

    **hostname-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ntp/server/hostname/{host-servername} <ntp_server_hostname>`

.. _2393_server_hostname-list:

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

	 **Block object keys**             

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

    **action**

        **Description** 'enable': Enable this NTP server; 'disable': Disable this NTP server; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **host-servername**

        **Description** IPV4 address, IPV6 address or host name of NTP server(string1~63)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **key**

        **Description** Use trusted key to authenticate this NTP server (The trusted key number to use)

        **Type:** number

        **Range:** 1-65535

        **Reference Object:** :doc:`/axapi/v3/ntp/trusted-key <ntp_trusted_key>`

    **prefer**

        **Description** Set this NTP server as preferred

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