Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-ProvSchemeMasterVMImageHistory

March 11, 2024
Contributed by: 
C

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>] [-ImageStatus <String>] [-ShowAll] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to discover the master VM snapshots used to provide the hard disk image for provisioning schemes. This information includes the date and time when the image was created.

By default, this cmdlet returns only those snapshots that have been used previously. This information can be used to roll-back a provisioning scheme to a previous image.

The ShowAll parameter may be supplied to also show the snapshot for the image currently in use, and the snapshots for any images prepared for later use.

Parameters

Name Description Required? Pipeline Input Default Value
ProvisioningSchemeName The name of the provisioning scheme. false false  
ProvisioningSchemeUid The unique identifier of the provisioning scheme. false false  
MasterImageVM The inventory path to the VM snapshot item used as the master VM image. false false  
VMImageHistoryUid The unique identifier of the image history item. false false  
ImageStatus The status of the provisioning scheme image. false false  
ShowAll Show all images. This includes images currently in use, and images prepared for later use. false false false
ReturnTotalRecordCount See about_Prov_Filtering for details. false false false
MaxRecordCount See about_Prov_Filtering for details. false false false
Skip See about_Prov_Filtering for details. false false 0
SortBy See about_Prov_Filtering for details. false false  
Filter See about_Prov_Filtering for details. false false  
FilterScope Gets only results allowed by the specified scope id. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
AdminClientIP Specifies the Client IP of the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing user false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress The address of a Citrix Virtual Apps and Desktops controller that the PowerShell snap-in connects to. You can provide this as a host name or an IP address. false false LocalHost. When a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

Citrix.Machinecreation.Sdk.Vmimage

This object represents a master VM image history item. It contains the following parameters:

  • VMImageHistoryUid <Guid> The unique identifier of the history item.

  • ProvisioningSchemeUid <Guid> The unique identifier of the provisioning scheme used for the VM.

  • ProvisioningSchemeName <string> The name of the provisioning scheme used for the VM.

  • MasterImageVM <string> The inventory path to the Snapshot item that was used as the master VM image.

  • Date <DateTime> The date and time when the VM or snapshot was used in the provisioning scheme.

  • FunctionalLevel <string> The FunctionalLevel of the VDA installed on the VM.

  • ImageStatus <string> The status of the provisioning scheme image.

  • MasterImageId <string> The unique identifier of the snapshot, as assigned by the hosting unit.

  • MasterImageNote <string> The note of the provisioning scheme image.

Notes

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

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. For more details, see the Windows event logs on the controller being used or Citrix Virtual Apps and Desktops 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/2020 09:27:50

FunctionalLevel        :

ImageStatus            : Current

MasterImageId          : base-vm\base

MasterImageNote        : Office365 installed

<!--NeedCopy-->

Description

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

Example 2 


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

<!--NeedCopy-->

Description

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

Get-ProvSchemeMasterVMImageHistory
March 11, 2024
Contributed by: 
C
March 11, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.