-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
-
-
-
-
-
-
Get-ProvVMSnapshot
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-ProvVMSnapshot
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.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.