Service - Application

Class: VMware.Hv.Application
See also: ApplicationId, ApplicationInfo, ApplicationSpec, ApplicationSummaryView, GlobalApplicationEntitlementId, MapEntry
Since: Horizon View 6.0

Service Description

Interface representing Cascadia Remote Application.

Methods

Methods defined in this Service
Application_Create, Application_Delete, Application_DeleteApplications, Application_Get, Application_GetSummaryView, Application_GetSummaryViews, Application_ListGAECompatibleApplications, Application_Update

Application_Create

Create a new Application

Privileges

Privilege	Description
POOL_MANAGEMENT	privilege is required to create Application.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Application used to make the method call.
spec	ApplicationSpec	The information required to create the new Application

Return Value

Type	Description
ApplicationId	The id of the new Application

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_APPLICATION_CREATED	if Application creation succeeds.
VLSI_APPLICATION_CREATE_FAILED	if Application creation fails.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Application_Create" type="vdi:Application_CreateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Application_CreateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ApplicationId"/>
               </sequence>
            </complexType>
         </element>

Application_Delete

Delete a given Application.

Privileges

Privilege	Description
POOL_MANAGEMENT	privilege is required to delete the Application.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Application used to make the method call.
id	ApplicationId	The entityId of the Application 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_APPLICATION_DELETED	if the Application is successfully deleted.
VLSI_APPLICATION_DELETE_FAILED	if the Application deletion failed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Application_Delete" type="vdi:Application_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Application_DeleteResponse">
            <complexType/>
         </element>

Application_DeleteApplications

Delete multiple Applications.

Privileges

Privilege	Description
POOL_MANAGEMENT	privilege is required to delete the Applications.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Application used to make the method call.
ids	ApplicationId[]	Array of unique identifiers for Application entries.

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

Events

Event	Description
VLSI_APPLICATION_DELETED	for every Application if it is deleted successfully
VLSI_APPLICATION_DELETE_FAILED	for every Application if the deletion failed

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Application_DeleteApplications" type="vdi:Application_DeleteApplicationsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Application_DeleteApplicationsResponse">
            <complexType/>
         </element>

Application_Get

Get an Application by Id.

Privileges

Privilege	Description
POOL_VIEW	privilege is required to get Application.

Parameters

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

Return Value

Type	Description
ApplicationInfo	requested Application 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="Application_Get" type="vdi:Application_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Application_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ApplicationInfo"/>
               </sequence>
            </complexType>
         </element>

Application_GetSummaryView

Returns the ApplicationSummaryView for a specific Application entry.

Privileges

Privilege	Description
POOL_VIEW	required to get the Application Summary View.
FEDERATED_LDAP_VIEW	Global LDAP read is required to read the applicationSummaryData.globalApplicationEntitlement member of an application. This will be unset otherwise.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Application used to make the method call.
id	ApplicationId	unique identifier for an Application entry

Return Value

Type	Description
ApplicationSummaryView	The ApplicationSummaryView

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="Application_GetSummaryView" type="vdi:Application_GetSummaryViewRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Application_GetSummaryViewResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ApplicationSummaryView"/>
               </sequence>
            </complexType>
         </element>

Application_GetSummaryViews

Returns the ApplicationSummaryView for selected Application entries.

Privileges

Privilege	Description
POOL_VIEW	required to get the Application Summary View.
FEDERATED_LDAP_VIEW	Global LDAP read is required to read the applicationSummaryData.globalApplicationEntitlement member of an application. This will be unset otherwise.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Application used to make the method call.
ids	ApplicationId[]	Array of unique identifiers for Application entries.

Return Value

Type	Description
ApplicationSummaryView[]	Array of ApplicationSummaryView

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="Application_GetSummaryViews" type="vdi:Application_GetSummaryViewsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Application_GetSummaryViewsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ApplicationSummaryView" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

Application_ListGAECompatibleApplications

List of applications that can be associated with the specified Global Application Entitlement.

Privileges

Privilege	Description
FEDERATED_LDAP_VIEW	Global LDAP read is required to read a Global Application Entitlement
POOL_VIEW	Desktop read privilege with the corresponding access group permission is required to read a desktop and Farm information

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Application used to make the method call.
globalApplicationEntitlement	GlobalApplicationEntitlementId	unique identifier for Global Application Entitlement. GlobalApplicationEntitlementIds of this type must originate from GlobalApplicationEntitlement service

Return Value

Type	Description
ApplicationSummaryView[]

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="Application_ListGAECompatibleApplications" type="vdi:Application_ListGAECompatibleApplicationsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Application_ListGAECompatibleApplicationsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ApplicationSummaryView" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

Application_Update

Update an Application with the set of attributes in the map.

Privileges

Privilege	Description
POOL_ENABLE	privilege is required to update enabled flag. POOL_MANAGEMENT privilege is required to update any other attributes.

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

ApplicationId

The entity Id of the Application to be updated

updates

MapEntry[]

The key-value pairs describing attributes to be updated

This parameter is an update map based on ApplicationInfo.

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_APPLICATION_UPDATED	for each Application attribute that was updated.
VLSI_APPLICATION_UPDATE_FAILED	if the Application update failed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Application_Update" type="vdi:Application_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Application_UpdateResponse">
            <complexType/>
         </element>