产品文档

Citrix DaaS™

查看 PDF

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

September 12, 2025

投稿者:

C C

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

备份存储 cmdlet

Get-BckRstrStorage

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

参数：

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

Set-BckRstrStorage

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

参数：

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

Test-BckRstrStorage

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

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

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

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

参数：

Parameter	Description
`CustomerId`	获取持有者令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识现有安全配置文件的参数，取代了以前的参数。有关如何设置安全配置文件，请参阅 XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud。
`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）
相关日期和时间
如果在检查模式下运行则相关
持续时间（秒）
管理员名称
枚举每个组件及其成员数量的详细信息。

参数：

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

Get-BckRstrBackupsMembers

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

组件包括：

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

参数：

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

New-BckRstrBackup

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

参数：

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

固定备份 cmdlet

Set-BckRstrPinBackups

固定备份，使其不会作为 Delivery Controller 备份清理过程的一部分被移除。

参数：

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

Set-BckRstrUnpinBackups

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

参数：

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

移除备份 cmdlet

Remove-BckRstrBackup

移除一个或多个备份。

参数：

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

计划备份 cmdlet

Get-BckRstrSchedules

获取备份计划列表。

参数：

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

New-BckRstrSchedule

创建新的备份计划。

参数：

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

Set-BckRstrSchedule

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

参数：

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

Set-BckRstrScheduleEnabled

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

参数：

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

Set-BckRstrScheduleDisabled

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

参数：

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

限制备份 cmdlet

Set-BckRstrOptions

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

参数：

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

还原 cmdlet

Restore-BckRstrBackups

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

参数：

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

历史记录 cmdlet

Get-BckRstrHistory

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

参数：

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

Get-BckRstrSpecificBackupHistory

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

参数：

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

Set-BckRstrNotes

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

参数：

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

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

这是否有帮助？

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

September 12, 2025

投稿者:

C C

September 12, 2025

投稿者:

C C

这是否有帮助？