# Managed Object - SessionManager

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

## Managed Object Description

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[] |

*May not be present P Required 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

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

# AcquireGenericServiceTicket

Required Privileges
  System.Anonymous
Since
  vSphere API 5.0

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

P Required privilege: spec

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

# AcquireLocalTicket

Required Privileges
  System.Anonymous

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call.
userName P | xsd:string | Since null

P Required privilege: userName

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

# CloneSession

Required Privileges
  System.Anonymous
Since
  vSphere API 4.0

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

P Required privilege: cloneTicket

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

# ImpersonateUser

Required Privileges
  Sessions.ImpersonateUser
Since
  VI API 2.5

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

*Need not be set P Required privilege - see tooltip for details

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

# Login

Required Privileges
  System.Anonymous

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

*Need not be set P Required privilege - see tooltip for details

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

# LoginBySSPI

Required Privileges
  System.Anonymous
Since
  VI API 2.5

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

*Need not be set P Required privilege - see tooltip for details

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

# LoginByToken

Required Privileges
  System.Anonymous
Since
  vSphere API 5.1

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

*Need not be set P Required privilege: locale

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

# LoginExtensionByCertificate

Deprecated.

Required Privileges
  System.Anonymous
Since
  vSphere API 4.0

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

*Need not be set P Required privilege - see tooltip for details

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

# LoginExtensionBySubjectName

Deprecated.

Required Privileges
  System.Anonymous
Since
  vSphere API 4.0

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

*Need not be set P Required privilege - see tooltip for details

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

# Logout

Required Privileges
  System.View

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

# SessionIsActive

Required Privileges
  Sessions.ValidateSession
Since
  VI API 2.5

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

P Required privilege - see tooltip for details

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

# SetLocale

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call.
locale P | xsd:string | Since null

P Required privilege: locale

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

# TerminateSession

Required Privileges
  Sessions.TerminateSession

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call.
sessionId P | xsd:string[] | Since null

P Required privilege: sessionId

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

# UpdateServiceMessage

Required Privileges
  Sessions.GlobalMessage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the SessionManager used to make the method call.
message P | xsd:string | Since null

P Required privilege: message

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