Automated configuration tool cmdlets for backup and restore
This page lists all the cmdlets and parameters supported by the tool to trigger the backup and restore APIs that Studio uses.
Backup storage cmdlets
Get-BckRstrStorage
This cmdlet is applicable to only on-premises. Gets details for the storage where backups are saved.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
Set-BckRstrStorage
This cmdlet is applicable to only on-premises. Sets a new storage where backups are saved.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
MaximumBackups |
The maximum number of unpinned backups to be persisted until the backup cleanup process removes the oldest backups when new backups are created. |
MaximumPinnedBackups |
The maximum number of pinned backups to be persisted. These backups are not removed by the cleanup process. |
BlobStorageType |
The type of storage: FileStorage or CustomerAzureStorage. |
FileStoragefolder |
The fully qualified folder specification for the BlobStorageType FileStorage option. |
Info1
|
For FileStorage, optional UserNameFor CustomerAzureStorage, the Azure SAS URL |
Info2 |
For FileStorage, optional Password |
Info3 and Info4
|
Not used |
Test-BckRstrStorage
This cmdlet is applicable to only on-premises. Tests to determine that the defined storage is valid.
For FileStorage, the test verifies that the folder exists and can be written to.
For CustomerAzureStorage, the test verifies that the SAS URL has the correct permissions and the current date is with the URL’s start and end date.
Returns true if valid and false if invalid.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
Back up cmdlets
Get-BckRstrBackups
Enumerates backups stored in the Backup or Restore blob storage location. For Citrix Virtual Apps and Desktops, this location is set up by the administrator through WebStudio. For DaaS, this is the pre-existing customer Azure storage. Use Get-BckRstrBackupsWithDetiails for complete information about each backup. Backup details include the following:
- Backup Name
- Notes
- Pinned (true or false)
- Date and time of backup
- History UID
- Related UID (UID of last Restore history record)
- Related Date and time
- Related if run in check-mode
- Duration in seconds
- Administrator name
- Details enumerating each component and count of members in each component.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
Get-BckRstrBackupsMembers
Enumerates a single component’s members stored in a selected backup. Member names are returned in a simple list.
The components are:
- Tags
- AdminScopes
- AdminRoles
- AdminAdministrators (on-premises only)
- HostConnections
- Icons
- AdminFolders
- MachineCatalogs
- StoreFronts
- DeliveryGroups
- ApplicationGroups
- ApplicationFolders
- Applications
- AppVServers
- AppLibPackageDiscovery
- AppVIsolationGroups
- GroupPolicies
- UserZonePreferences
- SiteData
- Zones (on-premises only)
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
BackupName |
The name of backup. The .zip extension is optional. |
Component |
The components to be included in backup. |
New-BckRstrBackup
Starts a new backup action on the Delivery Controller. This action is asynchronous to the New-BckRstrBackup cmdlet.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
Notes |
The notes about the backup. |
PollForCompletion |
The parameter to poll the action running on the Delivery Controller until the action completes. The polling logs progress and completion results to the console unless the Quite parameter is specified. |
Pin backups cmdlets
Set-BckRstrPinBackups
Pins a backup so it is not removed as part of the Delivery Controller backup cleaning process.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
BackupName |
The name of backup. The .zip extension is optional. |
Set-BckRstrUnpinBackups
Unpins a backup so it is available to be removed in the Delivery Controller backup cleaning process.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
BackupName |
The name of backup. The .zip extension is optional. |
Remove backup cmdlet
Remove-BckRstrBackup
Removes one or more backups.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
IncludeByName |
The filter to specify which component members to consider for restore. This is a comma separated list of filter values and can have the wildcard characters * and ?. |
Scheduled backups cmdlets
Get-BckRstrSchedules
Gets a list of backup schedules.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
BackupName |
The name of backup. The .zip extension is optional. |
Notes |
The notes to set or change. |
New-BckRstrSchedule
Creates a new backup schedule.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
Name |
The schedule name. |
Frequency |
The type of frequency: Daily, Weekly, or Monthly. |
Day |
If the frequency is daily. |
DaysInWeek |
If the frequency is weekly. |
DayInMonth |
If the frequency is monthly. |
WeekInMonth |
If the frequency is monthly. |
StartDate |
The format is M/d/yy
|
StartTime |
The start time specified as a 24 hour clock. |
FrequencyFactor |
Run every n times such as every day (value = 1) or every other day (value = 2) |
Description |
The description of the scheduled backup |
Enabled |
The parameter to enable this backup schedule. True when enabled and false when disabled |
TimeZoneId |
The Windows Time Zone Id |
Set-BckRstrSchedule
Modifies an existing backup schedule. Provide the name or Uid to select the schedule to modify.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
Name |
The schedule name. |
Uid |
If the schedule name is to be changed. |
Frequency |
The type of frequency: Daily, Weekly, or Monthly. |
Day |
If the frequency is daily. |
DaysInWeek |
If the frequency is weekly. |
DayInMonth |
If the frequency is monthly. |
WeekInMonth |
If the frequency is monthly. |
StartDate |
The format is M/d/yy
|
StartTime |
The start time specified as a 24 hour clock. |
FrequencyFactor |
Run every n times such as every day (value = 1) or every other day (value = 2) |
Description |
The description of the scheduled backup |
Enabled |
The parameter to enable this backup schedule. True when enabled and false when disabled |
TimeZoneId |
The Windows Time Zone Id |
Set-BckRstrScheduleEnabled
Enables an existing backup schedule. Provide the name or Uid to select the schedule to enable.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
Name |
The schedule name. |
Uid |
If the schedule name is to be changed. |
Set-BckRstrScheduleDisabled
Disables an existing backup schedule. Provide the name or Uid to select the schedule to disable.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
Name |
The schedule name. |
Uid |
If the schedule name is to be changed. |
Limit backups cmdlet
Set-BckRstrOptions
Limits scheduled backups to one per day to avoid identical backups.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
OneScheduledBackupPerDay |
The parameter to limit scheduled backups to one per day to avoid identical backups. |
Restore cmdlet
Restore-BckRstrBackups
Restores members from a single component from an existing backup.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
BackupName |
The name of backup. The .zip extension is optional. |
Component |
The components to be included in backup. |
Notes |
The notes about the backup. |
CheckMode |
The parameter to identify component members that would be restored but does not perform the actual restore. |
RestoreType |
The restore type: MissingOnly or MissingUpdateExisting |
IncludeByName |
The filter to specify which component members to consider for restore. This is a comma separated list of filter values and can have the wildcard characters * and ?. |
History cmdlets
Get-BckRstrHistory
Gets a list history details for all actions.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
Get-BckRstrSpecificBackupHistory
Gets a list of history details for a specific backup.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
BackupName |
The name of backup. The .zip extension is optional. |
Set-BckRstrNotes
Sets or changes the notes in a history record.
Parameters:
| Parameter | Description |
|---|---|
CustomerId |
The customer ID needed to obtain a bearer token. |
CientId |
The client ID needed to obtain a bearer token. |
Secret |
The secret needed to obtain a bearer token. |
CustomerInforFileSpec |
The fully qualified file specification of the customer info file containing security and environment information. |
ProfileName |
The parameter to identify an existing security profile used in place of the previous parameters. See XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud for how to set security profiles. |
Environment |
The type of production environment: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
The parameter to suppress output to the console. |
BackupName |
The name of backup. The .zip extension is optional. |
Notes |
The notes to set or change. |
Automated configuration tool cmdlets for backup and restore
Copied!
Failed!