hsm template

HSM Template

template Specification

Parameter Value
Type Collection
Object Key(s) template-name
Collection Name 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 template schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/hsm/template

template attributes

Create List

POST

/axapi/v3/hsm/template

template attributes

Get Object

GET

/axapi/v3/hsm/template/{template-name}

template attributes

Get List

GET

/axapi/v3/hsm/template

template-list

Modify Object

POST

/axapi/v3/hsm/template/{template-name}

template attributes

Replace Object

PUT

/axapi/v3/hsm/template/{template-name}

template attributes

Replace List

PUT

/axapi/v3/hsm/template

template-list

Delete Object

DELETE

/axapi/v3/hsm/template/{template-name}

template attributes

template-list

template-list is JSON List of template attributes

template-list : [

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

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