Virtual Storage Lifecycle Management API
| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - VslmSessionManager(vslm.auth.SessionManager)
- Property of
- VslmServiceInstanceContent
- Since
- 6.7.2
Managed Object Description
VslmSessionManager managed object manages client sessions. Login to VSLM service is done through this interface. It is SSO enabled so only login by using SamlToken is allowed. This API is intended for internal use only.Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
VslmLoginByToken, VslmLogout |
VslmLoginByToken(loginByToken)
Login to the VSLM service by using SSO token. VSLM will validate the user token from the context. The delegated token passed as a parameter will be used by VSLM to login to VC for authorization purposes. Once login successfully returns, a new session is established for the client. This session is only valid for the lifetime of the supplied delegated token. Any calls made on a session which exceeds this lifetime will result in a SecurityError. The client is expected to logout of the current session and subsequently re-login with a new delegated token to establish a new session.- Required Privileges
- System.Anonymous
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VslmSessionManager used to make the method call. |
delegatedTokenXml | xsd:string |
The delegated token will be retrieved by the
client and delegated to VSLM. VSLM will use this token, on user's
behalf, to login to VC for authorization purposes. It is necessary
to convert the token to XML because the SAML token itself is
not a VMODL Data Object and cannot be used as a parameter.
Since 6.7.2 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidLogin | Thrown if there is no token provided or the token could not be validated. |
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 |
Show WSDL type definition
VslmLogout(logout)
Logs out of the VSLM Service.- Required Privileges
- StoragLifecycle.View
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VslmSessionManager 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 |
Show WSDL type definition
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |