Register Sgx Hosts Task
Register host by stored SGX configuration.
Request
URLURL
https://{api_host}/api/vcenter/confidential-computing/sgx/hosts?action=register&vmw-task=true
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
ConfidentialComputingSgxHostsRegisterSpec of mimetype application/json
Required
Described the host that need to be registered.
{
"host_id": "string"
}
string
host_id
Required
The host’s identifier. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists.
Errors
500
com.vmware.vapi.std.errors.error : for any other error. | com.vmware.vapi.std.errors.resource_busy : if register for same host is already in progress.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"host_id":"string"}' https://{api_host}/api/vcenter/confidential-computing/sgx/hosts?action=register&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: register_task
Availability
Added in 8.0.0.1
