Citrix Daas SDK

Get-ProvSchemeMasterVMImageHistory

August 9, 2024

Contributed by:

C 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>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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

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-->

EXAMPLE 2

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

Get-ProvSchemeMasterVMImageHistory -ProvisioningSchemeName MyScheme -masterImageVM "/BaseXp.vm/update1.snapshot" | Publish-ProvMasterVMImage
<!--NeedCopy-->

Parameters

-ProvisioningSchemeName

The name of the provisioning scheme.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-ProvisioningSchemeUid

The unique identifier of the provisioning scheme.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-MasterImageVM

The inventory path to the VM snapshot item used as the master VM image.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-VMImageHistoryUid

The unique identifier of the image history item.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-ImageStatus

The status of the provisioning scheme image.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-ShowAll

Show all images. This includes images currently in use, and images prepared for later use.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ReturnTotalRecordCount

See about_Prov_Filtering for details.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxRecordCount

See about_Prov_Filtering for details.

Type:	Int32
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Skip

See about_Prov_Filtering for details.

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SortBy

See about_Prov_Filtering for details.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Filter

See about_Prov_Filtering for details.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilterScope

Gets only results allowed by the specified scope id.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

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.

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-ProvSchemeMasterVMImageHistory

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

Get-ProvSchemeMasterVMImageHistory

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-ProvisioningSchemeName

-ProvisioningSchemeUid

-MasterImageVM

-VMImageHistoryUid

-ImageStatus

-ShowAll

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.MachineCreation.Sdk.VMImage

Notes

Related Links

In this article