Managed Object - SessionManager

Property of
ServiceContent
See also
SessionManagerGenericServiceTicket, SessionManagerLocalTicket, SessionManagerServiceRequestSpec, UserSession
Since
null


Managed Object Description

Properties

Name Type Description
currentSession* PUserSession


defaultLocale Pxsd:string


message* Pxsd:string


messageLocaleList* Pxsd:string[]


sessionList* PUserSession[]


supportedLocaleList* Pxsd:string[]


*May not be presentPRequired privilege - see tooltip for details

Methods

Methods defined in this Managed Object
AcquireCloneTicket, AcquireGenericServiceTicket, AcquireLocalTicket, CloneSession, ImpersonateUser, Login, LoginBySSPI, LoginByToken, LoginExtensionByCertificate, LoginExtensionBySubjectName, Logout, SessionIsActive, SetLocale, TerminateSession, UpdateServiceMessage

AcquireCloneTicket

Required Privileges
System.View
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.

Return Value

Type Description
xsd:string

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



AcquireGenericServiceTicket

Required Privileges
System.Anonymous
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
spec PSessionManagerServiceRequestSpec

Since vSphere API 5.0
P Required privilege: spec

Return Value

Type Description
SessionManagerGenericServiceTicket

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



AcquireLocalTicket

Required Privileges
System.Anonymous

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
userName Pxsd:string

Since null
P Required privilege: userName

Return Value

Type Description
SessionManagerLocalTicket

Faults

Type Description
InvalidLogin
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



CloneSession

Required Privileges
System.Anonymous
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
cloneTicket Pxsd:string

Since VI API 2.5u2
P Required privilege: cloneTicket

Return Value

Type Description
UserSession

Faults

Type Description
InvalidLogin
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ImpersonateUser

Required Privileges
Sessions.ImpersonateUser
Since
VI API 2.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
userName Pxsd:string

Since VI API 2.5
locale* Pxsd:string

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
UserSession

Faults

Type Description
InvalidLocale
InvalidLogin
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



Login

Required Privileges
System.Anonymous

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
userName Pxsd:string

Since null
password Pxsd:string

Since null
locale* Pxsd:string

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
UserSession

Faults

Type Description
InvalidLocale
InvalidLogin
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



LoginBySSPI

Required Privileges
System.Anonymous
Since
VI API 2.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
base64Token Pxsd:string

Since VI API 2.5
locale* Pxsd:string

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
UserSession

Faults

Type Description
InvalidLocale
InvalidLogin
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
SSPIChallenge

Events

Type
None



LoginByToken

Required Privileges
System.Anonymous
Since
vSphere API 5.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
locale* Pxsd:string

Since vSphere API 5.1
*Need not be set P Required privilege: locale

Return Value

Type Description
UserSession

Faults

Type Description
InvalidLocale
InvalidLogin
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



LoginExtensionByCertificate

Deprecated.

Required Privileges
System.Anonymous
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
extensionKey Pxsd:string

Since vSphere API 4.0
locale* Pxsd:string

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
UserSession

Faults

Type Description
InvalidLocale
InvalidLogin
NoClientCertificate
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



LoginExtensionBySubjectName

Deprecated.

Required Privileges
System.Anonymous
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
extensionKey Pxsd:string

Since VI API 2.5
locale* Pxsd:string

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
UserSession

Faults

Type Description
InvalidLocale
InvalidLogin
NoClientCertificate
NoSubjectName
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



Logout

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



SessionIsActive

Required Privileges
Sessions.ValidateSession
Since
VI API 2.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
sessionID Pxsd:string

Since VI API 2.5
userName Pxsd:string

Since VI API 2.5
PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:boolean

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



SetLocale

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
locale Pxsd:string

Since null
P Required privilege: locale

Return Value

Type Description
None

Faults

Type Description
InvalidLocale
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



TerminateSession

Required Privileges
Sessions.TerminateSession

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
sessionId Pxsd:string[]

Since null
P Required privilege: sessionId

Return Value

Type Description
None

Faults

Type Description
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



UpdateServiceMessage

Required Privileges
Sessions.GlobalMessage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the SessionManager used to make the method call.
message Pxsd:string

Since null
P Required privilege: message

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None