Service - SecondaryCredentials
Java Class
com.omnissa.vdi.vlsi.binding.vdi.users.SecondaryCredentials
See also
MapEntry, SecondaryCredentialsDeleteSpec, SecondaryCredentialsId, SecondaryCredentialsInfo, SecondaryCredentialsSpec, UserOrGroupId
Since
Horizon 7.7
Service Description¶
Service Interface for SecondaryCredentials Setting.
Methods
Methods defined in this Service: SecondaryCredentials_Create, SecondaryCredentials_Delete, SecondaryCredentials_Get, SecondaryCredentials_List, SecondaryCredentials_Update
Create a new Secondary Credentials Setting.
Privileges
| Privilege | Description |
|---|---|
| GLOBAL_CONFIG_MANAGEMENT | Global configuration management privilege is required to create Secondary Credentials. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the SecondaryCredentials used to make the method call. |
| spec | SecondaryCredentialsSpec | The Secondary Credentials Spec |
Return Value
| Type | Description |
|---|---|
| SecondaryCredentialsId | id |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Events
| Event | Description |
|---|---|
| VLSI_SECONDARY_CREDENTIALS_CREATED | if Secondary Credentials creation succeeds. |
| VLSI_SECONDARY_CREDENTIALS_CREATE_FAILED | if Secondary Credentials creation fails. |
Show WSDL type definition
Delete a given SecondaryCredentials Setting. Either of id or spec needs to be provided. If id and spec both are provided then delete happens as per id.
Privileges
| Privilege | Description |
|---|---|
| GLOBAL_CONFIG_MANAGEMENT | Global configuration management privilege is required to delete Secondary Credentials. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the SecondaryCredentials used to make the method call. |
| id | SecondaryCredentialsId | The entityId of the SecondaryCredentials to be deleted. 1 |
| spec | SecondaryCredentialsDeleteSpec | The specification for deleting the SecondaryCredentials. 1 |
Return Value
| Type | Description |
|---|---|
| None |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Events
| Event | Description |
|---|---|
| VLSI_SECONDARY_CREDENTIALS_DELETED | if the SecondaryCredentials is successfully deleted. |
| VLSI_SECONDARY_CREDENTIALS_DELETE_FAILED | if the SecondaryCredentials deletion failed. |
Show WSDL type definition
Get a SecondaryCredentials Setting by Id.
Privileges
| Privilege | Description |
|---|---|
| GLOBAL_CONFIG_VIEW | Global configuration view privilege is required to get Secondary Credentials. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the SecondaryCredentials used to make the method call. |
| id | SecondaryCredentialsId | The entityId of the Secondary Credentials to get. |
Return Value
| Type | Description |
|---|---|
| SecondaryCredentialsInfo | requested SecondaryCredentialsInfo entity |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
List the configured Secondary Credentials for given user.
Privileges
| Privilege | Description |
|---|---|
| GLOBAL_CONFIG_VIEW | Global configuration view privilege is required to list Secondary Credentials. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the SecondaryCredentials used to make the method call. |
| ownerId | UserOrGroupId | The UserOrGroupId of the owner. |
Return Value
| Type | Description |
|---|---|
| SecondaryCredentialsInfo[] | requested array of SecondaryCredentialsInfo entity. |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
Update the SecondaryCredentials with the set of attributes in the map.
Privileges
| Privilege | Description |
|---|---|
| GLOBAL_CONFIG_MANAGEMENT | Global configuration management privilege is required to update Secondary Credentials. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the SecondaryCredentials used to make the method call. |
| id | SecondaryCredentialsId | The entityId of the SecondaryCredentials to be updated. |
| updates | MapEntry[] | The key-value pairs describing attributes to be updated. 2 |
Return Value
| Type | Description |
|---|---|
| None |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Events
| Event | Description |
|---|---|
| VLSI_SECONDARY_CREDENTIALS_UPDATED | for each SecondaryCredentials attribute that was updated. |
| VLSI_SECONDARY_CREDENTIALS_UPDATE_FAILED | if SecondaryCredentials update failed. |
Show WSDL type definition
-
This parameter is an update map based on SecondaryCredentialsInfo. ↩