Crypto Manager Kmip Query Crypto Key Status
Check CryptoKey status, such as if VC can access the key, if the key is used by some VMs or as host key.
Required privileges: Cryptographer.ManageKeys
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId
, in this case CryptoManagerKmip/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"keyIds": [
{
"_typeName": "string",
"keyId": "string",
"providerId": {
"_typeName": "string",
"id": "string"
}
}
],
"checkKeyBitMap": 0
}
[in] The key state to check. Supported value: 0x01. check if key data is available to VC. 0x02. check the VMs which use that key. 0x04. check the hosts using this key as host key. 0x08. Check 3rd party program which use that key. Other bits - reserved and will be igonred.
The structure combined with key status. If bit in parameter is not set when invoke, the returned data in related CryptoKeyStatus will be unknown.
[
{
"_typeName": "string",
"keyId": {
"_typeName": "string",
"keyId": "string",
"providerId": {
"_typeName": "string",
"id": "string"
}
},
"keyAvailable": false,
"reason": "string",
"encryptedVMs": [
{
"_typeName": "string",
"type": "string",
"value": "string"
}
],
"affectedHosts": [
{
"_typeName": "string",
"type": "string",
"value": "string"
}
],
"referencedByTags": [
"string"
]
}
]