This API has a deprecated equivalent from v7.0U1.
Set Shell
Set enabled state of BASH, that is, access to BASH from within the controlled CLI.
Request
URLURL
https://{api_host}/api/appliance/access/shell
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Request Body
Request Body
AccessShellShellConfig of mimetype application/json
Required
Shell configuration Shell.ShellConfig structure Structure that defines shell configuration.
(The request body parameter is missing description)
{
"enabled": false,
"timeout": 0
}
boolean
enabled
Required
Enabled can be set to true or false
integer
timeout
Required
The timeout (in seconds) specifies how long you enable the Shell access. The maximum timeout is 86400 seconds(1 day).
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"enabled":false,"timeout":0}' https://{api_host}/api/appliance/access/shell
Errors
Availability
Added in 7.0U2
