Service - IMitService

WSDL type
vmware.mirage.mit.IMitService
See also
BatchResult, CvdDetails, Id, ImageId, MachineIdentityInfo, MigrationTarget, QueryDefinition, QueryResult, ServerInformation
Since
Mirage 5.1.0


Service Description

The interface of Mirage API.

Methods

Methods defined in this Service
AppLayer_Query, BaseLayer_Query, Collection_Query, CollectionCvd_Query, Cvd_ApplyPolicy, Cvd_Archive, Cvd_Delete, Cvd_Get, Cvd_Query, Cvd_Sync, Login, Logout, OsMigration_ApplyDownloadOnlyMigration, OsMigration_Begin, OsMigration_BeginDownloadOnly, OsMigration_QueryDownloadOnlyCompleted, OsMigration_QueryDownloadOnlyInProgress, OsMigrationCvd_QueryDownloadOnly, PendingDevice_CreateNewCvd, PendingDevice_Provision, PendingDevice_Query, Policy_Query, Volume_Query

AppLayer_Query

Query all the application layer images in Mirage Management System.

The filter fields which can be used in query are:

Required Permissions

ListBaseImages

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
queryDefinitionQueryDefinition

The filter and page number

Return Value

Type Description
QueryResultAll the application layer images meet the query condition in this page.
  • The element in QueryResult can be converted to LayerDetails

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



BaseLayer_Query

Query all the base layer images in Mirage Management System.

The filter fields which can be used in query are:

Required Permissions

ListBaseImages

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
queryDefinitionQueryDefinition

The filter and page number

Return Value

Type Description
QueryResultAll the base layer images meet the query condition in this page.
  • The element in QueryResult can be converted to LayerDetails

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



Collection_Query

Query all the CVD collections in Mirage Management System.

Since
Mirage 5.3.0

The filter fields which can be used in query are:

Required Permissions

ListCvds

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
queryDefinitionQueryDefinition

The filter and page number.

Return Value

Type Description
QueryResultAll the collections meet the query condition in this page.

Faults

Type Description
AccessDeniedThrown if the client's privilege is limited.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



CollectionCvd_Query

Query all the CVDs in the given collection in Mirage Management System.

Since
Mirage 5.3.0

The filter fields which can be used in query are:

Required Permissions

ListCvds

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
collectionIdId

The Id of the collection.
queryDefinitionQueryDefinition

The filter and page number.

Return Value

Type Description
QueryResultAll the CVDs meet the query condition in this page.
  • The element in QueryResult can be converted to CvdDetails

Faults

Type Description
AccessDeniedThrown if the client's privilege is limited.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



Cvd_ApplyPolicy

Apply policy to the given CVDs.

Since
Mirage 5.3.0

Required Permissions

AdministerCvds
ListCvds
ListPolicies

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
cvdIdsId[]

cvdIds is a list of CVDs, the count of the list should be no more than 500. When there are some invalid CVDs within this list, this method only apply policy for valid CVD Ids, while invalid CVD Ids will be skipped.
policyIdImageId

The ImageId of target policy.

Return Value

Type Description
BatchResultFor each CVD, BatchResult has an OperationResult, which presents the result of applying the CVD policies. When OperationResult's Success is true, it means the policy of CVD has been applied, and the Result is the IdValue of Id of the CVD. Otherwise, please check OperationResult's MethodFault to get message why it is failed to apply the CVD policies.

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
NotSupportedFaultThrown if the query filter is not null.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



Cvd_Archive

Archive the CVDs in the Mirage Management System.

Since
Mirage 5.3.0

Required Permissions

AdministerCvds
AdministerReferenceCvds
ListReferenceCvds
ListTasks

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
cvdIdsId[]

The ids of the requested CVDs, the count of the list should be no more than 500. When there are some invalid CVDs within this list, this method only archives the valid CVD Ids, while invalid CVD Ids will be skipped.

Return Value

Type Description
BatchResultFor each CVD, BatchResult has an OperationResult, which presents the result of archiving the CVD. When OperationResult's Success is true, it means the Mirage starts to archive the CVD, and the Result is the IdValue of Id of the CVD. Otherwise, please check OperationResult's MethodFault to get message why it is failed to archive the CVD.

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



Cvd_Delete

Delete the CVDs in the Mirage Management System.

Since
Mirage 5.3.0

Required Permissions

AdministerCvds
ListCvds

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
cvdIdsId[]

The ids of the requested CVDs, the count of id should be no more than 500. When there are some invalid CVDs within this list, this method only deletes the valid CVD Ids, while invalid CVD Ids will be skipped.

Return Value

Type Description
BatchResultFor each CVD, BatchResult has an OperationResult, which presents the result of deleting the CVD. When OperationResult's Success is true, it means the Mirage starts to delete the CVD, and the Result is the IdValue of Id of the CVD. Otherwise, please check OperationResult's MethodFault to get message why it is failed to delete the CVD.

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



Cvd_Get

Get a CVD by Id.

Required Permissions

ListCvds
ListEvents

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
idId

The id of the requested CVD.

Return Value

Type Description
CvdDetailsRequested CVD

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



Cvd_Query

Query the CVDs in the Mirage Management System.

The filter fields which can be used in query are:

Required Permissions

ListCvds
ListEvents

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
queryDefinitionQueryDefinition

The query filter and page number.

Return Value

Type Description
QueryResultAll the CVDs meet the query condidtion in this page.
  • The element in QueryResult can be converted to CvdDetails

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



Cvd_Sync

Synchronize the CVDs' device information in the Mirage Management System.

Since
Mirage 5.3.0

Required Permissions

ListDevices
SupportDevices

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
cvdIdsId[]

The ids of the requested CVDs, the count of id should be no more than 500. When there are some invalid CVDs within this list, this method only synchronizes the valid CVD Ids, while invalid CVD Ids will be skipped.

Return Value

Type Description
BatchResultFor each CVD, BatchResult has an OperationResult, which presents the result of synchronizing the CVD. When OperationResult's Success is true, it means the Mirage starts to synchronize the CVD, and the Result is the IdValue of Id of the CVD. Otherwise, please check OperationResult's MethodFault to get message why it is failed to synchronize the CVD.

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



Login

This method is used to log in to Mirage. You must call this before calling any other method. Otherwise, Mirage returns the NotAuthenticated fault. The client must not log in again if its session is still valid. Otherwise, it will get the InvalidLogin fault. The user must have the role Administrator, Web Help Desk, or Web Protection Manager to log in successfully. For more information about roles, see the section Managing Role-Based Access Control and Active Directory Groups in the VMware Mirage Administrator's Guide.

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
usernamestring

User name
passwordstring

User password

Return Value

Type Description
ServerInformationThe information of the Mirage API server. Since 5.3.0. .

Faults

Type Description
InvalidLoginThrown if the client login with invalid credential.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.


Show WSDL type definition



Logout

Log out and terminate the current session.

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.


Show WSDL type definition



OsMigration_ApplyDownloadOnlyMigration

Start to apply base layer and app layers for the migration targets.

Required Permissions

AdministerCvds
ListCvds

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
cvdIdsId[]

The id(s) of the CVD(s), the count of id should be no more than 500, which will be applied migration after downloading base layer and app layer.

Return Value

Type Description
BatchResultThe result for each CVD.

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



OsMigration_Begin

Start migration for the migration targets. This method validates migration targets first, then starts to download base layer and app layers, at last it migrates.

Required Permissions

AdministerCvds
ListCvds

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
migrationTargetsMigrationTarget[]

An array of MigrationTarget, the count of the targets should be no more than 500, which contains information for migration, such as Id of CVD, domain name, user, password and etc. This method validates migration targets first. If some migration targets are failed to validate for some reasons, such as incorrect domain name, invalid CVD Id, etc, this migration targets will skipped, and other migration targets start to download base layer and app layers and then migrate.
baseLayerIdImageId

The id of the base layer image.
appLayerIdsImageId[]

The id(s) of app layer images
ignoreWarningsbool

Ignore validation warnings or not. When ignoreWarnings is true, migration will start even there are warnings of validation; otherwise migration won't start when there is an warning.

Return Value

Type Description
BatchResultFor each CVD, BatchResult has an OperationResult, which presents the result of starting of migration. When OperationResult's Success is true, it means the Mirage starts to migrate; otherwise check OperationResult's MethodFault to get message why it is failed to start to migrate.

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



OsMigration_BeginDownloadOnly

Start to download base layer and app layers for the migration targets. This method validates migration targets first, and then starts to download base layer and app layers.

Required Permissions

AdministerCvds
ListCvds

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
migrationTargetsMigrationTarget[]

An array of MigrationTarget, the count of the target should be no more than 500, which contains information for migration, such as Id of CVD, domain name, user, password and etc. This method validates migration targets first. If some migration targets are failed to validate, these migration targets will be skipped, and other migration targets start to download base layer and app layers.
baseLayerIdImageId

The id of the base layer image.
appLayerIdsImageId[]

The id(s) of app layer images
ignoreWarningsbool

Ignore validation warnings or not. When ignoreWarnings is true, download will start even if there are validation warnings; otherwise download won't start if there is any warning.

Return Value

Type Description
BatchResultFor each CVD, BatchResult has an OperationResult, which presents the result of starting to download. When OperationResult's Success is true, it means the Mirage starts to download base layer and app layers; otherwise check OperationResult's MethodFault to get message why it is failed to start to download.

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



OsMigration_QueryDownloadOnlyCompleted

Deprecated.

Query the CVDs which finish downloading base layer or app layers.

Filter should not be set in this query.

Required Permissions

ListCvds

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
queryDefinitionQueryDefinition

The query filter and page number.

Return Value

Type Description
QueryResultAll the CVDs which finish downloading base layer or app layer in this page.
  • The element in QueryResult can be converted to CvdDetails

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
NotSupportedFaultThrown if the query filter is not null.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



OsMigration_QueryDownloadOnlyInProgress

Deprecated.

Query the CVDs which are downloading base layer or app layers.

Filter should not be set in this query.

Required Permissions

ListCvds

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
queryDefinitionQueryDefinition

The query filter and page number.

Return Value

Type Description
QueryResultAll the CVDs which are downloading base layer or app layer in this page.
  • The element in QueryResult can be converted to CvdDetails

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
NotSupportedFaultThrown if the query filter is not null.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



OsMigrationCvd_QueryDownloadOnly

Query the CVD Ids for download only migration.

Since
Mirage 5.3.0

The filter fields which can be used in query are:

Required Permissions

ListCvds

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
queryDefinitionQueryDefinition

The query filter and page number.

Return Value

Type Description
QueryResultAll the CVD Ids and download only migration status meet the query condition in this page.

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
NotSupportedFaultThrown if the query filter is not null.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



PendingDevice_CreateNewCvd

Create new CVD for the pending devices.

Required Permissions

AdministerCvds
ListDevices

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
deviceIdsId[]

deviceIds is a list of pending devices Ids, the count of the list should be no more than 500. When there are some invalid Ids within this list, this method only creates new CVDs for devices whose Id is valid, while invalid devices will be skipped and method faults will be set in BatchResult.
policyIdImageId

The Id and image version of the policy.
volumeIdId

The target volume Id to be created in. If setting this parameter as null, the system will automatically select a volume to store the CVD.

Return Value

Type Description
BatchResultFor each CVD, BatchResult has an OperationResult, which presents the result of creating the CVD. When OperationResult's Success is true, it means the Mirage starts to create the CVD, and the Result is the IdValue of Id of the new CVD. Otherwise, please check OperationResult's MethodFault to get message why it is failed to create the CVD.

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



PendingDevice_Provision

Provision the devices with base layer, app layers.

Since
Mirage 5.3.0

Required Permissions

AdministerCvds
ListBaseImages
ListDevices
ListLicense
ListPolicies

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
pendingDevicesId[]

pendingDevices is a list of pending devices Ids, the count of the list should be no more than 500. When there are some invalid devices within this list, this method only provision the valid device Ids, while invalid device Ids will be skipped.
policyImageIdImageId

The policy ImageId which will be applied.
baseLayerImageIdImageId

The base layer ImageId which will be used to provision the devices.
appLayerImageIdsImageId[]

The app layer ImageId which will be used to provision the devices.
identityInfoMachineIdentityInfo

The machine identity used to join domain or workgroup.
volumeIdId

The volume Id which CVD will be stored in. If setting this parameter as null, the system will automatically select a volume to store the CVD.
ignoreWarningsbool

Ignore validation warnings or not. When ignoreWarnings is true, provisioning will start even there are warnings of validation; otherwise provisioning won't start when there is an warning.

Return Value

Type Description
BatchResultFor each CVD, BatchResult has an OperationResult, which presents the result of provision the device. When OperationResult's Success is true, it means the Mirage starts to provision the device, and the Result is the IdValue of Id of the new CVD. Otherwise, please check OperationResult's MethodFault to get message why it is failed to provision the device.

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
NotSupportedFaultThrown if the query filter is not null.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



PendingDevice_Query

Query the devices in pending assigment state.

The filter fields which can be used in query are:

Required Permissions

ListDevices

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
queryDefinitionQueryDefinition

The query filter and page number.

Return Value

Type Description
QueryResultAll the pending devices meet the query condition in this page.

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



Policy_Query

Query all the policies in Mirage Management System.

The filter fields which can be used in query are:

Required Permissions

ListPolicies

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
queryDefinitionQueryDefinition

The filter and page number.

Return Value

Type Description
QueryResultAll the policies meet the query condition in this page.

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition



Volume_Query

Query the volumes in Mirage Management System.

The filter fields which can be used in query are:

Required Permissions

ListLicense

Parameters

NameTypeDescription
_thisIMitService A reference to the IMitService used to make the method call.
queryDefinitionQueryDefinition

The query filter and page number.

Return Value

Type Description
QueryResultAll the volumes meet the query condition in this page.

Faults

Type Description
AccessDeniedThrown if the client does not have the permission to access this API.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the request is invalid.
ManagementFaultThrown if exception was thrown from mirage management server with fault code.
NotAuthenticatedThrown if the client is not authenticated.
RuntimeFaultThrown if an unexpected exception occurs while performing the operation.

Show example


Show WSDL type definition