Session Manager Terminate Session

Session Manager Terminate Session

Log off and terminate the provided list of sessions.

This method is only transactional for each session ID. The set of sessions are terminated sequentially, as specified in the list. If a failure occurs, for example, because of an unknown sessionID, the method aborts with an exception. When the method aborts, any sessions that have not yet been terminated are left in their unterminated state.

Required privileges: Sessions.TerminateSession

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/SessionManager/{moId}/TerminateSession
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case SessionManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.


Request Body
TerminateSessionRequestType of type(s) application/json
Required

Show optional properties

{
    "sessionId": [
        {}
    ]
}
{
    "sessionId": [
        "string"
    ]
}
array of string
sessionId
Required

A list of sessions to terminate.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

NotFound: if a sessionId could not be found as a valid logged-on session.

InvalidArgument: if a sessionId matches the current session. Use the logout method to terminate the current session.

Returns NotFound of type(s) application/json
This response body class contains all of the following: VimFault
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}