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

NameTypeDescription
_thisManagedObjectReference A reference to the Application used to make the method call.
specApplicationSpec

The information required to create the new Application

Return Value

Type Description
ApplicationIdThe id of the new Application

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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



Application_Delete

Delete a given Application.

Privileges

Privilege Description
POOL_MANAGEMENT privilege is required to delete the Application.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Application used to make the method call.
idApplicationId

The entityId of the Application to delete

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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



Application_DeleteApplications

Delete multiple Applications.

Privileges

Privilege Description
POOL_MANAGEMENT privilege is required to delete the Applications.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Application used to make the method call.
idsApplicationId[]

Array of unique identifiers for Application entries.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
PartialFailureFaultThrown if delete operation fails on one or more applications.
UnexpectedFaultThrown 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



Application_Get

Get an Application by Id.

Privileges

Privilege Description
POOL_VIEW privilege is required to get Application.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Application used to make the method call.
idApplicationId

The entityId of the Application to get

Return Value

Type Description
ApplicationInforequested Application entity

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the Application used to make the method call.
idApplicationId

unique identifier for an Application entry

Return Value

Type Description
ApplicationSummaryViewThe ApplicationSummaryView

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the Application used to make the method call.
idsApplicationId[]

Array of unique identifiers for Application entries.

Return Value

Type Description
ApplicationSummaryView[]Array of ApplicationSummaryView

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the Application used to make the method call.
globalApplicationEntitlementGlobalApplicationEntitlementId

unique identifier for Global Application Entitlement. GlobalApplicationEntitlementIds of this type must originate from GlobalApplicationEntitlement service

Return Value

Type Description
ApplicationSummaryView[]

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the Application used to make the method call.
idApplicationId

The entity Id of the Application to be updated
updatesMapEntry[]

The key-value pairs describing attributes to be updated

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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