appliance access shell: get
Get enabled state of BASH, that is, access to BASH from within the controlled CLI.
Request:
HTTP request
GET https://{server}/rest/appliance/access/shell
No request parameters
Response:
HTTP Status Code: 200
Representations:
{
"value": {
"enabled": true,
"timeout": 1
}
}
"value": {
"enabled": true,
"timeout": 1
}
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/appliance/access/shell" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value>
<enabled>true</enabled>
<timeout>1</timeout>
</value>
</ns0:Get-Result>
<ns0:Get-Result xmlns:ns0="http://vmware.com/appliance/access/shell" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value>
<enabled>true</enabled>
<timeout>1</timeout>
</value>
</ns0:Get-Result>
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | shell_config | Current shell configuration. |
| value.enabled | boolean | Enabled can be set to true or false |
| value.timeout | long | The timeout (in seconds) specifies how long you enable the Shell access. The maximum timeout is 86400 seconds(1 day). |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | Generic error |