Service - RDSServer

Class: VMware.Hv.RDSServer
See also: MapEntry, RDSServerId, RDSServerInfo, RDSServerRegisterResult, RDSServerRegisterSpec, RDSServerStateCount, RDSServerSummaryView
Since: Horizon View 6.0

Service Description

Interface representing an RDS server

Methods

Methods defined in this Service
RDSServer_Delete, RDSServer_Get, RDSServer_GetStateCounts, RDSServer_GetSummaryView, RDSServer_Recover, RDSServer_RecoverMachines, RDSServer_Register, RDSServer_Update

RDSServer_Delete

Remove a given RDSServer from the View LDAP configuration.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	privilege is required to delete RDS Server.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the RDSServer used to make the method call.
id	RDSServerId	The entityId of RDSServer to delete

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_RDSSERVER_DELETED	if the RDSServer is successfully deleted.
VLSI_RDSSERVER_DELETE_FAILED	if the RDSServer deletion failed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_Delete" type="vdi:RDSServer_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_DeleteResponse">
            <complexType/>
         </element>

RDSServer_Get

Get an RDSServer by Id. Requires at least one of the listed privileges.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	is required to get an RDSServer that is not in-use. It is sufficient to get all RDSServers that may or may not be associated with a Farm.
POOL_VIEW	is required to get RDSServer that is associated with a Farm. All in-use RDSServers can be accessed with POOL_VIEW on the Root access group. With POOL_VIEW privilege on a non-Root Farm access group, only the RDSServers associated with the Farm can be accessed.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the RDSServer used to make the method call.
id	RDSServerId	The entityId of RDSServer to get

Return Value

Type	Description
RDSServerInfo	requested RDSServer 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_Get" type="vdi:RDSServer_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:RDSServerInfo"/>
               </sequence>
            </complexType>
         </element>

RDSServer_GetStateCounts

Returns the state counter for various RDSServer states.

Privileges

Privilege	Description
POOL_VIEW	is required to get RDSServer state counts

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the RDSServer used to make the method call.

Return Value

Type	Description
RDSServerStateCount	The RDSServerStateCount

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_GetStateCounts" type="vdi:RDSServer_GetStateCountsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_GetStateCountsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:RDSServerStateCount"/>
               </sequence>
            </complexType>
         </element>

RDSServer_GetSummaryView

Get an RDSServerSummaryView by Id. Requires at least one of the listed privileges.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	is required to get an RDSServer that is not in-use. It is sufficient to get all RDSServers that may or may not be associated with a Farm.
POOL_VIEW	is required to get RDSServer that is associated with a Farm. All in-use RDSServers can be accessed with POOL_VIEW on the Root access group. With POOL_VIEW privilege on a non-Root Farm access group, only the RDSServers associated with the Farm can be accessed.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the RDSServer used to make the method call.
id	RDSServerId	The entityId of RDSServer to get

Return Value

Type	Description
RDSServerSummaryView	requested RDSServer 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_GetSummaryView" type="vdi:RDSServer_GetSummaryViewRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_GetSummaryViewResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:RDSServerSummaryView"/>
               </sequence>
            </complexType>
         </element>

RDSServer_Recover

Mark the RDS server for recovery. This operation deletes the current RDS server and provisions a new RDS server from latest image. Usually this operation is used to recover RDS server that is in error state or otherwise unusable. This operation applies only to RDS server belonging to Instant Clone Engine farms. Requires at least one of the listed privileges.
Note :- The RDS server being recovered must not have any active user session, otherwise this operation would fail.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	privilege is required to recover the RDS server.
POOL_MANAGEMENT	privilege is required to recover the RDS server.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the RDSServer used to make the method call.
id	RDSServerId	Unique identifier of the RDS server to recover. RDSServerId of this type must originate from the RDSServer service.

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_RDSSERVER_RECOVERY_REQUESTED	if RDS server was marked for recovery.
VLSI_RDSSERVER_RECOVERY_REQUEST_FAILED	if failed to mark the RDS server for recovery.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_Recover" type="vdi:RDSServer_RecoverRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_RecoverResponse">
            <complexType/>
         </element>

RDSServer_RecoverMachines

Mark the RDS servers for recovery. This operation deletes the current RDS servers and provisions new RDS servers from latest image. Usually this operation is used to recover RDS servers that are in error state or otherwise unusable. This operation applies only to RDS servers belonging to Instant Clone Engine farms. Requires at least one of the listed privileges.
Note :- The RDS servers being recovered must not have any active user session, otherwise this operation would fail.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	privilege is required to recover the RDS servers.
POOL_MANAGEMENT	privilege is required to recover the RDS servers.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the RDSServer used to make the method call.
ids	RDSServerId[]	Array of unique identifiers of the RDS servers to recover. RDSServerIds of this type must originate from the RDSServer service.

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.
PartialFailureFault	Thrown if recover operation fails on one or more RDS servers.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_RDSSERVER_RECOVERY_REQUESTED	if RDS servers were marked for recovery.
VLSI_RDSSERVER_RECOVERY_REQUEST_FAILED	if failed to mark the RDS servers for recovery.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_RecoverMachines" type="vdi:RDSServer_RecoverMachinesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_RecoverMachinesResponse">
            <complexType/>
         </element>

RDSServer_Register

Registers an RDS server.

Privileges

Privilege	Description
GLOBAL_MACHINE_REGISTER	Global machine registration privilege is required to register an RDS Server.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the RDSServer used to make the method call.
spec	RDSServerRegisterSpec	The specification for the register operation.

Return Value

Type	Description
RDSServerRegisterResult	The registration result.

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_RDSSERVER_REGISTERED	If the RDS Server is successfully registered.
VLSI_RDSSERVER_REGISTRATION_FAILED	If the RDS Server could not be registered.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_Register" type="vdi:RDSServer_RegisterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_RegisterResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:RDSServerRegisterResult"/>
               </sequence>
            </complexType>
         </element>

RDSServer_Update

Update an RDS server with the set of attributes in the map. Requires at least one of the listed privileges.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	privilege is required to update RDS Server configuration.
POOL_MANAGEMENT	privilege is sufficient when enabled alone is being updated.
MACHINE_MANAGEMENT	privilege is sufficient when enabled alone is being updated.

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the RDSServer used to make the method call.

RDSServerId

The entity Id of the RDS server to be updated

updates

MapEntry[]

The key-value pairs describing attributes to be updated

This parameter is an update map based on RDSServerInfo.

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_RDSSERVER_UPDATED	for each RDSServer attribute that was updated.
VLSI_RDSSERVER_UPDATE_FAILED	if the RDSServer update failed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_Update" type="vdi:RDSServer_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RDSServer_UpdateResponse">
            <complexType/>
         </element>