用于备份和恢复的自动化配置工具 cmdlet

June 2, 2026

投稿者:

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

备份存储 cmdlet

Get-BckRstrStorage

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

参数：

参数名	功能描述
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完整限定文件路径和名称。
`ProfileName`	用于标识现有安全配置文件的参数，取代了以前的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境的类型：生产、政府生产、日本生产、本地部署。
`Quiet`	用于抑制控制台输出的参数。

设置-备份恢复存储

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

参数：

参数名称	详细描述
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	此参数用于指定包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识现有安全配置文件（替代以前的参数）的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境类型：生产、政府生产、日本生产、本地部署。
`Quiet`	用于抑制控制台输出的参数。
`MaximumBackups`	在创建新备份时，备份清理过程删除最旧备份之前，要保留的未固定备份的最大数量。
`MaximumPinnedBackups`	要保留的固定备份的最大数量。这些备份不会被清理过程删除。
`BlobStorageType`	存储类型：`FileStorage` 或 `CustomerAzureStorage`。
`FileStoragefolder`	用于 `BlobStorageType` `FileStorage` 选项的完全限定文件夹规范。
`Info1`	对于 `FileStorage`，可选的 `UserName` 对于 `CustomerAzureStorage`，Azure 共享访问签名 URL
`Info1`
`Info2`	对于 `FileStorage`，可选密码
`Info3` 和 `Info4`	未使用

测试-备份还原存储

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

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

对于 CustomerAzureStorage，测试验证 SAS URL 具有正确的权限，并且当前日期在 URL 的开始和结束日期范围内。

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

参数：

参数名称	详细描述
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件路径和名称。
`ProfileName`	用于标识现有安全配置文件的参数，替代以前的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境类型：生产、政府生产、日本生产、本地部署。
`Quiet`	用于抑制控制台输出的参数。

备份命令集

获取-备份还原备份

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

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

参数：

参数名称	详细说明
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完整限定文件路径和文件名。
`ProfileName`	用于标识现有安全配置文件（取代以前的参数）的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境类型：生产、政府生产、日本生产、本地部署。
`Quiet`	用于禁止向控制台输出的参数。

Get-BckRstrBackupsMembers

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

组件包括：

标签
管理范围
管理员角色
管理管理员 (仅限本地)
主机连接
图标
管理员文件夹
机器目录
StoreFronts
交付组配置
应用程序组
应用程序文件夹
应用程序
App-V 服务器
应用程序库包发现
App-V 隔离组
组策略配置
用户区域首选项
站点数据
区域（仅限本地）

参数：

参数名称	详细说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完整限定文件路径和名称。
`ProfileName`	用于标识现有安全配置文件以替代先前参数的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境的类型：生产、政府生产、日本生产、本地部署。
`Quiet`	用于抑制控制台输出的参数。
`BackupName`	备份的名称。`.zip` 扩展名是可选的。
`Component`	要包含在备份中的组件。

New-BckRstrBackup

在交付控制器上启动新的备份操作。此操作与 New-BckRstrBackup cmdlet 异步。

参数：

参数项	功能描述
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	指定客户信息文件的完整限定文件路径和名称，该文件包含安全和环境信息。
`ProfileName`	用于标识现有安全配置文件（替代以前的参数）的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境的类型：生产、政府生产、日本生产、本地部署。
`Quiet`	用于禁止向控制台输出的参数。
`Notes`	有关备份的备注。
`PollForCompletion`	用于轮询在交付控制器上运行的操作直到操作完成的参数。除非指定了 `Quite` 参数，否则轮询会将进度和完成结果记录到控制台。

固定备份 cmdlet

设置备份恢复固定备份

固定备份，使其不会作为交付控制器备份清理过程的一部分被删除。

参数：

参数名称	描述信息
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完整文件路径和名称规范。
`ProfileName`	用于标识现有安全配置文件的参数，该配置文件用于替代以前的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境类型：生产、政府生产、日本生产、本地部署。
`Quiet`	抑制输出到控制台的参数。
`BackupName`	备份的名称。`.zip` 扩展名是可选的。

Set-BckRstrUnpinBackups

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

参数：

参数项	说明文字
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件路径和名称。
`ProfileName`	用于标识现有安全配置文件的参数，该配置文件取代了以前的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境的类型：生产、政府生产、日本生产、本地部署。
`Quiet`	用于抑制控制台输出的参数。
`BackupName`	备份名称。`.zip` 扩展名是可选的。

删除备份 cmdlet

Remove-BckRstrBackup

删除一个或多个备份。

参数：

Parameter	详细描述
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	此参数表示包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识现有安全配置文件（替代以前的参数）的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境类型：生产、政府生产、日本生产、本地部署。
`Quiet`	用于禁止向控制台输出的参数。
`IncludeByName`	用于指定要考虑恢复的组件成员的过滤器。这是一个逗号分隔的筛选值列表，可以包含通配符 `*` 和 `?`。

计划备份 cmdlet

获取备份恢复计划

获取备份计划列表。

参数：

参数名称	功能描述
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	客户信息文件的完全限定文件规范，该文件包含安全和环境信息。
`ProfileName`	用于标识现有安全配置文件（替代以前的参数）的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境的类型：生产、政府生产、日本生产、本地部署。
`Quiet`	用于抑制控制台输出的参数。
`BackupName`	备份名称。`.zip` 扩展名是可选的。
`Notes`	要设置或更改的备注。

New-BckRstrSchedule

创建新的备份计划。

参数：

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

设置备份还原计划

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

参数：

Parameter	功能描述
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完整限定文件路径和名称。
`ProfileName`	用于标识现有安全配置文件的参数，取代了以前的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境类型：生产、政府生产、日本生产、本地部署。
`Quiet`	用于抑制控制台输出的参数。
`Name`	计划名称。
`Uid`	如果计划名称需要更改。
`Frequency`	频率类型：每日、每周或每月。
`Day`	如果频率是每日。
`DaysInWeek`	如果频率是每周。
`DayInMonth`	如果频率是每月。
`WeekInMonth`	如果频率是每月。
`StartDate`	格式为 `M/d/yy`
`StartTime`	指定为24小时制的开始时间。
`FrequencyFactor`	每 n 次运行一次，例如每天（值 = 1）或每隔一天（值 = 2）
`Description`	此计划备份的详细描述
`Enabled`	启用此备份计划的参数。启用时为 `True`，禁用时为 `false`
`TimeZoneId`	Windows 时区标识符

Set-BckRstrScheduleEnabled

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

参数：

参数名称	功能描述
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完整限定文件路径和名称。
`ProfileName`	用于标识现有安全配置文件（替代以前的参数）的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境的类型：生产环境、政府生产环境、日本生产环境、本地部署。
`Quiet`	用于抑制控制台输出的参数。
`Name`	计划名称。
`Uid`	如果要更改计划名称。

禁用备份恢复计划

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

参数：

参数名称	描述信息
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	其中包含安全和环境相关信息的客户信息文件的完整限定文件规范。
`ProfileName`	用于识别现有安全配置文件的参数，取代了之前的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	The type of production environment: Production, ProductionGov, ProductionJP, OnPrem.
`Quiet`	用于抑制控制台输出的参数。
`Name`	计划名称。
`Uid`	如果计划名称需要更改。

限制备份 cmdlet

设置备份/还原选项

将计划备份限制为每天一次，以避免重复备份。

参数：

参数名称	详细说明
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完整限定文件路径和名称。
`ProfileName`	用于标识现有安全配置文件（替代以前的参数）的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境类型：生产、政府生产、日本生产、本地部署。
`Quiet`	用于抑制控制台输出的参数。
`OneScheduledBackupPerDay`	限制每日计划备份数量为一次以避免重复备份的参数。

还原命令

还原-备份还原备份

从现有备份中，恢复属于单个组件的成员。

参数：

参数名称	描述信息
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完整限定文件路径和名称。
`ProfileName`	用于标识现有安全配置文件（替代以前的参数）的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境的类型：生产、政府生产、日本生产、本地部署。
`Quiet`	用于抑制控制台输出的参数。
`BackupName`	备份的名称。`.zip` 扩展名是可选的。
`Component`	要包含在备份中的组件。
`Notes`	有关备份的备注。
`CheckMode`	此参数用于识别将要还原的组件成员，但它本身不执行实际的还原操作。
`RestoreType`	恢复类型：仅缺失或缺失并更新现有项
`IncludeByName`	用于指定要考虑恢复的组件成员的筛选器。这是一个逗号分隔的筛选器值列表，可以包含通配符 `*` 和 `?`。

历史记录 cmdlet

Get-BckRstrHistory

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

参数：

Parameter	功能描述
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完整且明确的文件路径和名称。
`ProfileName`	用于标识现有安全配置文件（替代以前的参数）的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境的类型：生产、政府版生产、日本版生产、本地部署。
`Quiet`	用于禁止向控制台输出的参数。

Get-BckRstrSpecificBackupHistory

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

参数：

参数名称	Description
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取不记名令牌所需的客户端 ID。
`Secret`	获取不记名令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完整限定文件路径和名称。
`ProfileName`	用于标识现有安全配置文件（替代以前的参数）的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境的类型：生产、政府生产、日本生产、本地部署。
`Quiet`	用于抑制控制台输出的参数。
`BackupName`	备份名称。`.zip` 扩展名是可选的。

Set-BckRstrNotes

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

参数：

参数名称	详细说明
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	客户信息文件的完全限定文件规范，该文件用于存储安全和环境信息。
`ProfileName`	用于标识现有安全配置文件（替代以前的参数）的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`Environment`	生产环境类型：生产、政府生产、日本生产、本地部署。
`Quiet`	用于抑制控制台输出的参数。
`BackupName`	备份的名称。`.zip` 扩展名是可选的。
`Notes`	要设置或更改的备注。

本产品文档的官方版本为英语版本。任何非英语版本仅为方便您而提供，可能包括机器翻译的内容。有关详细信息，请参阅 Cloud Software Group home 上的“机器翻译免责声明”。

这是否有帮助？

用于备份和恢复的自动化配置工具 cmdlet

June 2, 2026

投稿者:

June 2, 2026

投稿者:

这是否有帮助？