hsm template

HSM Template

template Specification

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
Schema template schema

Operations Allowed:

Operation Method URI Payload

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)

health-check-interval

Description: Specify Thales HSM Health Check Interval

Type: number

Range: 3-60

hsm-dev

Description: hsm-dev is a JSON List . Please see below for 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

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

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

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

Required: Yes

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

worker

Description: Specify number of workers for each data CPU

Type: number

Range: 1-31

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