Service - MessageClient
Java Class
com.omnissa.vdi.vlsi.binding.vdi.utils.MessageClient
See also
Since
Horizon 7.7
Service Description¶
Methods
Methods defined in this Service: MessageClient_Create, MessageClient_Delete, MessageClient_Get, MessageClient_Update
Create a message client.
Privileges
| Privilege | Description |
|---|---|
| GLOBAL_CVP_REGISTER | Privilege is required to create the message client. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the MessageClient used to make the method call. |
| clientUuid | xsd:string | The message client uuid, which is generated by client itself |
| clientType | xsd:string | The message client type, which should be a member of MessageClientType. |
| pemCertificates | xsd:string[] | The message client certificates in PEM format. PemCertificate should be valid now, expired after 7 days, and its subject should be CN=clientType/clientUuid, otherwise InvalidArgumentFault will be thrown. |
Return Value
| Type | Description |
|---|---|
| MessageClientInfo |
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_CREATE_MESSAGE_CLIENT | If the message client was created successfully. |
| VLSI_CREATE_MESSAGE_CLIENT_FAILED | If the message client could not be created. |
Show WSDL type definition
Delete a message client.Requires at least one of the listed privileges.
Privileges
| Privilege | Description |
|---|---|
| GLOBAL_CVP_REGISTER | privilege is required to delete the message client. |
| GLOBAL_CONFIG_MANAGEMENT | privilege is required to delete the message client. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the MessageClient used to make the method call. |
| id | MessageClientId | The message client id. |
Return Value
| Type | Description |
|---|---|
| MessageClientInfo |
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_DELETE_MESSAGE_CLIENT | If the message client was deleted successfully. |
| VLSI_DELETE_MESSAGE_CLIENT_FAILED | If the message client could not be deleted. |
Show WSDL type definition
Get the messageClientInfo with id. Requires at least one of the listed privileges.
Privileges
| Privilege | Description |
|---|---|
| GLOBAL_CVP_REGISTER | Privilege is required to get message client. |
| GLOBAL_CONFIG_VIEW | privilege is required to get message client. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the MessageClient used to make the method call. |
| id | MessageClientId | The message client id. |
Return Value
| Type | Description |
|---|---|
| MessageClientInfo | The messageClientInfo |
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 a message client. Requires at least one of the listed privileges.
Privileges
| Privilege | Description |
|---|---|
| GLOBAL_CVP_REGISTER | privilege is required to update the message client. |
| GLOBAL_CONFIG_MANAGEMENT | privilege is required to update the message client. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the MessageClient used to make the method call. |
| id | MessageClientId | |
| pemCertificates | xsd:string[] | The message client certificates in PEM format. PemCertificate should be valid now, expired after 7 days, and its subject should be CN=clientType/clientUuid, otherwise InvalidArgumentFault will be thrown. |
Return Value
| Type | Description |
|---|---|
| MessageClientInfo |
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_UPDATE_MESSAGE_CLIENT | If the message client was updated successfully. |
| VLSI_UPDATE_MESSAGE_CLIENT_FAILED | If the message client could not be updated. |
Show WSDL type definition