Product Documentation

Get-ProvSchemeMasterVMImageHistory

Nov 06, 2015

Gets the list of master VM snapshots that have been used to provide hard disks to provisioning schemes.

Syntax

Get-ProvSchemeMasterVMImageHistory [-ProvisioningSchemeName <String>] [-ProvisioningSchemeUid <Guid>] [-MasterImageVM <String>] [-VMImageHistoryUid <Guid>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Provides the ability to discover the master VM snapshots that have been used previously to provide the hard disk image for provisioning schemes. This information includes the date and time when the image was introduced. This information can be used to roll back a provisioning scheme to a previous image.

Parameters

-ProvisioningSchemeName<String>

The name of the provisioning scheme.

Required? false
Default Value  
Accept Pipeline Input? false

-ProvisioningSchemeUid<Guid>

The unique identifier of the provisioning scheme.

Required? false
Default Value  
Accept Pipeline Input? false

-MasterImageVM<String>

The path to the snapshot item in the hosting unit PowerShell provider.

Required? false
Default Value  
Accept Pipeline Input? false

-VMImageHistoryUid<Guid>

The unique identifier for the Image History item.

Required? false
Default Value  
Accept Pipeline Input? false

-ReturnTotalRecordCount<SwitchParameter>

See about_Prov_Filtering for details.

Required? false
Default Value false
Accept Pipeline Input? false

-MaxRecordCount<Int32>

See about_Prov_Filtering for details.

Required? false
Default Value false
Accept Pipeline Input? false

-Skip<Int32>

See about_Prov_Filtering for details.

Required? false
Default Value 0
Accept Pipeline Input? false

-SortBy<String>

See about_Prov_Filtering for details.

Required? false
Default Value  
Accept Pipeline Input? false

-Filter<String>

See about_Prov_Filtering for details.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller that the PowerShell snap-in connects to. You can provide this as a host name or an IP address.

Required? false
Default Value LocalHost. Once a value is provided by any cmdlet, this value becomes the default.
Accept Pipeline Input? false

Return Values

Citrix.MachineCreation.Sdk.VMImage

The object that represents a master VM history. This contains the following parameters:

VMImageHistoryUid <Guid>

The unique identifier for the History item.

ProvisioningSchemeUid <Guid>

The unique identifier for the provisioning scheme that the VM was used for.

ProvisioningSchemeName <string>

The name of the provisioning scheme that the VM was used for.

MasterImageVM <string>

The path to the Snapshot item that was used as the master VM image.

Date <DateTime>

The date and time that the VM or snapshot was used in the provisioning scheme.

Notes

In the case of failure, the following errors can result.

Error Codes

-----------

PartialData

Only a subset of the available data was returned.

PermissionDenied

The user does not have administrative rights to perform this operation.

ConfigurationLoggingError

The operation could not be performed because of a configuration logging error

CouldNotQueryDatabase

The query required to get the database was not defined.

CommunicationError

An error occurred while communicating with the service.

DatabaseNotConfigured

The operation could not be completed because the database for the service is not configured.

InvalidFilter

A filtering expression was supplied that could not be interpreted for this cmdlet.

ExceptionThrown

An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS>Get-ProvSchemeMasterVMImageHistory 
 
 
VMImageHistoryUid      : 3cba3a75-89cd-4868-989b-27feb378fec5 
ProvisioningSchemeUid  : 7585f0de-192e-4847-a6d8-22713c3a2f42 
ProvisioningSchemeName : MyScheme 
MasterImageVM          : /Base.vm/base.snapshot 
Date                   : 17/05/2010 09:27:50

Gets all the hard disk images that have been used across all provisioning schemes.

-------------------------- EXAMPLE 2 --------------------------

C:\PS>Get-ProvSchemeMasterVMImageHistory -ProvisioningScheme MyScheme -masterImageVM "/BaseXp.vm/update1.snapshot" | Publish-ProvMasterVmImage

Roll back the provisioning scheme to use the hard disk from the update1.snapshot for the provisioning scheme called "MyScheme".