{
    "id":"/axapi/v3/hsm",
    "type":"object",
    "node-type":"intermediate",
    "title":"hsm",
    "operation-not-allowed": ["PUT", "POST", "DELETE"],
    "partition-visibility":"shared",
    "description":"Hardware Security Module commands",
    "properties":{
        "template-list":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"template"
            },
            "uniqueItems":true,
            "$ref":"/axapi/v3/hsm/template/{template-name}",
            "array":[
                {
                    "properties":{
                        "template-name":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":63,
                            "partition-visibility":"shared",
                            "description":"Specify Template name",
                            "optional":false
                        },
                        "softhsm-enum":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'softHSM': software implementation of a cryptographic store; 'thalesHSM': Thales HSM; ",
                            "enum":[
                                "softHSM",
                                "thalesHSM"
                            ],
                            "optional":true
                        },
                        "hsm-dev":{
                            "type":"array",
                            "minItems":1,
                            "items":{
                                "type":"object"
                            },
                            "uniqueItems":true,
                            "array":[
                                {
                                    "properties":{
                                        "hsm-ip":{
                                            "type":"string",
                                            "format":"ipv4-address",
                                            "partition-visibility":"shared",
                                            "description":"Specify HSM Device IP Address"
                                        },
                                        "hsm-port":{
                                            "type":"number",
                                            "format":"number",
                                            "minimum":1,
                                            "maximum":65535,
                                            "partition-visibility":"shared",
                                            "description":"Specify Port"
                                        },
                                        "hsm-priority":{
                                            "type":"number",
                                            "format":"number",
                                            "minimum":1,
                                            "maximum":100,
                                            "partition-visibility":"shared",
                                            "description":"Specify Priority"
                                        }
                                    }
                                }
                            ]
                        },
                        "rfs-ip":{
                            "type":"string",
                            "format":"ipv4-address",
                            "partition-visibility":"shared",
                            "description":"Specify Thales Remote File System",
                            "optional":true
                        },
                        "rfs-port":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":65535,
                            "partition-visibility":"shared",
                            "description":"Specify Port",
                            "optional":true
                        },
                        "sec-world":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":128,
                            "partition-visibility":"shared",
                            "description":"Security World Name",
                            "optional":true
                        },
                        "protection":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "description":"Specify Protection Method",
                            "optional":true
                        },
                        "protection-module":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "not-list":[ "protection-ocs", "softcard" ],
                            "description":"Module",
                            "optional":true
                        },
                        "protection-ocs":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "not-list":[ "protection-module", "softcard" ],
                            "description":"Operator Card Set",
                            "optional":true
                        },
                        "softcard":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "not-list":[ "protection-module", "protection-ocs" ],
                            "description":"Softcard",
                            "optional":true
                        },
                        "protection-softcard-hash":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":255,
                            "partition-visibility":"shared",
                            "description":"Hash",
                            "optional":true
                        },
                        "password":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "description":"Specify HSM Passphrase",
                            "optional":true
                        },
                        "password-string":{
                            "type":"string",
                            "format":"password",
                            "minLength":4,
                            "maxLength":31,
                            "partition-visibility":"shared",
                            "description":"Password (minimum 4 characters)",
                            "optional":true
                        },
                        "encrypted":{
                            "type":"encrypted",
                            "format":"encrypted",
                            "partition-visibility":"shared",
                            "description":"Do NOT use this option manually (This is an A10 reserved keyword) (The ENCRYPTED password string)",
                            "optional":true
                        },
                        "worker":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":31,
                            "partition-visibility":"shared",
                            "description":"Specify number of workers for each data CPU",
                            "optional":true
                        },
                        "health-check-interval":{
                            "type":"number",
                            "format":"number",
                            "minimum":3,
                            "maximum":60,
                            "partition-visibility":"shared",
                            "description":"Specify Thales HSM Health Check Interval",
                            "optional":true
                        },
                        "enroll-timeout":{
                            "type":"number",
                            "format":"number",
                            "minimum":10,
                            "maximum":1024,
                            "partition-visibility":"shared",
                            "description":"Specify Enroll Timeout",
                            "optional":true
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object",
                            "optional":true
                        },
                        "user-tag":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":127,
                            "partition-visibility":"shared",
                            "description":"Customized tag",
                            "optional":true
                        }
                    },
                    "required":[
                        "template-name"
                    ]
                }
            ]
        }
    }
}