.. _hsm:

hsm
===

Hardware Security Module commands


hsm Specification
-----------------

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

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

	 **Element Name**                      hsm

	 **Element URI**                       /axapi/v3/hsm

	 **Element Attributes**                hsm_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


hsm_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _1865_hsm_attributes:

hsm attributes
--------------

    **template-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/hsm/template/{template-name} <hsm_template>`

.. _1865_template-list:

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

	 **Block object keys**             

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

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

.. _1865_template-list_hsm-dev:

template-list_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