This API has a deprecated equivalent from v7.0U1.
Set DCUI
DescriptionSet enabled state of Direct Console User Interface (DCUI TTY2).
Request
URLURL
https://{api_host}/api/appliance/access/dcui
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
AccessDcuiSetRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"enabled": false
}
boolean
enabled
Required
DCUI is enabled.
Authentication
This operation uses the following authentication methods.
Code Samples
Code Samples
PowerCLI Client SDK Example
$AccessDcuiSetRequestBody = Initialize-AccessDcuiSetRequestBody -Enabled $false
Invoke-SetAccessDcui -AccessDcuiSetRequestBody $AccessDcuiSetRequestBody
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"enabled":false}' https://{api_host}/api/appliance/access/dcui
Errors
Vendor ExtensionsVendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: put
x-vmw-doc-deprecated-path: /rest/appliance/access/dcui
x-vmw-doc-operation: set
Availability
Added in 7.0U2
