This API has a deprecated equivalent from v7.0U1.
Get DCUI
Get 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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
boolean
of type application/json
DCUI is enabled.
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetAccessDcui
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/access/dcui
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/appliance/access/dcui
x-vmw-doc-operation: get
Availability
Added in 7.0U2
