This API has a deprecated equivalent from v7.0U1.
Set Shell
DescriptionSet 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, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
{
"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).
Authentication
This operation uses the following authentication methods.
Errors
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
$AccessShellShellConfig = Initialize-AccessShellShellConfig -Enabled $false -Timeout 0
Invoke-SetAccessShell -AccessShellShellConfig $AccessShellShellConfig
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
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: put
x-vmw-doc-deprecated-path: /rest/appliance/access/shell
x-vmw-doc-operation: set
Availability
Added in 7.0U2
