Set Consolecli
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Set enabled state of the console-based controlled CLI (TTY1).
Request
URLURL
https://{api_host}/rest/appliance/access/consolecli
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains AccessConsolecliSetRequestBody
of type application/json
(required)
{
"enabled": false
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | enabled | boolean |
Console-based controlled CLI is enabled. |
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"enabled":false}' https://{api_host}/rest/appliance/access/consolecli
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : Generic error |
| default | ErrorRest | Not available |
On This Page
Consolecli Operations
get
put
