This API has a deprecated equivalent from v7.0U1.
Set SSH
DescriptionSet enabled state of the SSH-based controlled CLI.
Request
URLURL
https://{api_host}/api/appliance/access/ssh
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
AccessSshSetRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"enabled": false
}
boolean
enabled
Required
SSH-based controlled CLI is enabled.
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
$AccessSshSetRequestBody = Initialize-AccessSshSetRequestBody -Enabled $false
Invoke-SetAccessSsh -AccessSshSetRequestBody $AccessSshSetRequestBody
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"enabled":false}' https://{api_host}/api/appliance/access/ssh
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/ssh
x-vmw-doc-operation: set
Availability
Added in 7.0U2
