Get-ProvVMBackup
Introduced in: Citrix Virtual Apps and Desktop 7 2411
Gets the provisioned backups created using Machine Creation Services.
Syntax
Get-ProvVMBackup
[[-ProvisioningSchemeUid] <Guid>]
[[-ProvisioningSchemeName] <String>]
[-ScheduleId <Guid>]
[-VMName <String>]
[-BackupName <String>]
[-BackupUid <Guid>]
[-UserVisible <Boolean>]
[-DeletionProtected <Boolean>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to obtain a list of provisioned backups that were created using Citrix Machine Creation Services.
Examples
EXAMPLE 1
Gets all the Provisioned Backups of Virtual Machines that were provisioned using the Maintenance Schedule ID called 'MyScheduleID'.
Get-ProvVMBackup -MaintenanceScheduleId MyScheduleID
CreationDate : 17/05/2021 09:35:22
ProvisioningSchemeName : XenPS
ProvisioningSchemeUid : 5135a865-ba49-4e5f-87f2-2d65ee7a4e51
BackupId : f312dteh-ddc5-8bd1-jh5e-4bjd44h39gck
BackupName : Backup002
ProvisioningSchemeVersion : 1
VMId : a830de93-ddc5-b763-dc1a-35580a31401c
VMName : IP0051
HostingUnitUid : ea17840f-cf2d-4d80-94e0-3b752b32e0af
HypervisorConnectionUid : 99f9f826-31fc-4453-8ca0-9ba54306c3ac
DeletionProtection : true
EXAMPLE 2
Gets all the Provisioned Backups of Virtual Machines that were provisioned using the Provisioning Scheme called 'MyScheme'.
Get-ProvVMBackup -provisioningSchemeName MyScheme
CreationDate : 17/05/2021 09:35:22
ProvisioningSchemeName : XenPS
ProvisioningSchemeUid : 5135a865-ba49-4e5f-87f2-2d65ee7a4e51
BackupId : f312dteh-ddc5-8bd1-jh5e-4bjd44h39gck
BackupName : Backup003
ProvisioningSchemeVersion : 1
VMId : a830de93-ddc5-b763-dc1a-35580a31401c
VMName : IP0051
HostingUnitUid : ea17840f-cf2d-4d80-94e0-3b752b32e0af
HypervisorConnectionUid : 99f9f826-31fc-4453-8ca0-9ba54306c3ac
DeletionProtection : true
EXAMPLE 3
Gets all the Provisioned Backups with deletion protection, regardless of which Provisioning Scheme the associated VM was created with.
Get-ProvVMBackup -DeletionProtected $true
CreationDate : 17/05/2021 09:35:22
ProvisioningSchemeName : XenPS
ProvisioningSchemeUid : 5135a865-ba49-4e5f-87f2-2d65ee7a4e51
BackupId : f312dteh-ddc5-8bd1-jh5e-4bjd44h39gck
BackupName : Backu003
ProvisioningSchemeVersion : 1
VMId : a830de93-ddc5-b763-dc1a-35580a31401c
VMName : IP0051
HostingUnitUid : ea17840f-cf2d-4d80-94e0-3b752b32e0af
HypervisorConnectionUid : 99f9f826-31fc-4453-8ca0-9ba54306c3ac
DeletionProtection : true
Parameters
-ScheduleId
The unique identifier of the maintenance schedule.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-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 |
-BackupName
The name of the provisioned backup in the hypervisor.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-BackupUid
The Uid of the provisioned backup in the hypervisor.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-UserVisible
Indicates whether the backup 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 backups that are marked as deletion protected are returned or not (see Delete-ProvVMBackup 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.ProvisionedBackup
The object has the following properties:
CreationDate \<DateTime\>
The date and time when the backup 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 backup.
ProvisioningSchemeUid \<Guid\>
The unique identifier of the provisioning scheme associated with the backup.
ProvisioningSchemeVersion \<int\>
The version of the provisioning scheme used by the associated VM at the time of backup creation.
BackupName \<string\>
The name of the provisioned backup.
BackupUid \<Guid\>
The unique identifier of the provisioned backup.
Description \<string\>
The description of the provisioned backup.
DeletionProtection \<bool\>
Flag indicating if backup requires explicit deletion.
UerVisible \<bool\>
Flag indicating if backup is visible to users.
HypervisorID\<string\>
The hypervisor identifier of the provisioned backup.
ScheduleId \<Guid\>
The unique identifier of the maintenance schedule associated with the backup.
VMName \<string\>
The name of the associated VM in the hypervisor.
VMId \<string\>
The identifier for the associated VM in the hypervisor.
ProvVMConfigurationVersion \<int\>
The version of the custom configuration used by the associated VM at the time of backup creation.
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.
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.