Apache CloudStack 4.23.0.0 Root Admin API Reference

createHSMProfile

Creates a new HSM profile

Request parameters

Parameter NameDescriptionRequired
namethe name of the HSM profiletrue
accountthe account name of the HSM profile owner. Must be used with domainId. Leave empty (with a domainId) to create a domain-scoped profile shared by all accounts in that domain.false
detailsHSM configuration details (protocol specific)false
domainidthe domain ID where the HSM profile is available. If specified without an account, the profile is domain-scoped and usable by all accounts directly in that domain.false
ispublicwhether this is a public HSM profile available to all users globally (root admin only). Default is falsefalse
projectidthe ID of the project to add the HSM profile forfalse
protocolthe protocol of the HSM profile (PKCS11, KMIP, etc.). Default is 'pkcs11'false
vendornamethe vendor name of the HSMfalse
zoneidthe zone ID where the HSM profile is available. If null, global scope (for admin only)false

Response Tags

Response NameDescription
idthe ID of the HSM profile
accountthe account name of the HSM profile owner
accountidthe account ID of the HSM profile owner
createdthe date the HSM profile was created
detailsHSM configuration details (sensitive values are encrypted)
domainthe domain name of the HSM profile owner
domainidthe domain ID of the HSM profile owner
domainpaththe domain path of the HSM profile owner
enabledwhether the HSM profile is enabled
ispublicwhether this is a system HSM profile available to all users globally
namethe name of the HSM profile
projectthe project name of the HSM profile owner
projectidthe project ID of the HSM profile owner
protocolthe protocol of the HSM profile
statethe state of the HSM profile
vendorthe vendor name of the HSM profile
zoneidthe zone ID where the HSM profile is available
zonenamethe zone name where the HSM profile is available