Citrix Virtual Apps and Desktops SDK

Get-ProvVMSnapshot

August 9, 2024

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Gets the provisioned snapshots created using Machine Creation Services.

Syntax

Get-ProvVMSnapshot
   [[-ProvisioningSchemeUid] <Guid>]
   [[-ProvisioningSchemeName] <String>]
   [-VMName <String>]
   [-SnapshotName <String>]
   [-UserVisible <Boolean>]
   [-DeletionProtected <Boolean>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to obtain a list of provisioned snapshots that were created using Citrix Machine Creation Services.

Examples

EXAMPLE 1

Gets all the Provisioned Snapshots of Virtual Machines that were provisioned using the Provisioning Scheme called ‘MyScheme’.

Get-ProvVMSnapshot -provisioningSchemeName MyScheme
CreationDate              : 17/05/2021 09:35:22
ProvisioningSchemeName    : XenPS
ProvisioningSchemeUid     : 5135a865-ba49-4e5f-87f2-2d65ee7a4e51
SnapshotId                : f312dteh-ddc5-8bd1-jh5e-4bjd44h39gck
SnasphotName              : Snaspht003
ProvisioningSchemeVersion : 1
VMId                      : a830de93-ddc5-b763-dc1a-35580a31401c
VMName                    : IP0051
HostingUnitUid            : ea17840f-cf2d-4d80-94e0-3b752b32e0af
HypervisorConnectionUid   : 99f9f826-31fc-4453-8ca0-9ba54306c3ac
DeletionProtection        : true
<!--NeedCopy-->

EXAMPLE 2

Gets all the Provisioned Snapshots with deletion protection, regardless of which Provisioning Scheme the associated VM was created with.

Get-ProvVMSnapshot -DeletionProtected $true
CreationDate              : 17/05/2021 09:35:22
ProvisioningSchemeName    : XenPS
ProvisioningSchemeUid     : 5135a865-ba49-4e5f-87f2-2d65ee7a4e51
SnapshotId                : f312dteh-ddc5-8bd1-jh5e-4bjd44h39gck
SnasphotName              : Snaspht003
ProvisioningSchemeVersion : 1
VMId                      : a830de93-ddc5-b763-dc1a-35580a31401c
VMName                    : IP0051
HostingUnitUid            : ea17840f-cf2d-4d80-94e0-3b752b32e0af
HypervisorConnectionUid   : 99f9f826-31fc-4453-8ca0-9ba54306c3ac
DeletionProtection        : true
<!--NeedCopy-->

Parameters

-VMName

The name of the associated VM in the hypervisor.

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

-SnapshotName

The name of the provisioned snapshot in the hypervisor.

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

-UserVisible

Indicates whether whether the snapshot is visible to users.

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

-DeletionProtected

Indicates whether only provisioned snapshots that are marked as deletion protected are returned or not (see Delete-ProvVMSnapshot for details).

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

-ReturnTotalRecordCount

When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Prov_Filtering for details.

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

-MaxRecordCount

Specifies the maximum number of records to return.

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

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

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

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Type:	String
Position:	Named
Default value:	The default sort order is by name or unique identifier.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Filter

Gets records that match a PowerShell-style filter expression. 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

-ProvisioningSchemeUid

The unique identifier of the provisioning scheme.

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

-ProvisioningSchemeName

The name of the provisioning scheme.

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

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

The object has the following properties:

CreationDate <DateTime>

The date and time when the snapshot was created.

Domain <string>

The Domain of the AD computer account that the VM is using.

ProvisioningSchemeName <string>

The name of the provisioning scheme associated with the snapshot.

ProvisioningSchemeUid <Guid>

The unique identifier of the provisioning scheme associated with the snapshot.

ProvisioningSchemeVersion <int>

The version of the provisioning scheme used by the associated VM at the time of snapshot creation.

ProvVMConfigurationVersion <int>

The version of the custom configuration used by the associated VM at the time of snapshot creation.

SnapshotUid <Guid>

The unique identifier of the provisioned snapshot.

HypervisorID<string>

The hypervisor identifier of the provisioned snapshot.

SnapshotName <string>

The name of the provisioned snapshot.

VMId <string>

The identifier for the associated VM in the hypervisor.

VMName <string>

The name of the associated VM in the hypervisor.

HostingUnitUid <Guid>

The unique identifier of the hosting unit that was used to create the associated VM.

HypervisorConnectionUid <Guid>

The unique identifier of the hypervisor connection that was used to create the associated VM.

DeletionProtection <bool>

Flag indicating if snapshot requires explicit deletion.

Notes

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

Error Codes

PartialData

Only a subset of the available data was returned.

CouldNotQueryDatabase

The query required to get the database was not defined.

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

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

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Get-ProvVMSnapshot

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-VMName

-SnapshotName

-UserVisible

-DeletionProtected

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

-ProvisioningSchemeUid

-ProvisioningSchemeName

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.MachineCreation.Sdk.ProvisionedSnapshot

Notes

Related Links

In this article