Get Shell
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Get enabled state of BASH, that is, access to BASH from within the controlled CLI.
Request
URLURL
https://{api_host}/rest/appliance/access/shell
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
AccessShellGetResponseBody
of type application/json
Current shell configuration.
{
"value": {
"enabled": false,
"timeout": 0
}
}| Property Name | Type | Description |
|---|---|---|
| value | AccessShellShellConfig |
Current shell configuration. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/appliance/access/shell
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : Generic error |
| default | ErrorRest | Not available |
