Apache CloudStack 4.23.0.0 Root Admin API Reference

listHSMProfiles

Lists HSM profiles

Request parameters

Parameter NameDescriptionRequired
accountList resources by Account. Must be used with the domainId parameter.false
domainidList only resources belonging to the domain specifiedfalse
enabledlist only enabled profilesfalse
idthe HSM profile IDfalse
ispublicwhen true, non-admin users see only system (global) profilesfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidList objects by project; if projectid=-1 lists All Instancesfalse
protocolthe protocol of the HSM profilefalse
zoneidthe zone IDfalse

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