| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
currentSession* P | UserSession |
|
defaultLocale P | xsd:string |
|
message* P | xsd:string |
|
messageLocaleList* P | xsd:string[] |
|
sessionList* P | UserSession[] |
|
supportedLocaleList* P | xsd:string[] |
|
Methods
Methods defined in this Managed Object |
---|
AcquireCloneTicket, AcquireGenericServiceTicket, AcquireLocalTicket, CloneSession, ImpersonateUser, Login, LoginBySSPI, LoginByToken, LoginExtensionByCertificate, LoginExtensionBySubjectName, Logout, SessionIsActive, SetLocale, TerminateSession, UpdateServiceMessage |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
Return Value
Type | Description |
---|---|
xsd:string |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
spec P | SessionManagerServiceRequestSpec |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
SessionManagerGenericServiceTicket |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
userName P | xsd:string |
Since null |
Return Value
Type | Description |
---|---|
SessionManagerLocalTicket |
Faults
Type | Description |
---|---|
InvalidLogin | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
cloneTicket P | xsd:string |
Since VI API 2.5u2 |
Return Value
Type | Description |
---|---|
UserSession |
Faults
Type | Description |
---|---|
InvalidLogin | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
userName P | xsd:string |
Since VI API 2.5 |
locale* P | xsd:string |
Since VI API 2.5 |
Return Value
Type | Description |
---|---|
UserSession |
Faults
Type | Description |
---|---|
InvalidLocale | |
InvalidLogin | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
userName P | xsd:string |
Since null |
password P | xsd:string |
Since null |
locale* P | xsd:string |
Since null |
Return Value
Type | Description |
---|---|
UserSession |
Faults
Type | Description |
---|---|
InvalidLocale | |
InvalidLogin | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
base64Token P | xsd:string |
Since VI API 2.5 |
locale* P | xsd:string |
Since VI API 2.5 |
Return Value
Type | Description |
---|---|
UserSession |
Faults
Type | Description |
---|---|
InvalidLocale | |
InvalidLogin | |
RuntimeFault | Thrown 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
locale* P | xsd:string |
Since vSphere API 5.1 |
Return Value
Type | Description |
---|---|
UserSession |
Faults
Type | Description |
---|---|
InvalidLocale | |
InvalidLogin | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
extensionKey P | xsd:string |
Since vSphere API 4.0 |
locale* P | xsd:string |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
UserSession |
Faults
Type | Description |
---|---|
InvalidLocale | |
InvalidLogin | |
NoClientCertificate | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
extensionKey P | xsd:string |
Since VI API 2.5 |
locale* P | xsd:string |
Since VI API 2.5 |
Return Value
Type | Description |
---|---|
UserSession |
Faults
Type | Description |
---|---|
InvalidLocale | |
InvalidLogin | |
NoClientCertificate | |
NoSubjectName | |
NotFound | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
sessionID P | xsd:string |
Since VI API 2.5 |
userName P | xsd:string |
Since VI API 2.5 |
Return Value
Type | Description |
---|---|
xsd:boolean |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
locale P | xsd:string |
Since null |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidLocale | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
sessionId P | xsd:string[] |
Since null |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
NotFound | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call. |
message P | xsd:string |
Since null |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |