产品文档

Citrix Virtual Apps and Desktops

查看 PDF

用于备份和还原的自动配置工具 cmdlet

November 25, 2025

投稿者:

此页面列出了该工具支持的所有 cmdlet 和参数，以触发 Web Studio 使用的备份和还原 API。

备份存储 cmdlet

Get-BckRstrStorage

此 cmdlet 仅适用于本地。获取保存备份的存储的详细信息。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。

Set-BckRstrStorage

此 cmdlet 仅适用于本地。设置保存备份的新存储。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`MaximumBackups`	在创建新备份时，备份清理过程删除最旧的备份之前，要保留的取消固定备份的最大数量。
`MaximumPinnedBackups`	要保留的固定备份的最大数量。清理过程不会删除这些备份。
`BlobStorageType`	存储类型：`FileStorage` 或 `CustomerAzureStorage`。
`FileStoragefolder`	`BlobStorageType` `FileStorage` 选项的完全限定文件夹规范。
`Info1`	对于 `FileStorage`，可选 `UserName` 对于 `CustomerAzureStorage`，Azure SAS URL
`Info1`
`Info2`	对于 `FileStorage`，可选密码
`Info3` 和 `Info4`	未使用

Test-BckRstrStorage

此 cmdlet 仅适用于本地。测试以确定定义的存储是否有效。

对于 FileStorage，测试将验证该文件夹是否存在并且可以写入。

对于 CustomerAzureStorage，测试将验证 SAS URL 是否具有正确的权限，以及当前日期是否与 URL 的开始日期和结束日期一致。

如果有效则返回 true，如果无效则返回 false。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。

备份 cmdlet

Get-BckRstrBackups

枚举存储在备份或还原 blob 存储位置的备份。对于 Citrix Virtual Apps and Desktops™，此位置由管理员通过 WebStudio 设置。对于 DaaS，这是预先存在的客户 Azure 存储。使用 Get-BckRstrBackupsWithDetiails 获取有关每个备份的完整信息。备份详细信息包括以下内容：

备份名称
备注
已固定（true 或 false）
备份的日期和时间
历史记录 UID
相关 UID（上次还原历史记录的 UID）
相关日期和时间
如果在检查模式下运行，则相关
持续时间（秒）
管理员姓名
枚举每个组件以及每个组件中的成员数量的详细信息。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。

Get-BckRstrBackupsMembers

枚举存储在选定备份中的单个组件的成员。成员姓名以简单列表的形式返回。

这些组件包括：

标记
AdminScopes
AdminRoles
AdminAdministrators（仅限本地）
HostConnections
图标
AdminFolders
MachineCatalogs
StoreFront
DeliveryGroups
应用程序组
ApplicationFolders
应用程序
AppVServers
AppLibPackageDiscovery
AppVIsolationGroups
GroupPolicies
UserZonePreferences
SiteData
Zones（仅限本地）

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`BackupName`	备份的名称。 `.zip` 扩展名是可选的。
`Component`	要在备份中包含的组件。

New-BckRstrBackup

在 Delivery Controller 上启动新备份操作。此操作与 New-BckRstrBackup cmdlet 异步。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`备注`	关于备份的注释。
`PollForCompletion`	用于轮询在 Delivery Controller 上运行的操作直至操作完成的参数。除非指定了 `Quite` 参数，否则轮询会将进度和完成结果记录到控制台。

固定备份 cmdlet

Set-BckRstrPinBackups

固定备份，以便不会在 Delivery Controller 备份清理过程中将其删除。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`BackupName`	备份的名称。 `.zip` 扩展名是可选的。

Set-BckRstrUnpinBackups

取消固定备份，以便可以在 Delivery Controller 备份清理过程中将其删除。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`BackupName`	备份的名称。 `.zip` 扩展名是可选的。

删除备份 cmdlet

Remove-BckRstrBackup

删除一个或多个备份。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`IncludeByName`	用于指定要考虑还原哪些组件成员的过滤器。这是以逗号分隔的过滤器值列表，可以包含通配符 `*` 和 `?`。

计划备份 cmdlet

Get-BckRstrSchedules

获取备份计划列表。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`BackupName`	备份的名称。 `.zip` 扩展名是可选的。
`备注`	要设置或更改的注释。

New-BckRstrSchedule

创建新备份计划。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`Name`	计划名称。
`Frequency`	频率类型：每日、每周或每月。
`Day`	如果频率是每天。
`DaysInWeek`	如果频率是每周。
`DayInMonth`	如果频率是每月。
`WeekInMonth`	如果频率是每月。
`StartDate`	格式为 `M/d/yy`
`StartTime`	开始时间指定为 24 小时制。
`FrequencyFactor`	每 n 次运行一次，例如每天（值 = 1）或每隔一天（值 = 2）运行一次
`说明`	计划备份的说明
`Enabled`	用于启用此备份计划的参数。启用时设置为 `true`，禁用时设置为 `false`
`TimeZoneId`	Windows 时区 ID

Set-BckRstrSchedule

修改现有的备份计划。提供名称或 UID 来选择要修改的计划。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`Name`	计划名称。
`Uid`	如果要更改计划名称。
`Frequency`	频率类型：每日、每周或每月。
`Day`	如果频率是每天。
`DaysInWeek`	如果频率是每周。
`DayInMonth`	如果频率是每月。
`WeekInMonth`	如果频率是每月。
`StartDate`	格式为 `M/d/yy`
`StartTime`	开始时间指定为 24 小时制。
`FrequencyFactor`	每 n 次运行一次，例如每天（值 = 1）或每隔一天（值 = 2）运行一次
`说明`	计划备份的说明
`Enabled`	用于启用此备份计划的参数。启用时设置为 `true`，禁用时设置为 `false`
`TimeZoneId`	Windows 时区 ID

Set-BckRstrScheduleEnabled

启用现有的备份计划。提供名称或 UID 来选择要启用的计划。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`Name`	计划名称。
`Uid`	如果要更改计划名称。

Set-BckRstrScheduleDisabled

禁用现有的备份计划。提供名称或 UID 来选择要禁用的计划。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`Name`	计划名称。
`Uid`	如果要更改计划名称。

限制备份 cmdlet

Set-BckRstrOptions

将计划的备份限制为每天一次，以避免相同的备份。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`OneScheduledBackupPerDay`	此参数将计划的备份限制为每天一次，以避免相同的备份。

还原 cmdlet

Restore-BckRstrBackups

从现有备份中还原单个组件中的成员。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`BackupName`	备份的名称。 `.zip` 扩展名是可选的。
`Component`	要在备份中包含的组件。
`备注`	关于备份的注释。
`CheckMode`	此参数用于标识要还原的组件成员，但不执行实际的还原。
`RestoreType`	还原类型：MissingOnly 或 MissingUpdateExisting
`IncludeByName`	用于指定要考虑还原哪些组件成员的过滤器。这是以逗号分隔的过滤器值列表，可以包含通配符 `*` 和 `?`。

历史记录 cmdlet

Get-BckRstrHistory

获取所有操作的历史记录详细信息列表。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。

Get-BckRstrSpecificBackupHistory

获取特定备份的历史记录详细信息列表。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`BackupName`	备份的名称。 `.zip` 扩展名是可选的。

Set-BckRstrNotes

设置或更改历史记录中的注释。

参数：

参数	说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识代替先前参数的现有安全配置文件的参数。请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud（XenApp and XenDesktop：适用于 Citrix Cloud 的 Remote PowerShell SDK v2），了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于抑制向控制台的输出的参数。
`BackupName`	备份的名称。 `.zip` 扩展名是可选的。
`备注`	要设置或更改的注释。

本内容的正式版本为英文版。部分 Cloud Software Group 文档内容采用了机器翻译，仅供您参考。Cloud Software Group 无法控制机器翻译的内容，这些内容可能包含错误、不准确或不合适的语言。对于从英文原文翻译成任何其他语言的内容的准确性、可靠性、适用性或正确性，或者您的 Cloud Software Group 产品或服务沿用了任何机器翻译的内容，我们均不作任何明示或暗示的保证，并且适用的最终用户许可协议或服务条款或者与 Cloud Software Group 签订的任何其他协议（产品或服务与已进行机器翻译的任何文档保持一致）下的任何保证均不适用。对于因使用机器翻译的内容而引起的任何损害或问题，Cloud Software Group 不承担任何责任。

这是否有帮助？

用于备份和还原的自动配置工具 cmdlet

November 25, 2025

投稿者:

November 25, 2025

投稿者:

这是否有帮助？