.. _hsm_template:

hsm template
============

HSM Template


template Specification
----------------------

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

	===================================== =====================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *template-name*

	 **Collection Name**                   :ref:`1864_template_list`

	 **Collection URI**                    /axapi/v3/hsm/template

	                                       

	 **Element Name**                      template

	 **Element URI**                       /axapi/v3/hsm/template/{template-name}

	 **Element Attributes**                template_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1864_template_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/hsm_template_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/hsm/template



.. raw:: html

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


:ref:`1864_template_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/hsm/template/{template-name}



.. raw:: html

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


:ref:`1864_template_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/hsm_template_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/hsm/template



.. raw:: html

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


:ref:`1864_template_list`



.. 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/hsm/template/{template-name}



.. raw:: html

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


:ref:`1864_template_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/hsm/template/{template-name}



.. raw:: html

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


:ref:`1864_template_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/hsm_template_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/hsm/template



.. raw:: html

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


:ref:`1864_template_list`



.. 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/hsm/template/{template-name}



.. raw:: html

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


:ref:`1864_template_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/hsm_template_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1864_template_list:

template-list
-------------


    template-list is **JSON List** of :ref:`1864_template_attributes` 

        template-list : [

             { :ref:`1864_template_attributes` },

             { :ref:`1864_template_attributes` },

             ...

         ]

.. _1864_template_attributes:

template attributes
-------------------

    **encrypted**

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

    **enroll-timeout**

        **Description** Specify Enroll Timeout

        **Type:** number

        **Range:** 10-1024

    **health-check-interval**

        **Description** Specify Thales HSM Health Check Interval

        **Type:** number

        **Range:** 3-60

    **hsm-dev**

        **Type:** List

    **password**

        **Description** Specify HSM Passphrase

        **Type:** boolean

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

        **Default:** 0

    **password-string**

        **Description** Password (minimum 4 characters)

        **Type:** string

        **Format:** password

        **Maximum Length:** 31 characters

        **Maximum Length:** 4 characters

    **protection**

        **Description** Specify Protection Method

        **Type:** boolean

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

        **Default:** 0

    **protection-module**

        **Description** Module

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** protection-module, protection-ocs, and softcard are mutually exclusive

    **protection-ocs**

        **Description** Operator Card Set

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** protection-ocs, protection-module, and softcard are mutually exclusive

    **protection-softcard-hash**

        **Description** Hash

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **rfs-ip**

        **Description** Specify Thales Remote File System

        **Type:** string

        **Format:** ipv4-address

    **rfs-port**

        **Description** Specify Port

        **Type:** number

        **Range:** 1-65535

    **sec-world**

        **Description** Security World Name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **softcard**

        **Description** Softcard

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** softcard, protection-module, and protection-ocs are mutually exclusive

    **softhsm-enum**

        **Description** 'softHSM': software implementation of a cryptographic store; 'thalesHSM': Thales HSM; 

        **Type:** string

        **Supported Values:** softHSM, thalesHSM

    **template-name**

        **Description** Specify Template name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **worker**

        **Description** Specify number of workers for each data CPU

        **Type:** number

        **Range:** 1-31

.. _1864_hsm-dev:

hsm-dev
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **hsm-ip**

        **Description** Specify HSM Device IP Address

        **Type:** string

        **Format:** ipv4-address

    **hsm-port**

        **Description** Specify Port

        **Type:** number

        **Range:** 1-65535

    **hsm-priority**

        **Description** Specify Priority

        **Type:** number

        **Range:** 1-100