hsm

Hardware Security Module commands

hsm Specification

   
Type Intermediate Resource
Element Name hsm
Element URI /axapi/v3/hsm
Element Attributes hsm_attributes
Schema hsm schema

Operations Allowed:

OperationMethodURIPayload

Get Object

GET

/axapi/v3/hsm

hsm_attributes

hsm attributes

check

Description: check is a JSON Block. Please see below for check

Type: Object

Refernce Object: /axapi/v3/hsm/check

decommission

Description: decommission is a JSON Block. Please see below for decommission

Type: Object

Refernce Object: /axapi/v3/hsm/decommission

delete

Description: delete is a JSON Block. Please see below for delete

Type: Object

Refernce Object: /axapi/v3/hsm/delete

fw-upgrade

Description: fw-upgrade is a JSON Block. Please see below for fw-upgrade

Type: Object

Refernce Object: /axapi/v3/hsm/fw-upgrade

import

Description: import is a JSON Block. Please see below for import

Type: Object

Refernce Object: /axapi/v3/hsm/import

single-card-mode

Description: single-card-mode is a JSON Block. Please see below for single-card-mode

Type: Object

Refernce Object: /axapi/v3/hsm/single-card-mode

template-list

Type: List

Refernce Object: /axapi/v3/hsm/template/{template-name}

decommission

Specification  
Type object

dev_id

Description Decommission a HSM device-id

Type: number

Range: 0-3

template-list

Specification  
Type list
Block object keys  

encrypted

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

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

template-list_hsm-dev

Specification  
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

single-card-mode

Specification  
Type object

enable

Description Enable Single HSM Card Support

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

fw-upgrade

Specification  
Type object

all

Description Upgrade firmware on all HSM device-ids

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dev_id

Description Firmware upgrade on a HSM device-id

Type: number

Range: 0-3

file

Description firmware file name

Type: string

Maximum Length: 255 characters

Maximum Length: 1 characters

sign-file

Description firmware signature file name

Type: string

Maximum Length: 255 characters

Maximum Length: 1 characters

zeroize

Description Zeroized action required or not

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

import

Specification  
Type object

key

Description Import Key to HSM

Type: string

Maximum Length: 255 characters

Maximum Length: 1 characters

ssli-keys

Description Import a batch of keys to HSM to randomize the forged certificate public key

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

check

Specification  
Type object

key

Description Check Key in HSM

Type: string

Maximum Length: 255 characters

Maximum Length: 1 characters

delete

Specification  
Type object

key

Description Delete Key in HSM

Type: string

Maximum Length: 255 characters

Maximum Length: 1 characters