产品文档

Citrix DaaS

查看 PDF

这篇文章已经过机器翻译.放弃

切换到英文

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

January 30, 2025

投稿者:

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

备份存储 cmdlet

Get-BckRstrStorage

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

参数：

参数	说明
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识用于代替先前参数的现有安全配置文件的参数。看 XenApp 应用程序 & XenDesktop：适用于 Citrix Cloud 的远程 PowerShell SDK v2 了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于禁止输出到控制台的参数。

Set-BckRstrStorage

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

参数：

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

Test-BckRstrStorage

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

为 文件存储时，测试将验证该文件夹是否存在以及是否可以写入。

为 客户AzureStorage，则测试将验证 SAS URL 是否具有正确的权限，以及当前日期是否包含 URL 的开始日期和结束日期。

返回 真 如果有效且 假 如果无效。

参数：

参数	说明
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识用于代替先前参数的现有安全配置文件的参数。看 XenApp 应用程序 & XenDesktop：适用于 Citrix Cloud 的远程 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）
相关日期和时间
如果在 check-mode 下运行，则相关
持续时间（秒）
管理员名称
枚举每个组件和每个组件中成员计数的详细信息。

参数：

参数	说明
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识用于代替先前参数的现有安全配置文件的参数。看 XenApp 应用程序 & XenDesktop：适用于 Citrix Cloud 的远程 PowerShell SDK v2 了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于禁止输出到控制台的参数。

Get-BckRstrBackups成员

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

这些组件是：

标记
管理员范围
管理员角色
AdminAdministrators（仅限本地）
HostConnections 主机连接
图标
管理员文件夹
机器目录
店面
交付组
应用程序组
应用程序文件夹
应用程序
AppVServers
AppLibPackage发现
AppVIsolation组
组策略
UserZonePreferences 的
站点数据
区域（仅限本地）

参数：

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

New-BckRstrBackup

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

参数：

参数	说明
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识用于代替先前参数的现有安全配置文件的参数。看 XenApp 应用程序 & XenDesktop：适用于 Citrix Cloud 的远程 PowerShell SDK v2 了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于禁止输出到控制台的参数。
`笔记`	有关备份的注释。
`PollForCompletion`	用于轮询 Delivery Controller 上运行的操作直到操作完成为止的参数。轮询会将进度和完成结果记录到控制台中，除非 `相当` 参数。

Pin 备份 cmdlet

Set-BckRstrPin备份

固定备份，使其不会在 Delivery Controller 备份清理过程中被删除。

参数：

参数	说明
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识用于代替先前参数的现有安全配置文件的参数。看 XenApp 应用程序 & XenDesktop：适用于 Citrix Cloud 的远程 PowerShell SDK v2 了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于禁止输出到控制台的参数。
`BackupName`	备份的名称。这 `.zip` extension 是可选的。

Set-BckRstrUnpin备份

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

参数：

参数	说明
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识用于代替先前参数的现有安全配置文件的参数。看 XenApp 应用程序 & XenDesktop：适用于 Citrix Cloud 的远程 PowerShell SDK v2 了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于禁止输出到控制台的参数。
`BackupName`	备份的名称。这 `.zip` extension 是可选的。

删除备份 cmdlet

Remove-BckRstrBackup

删除一个或多个备份。

参数：

参数	说明
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识用于代替先前参数的现有安全配置文件的参数。看 XenApp 应用程序 & XenDesktop：适用于 Citrix Cloud 的远程 PowerShell SDK v2 了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于禁止输出到控制台的参数。
`IncludeByName`	用于指定要考虑进行还原的组件成员的筛选器。这是一个以逗号分隔的筛选条件值列表，可以包含通配符 `*` 和 `?`.

计划备份 cmdlet

Get-BckRstrSchedules

获取备份计划的列表。

参数：

参数	说明
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识用于代替先前参数的现有安全配置文件的参数。看 XenApp 应用程序 & XenDesktop：适用于 Citrix Cloud 的远程 PowerShell SDK v2 了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于禁止输出到控制台的参数。
`BackupName`	备份的名称。这 `.zip` extension 是可选的。
`笔记`	要设置或更改的注释。

New-BckRstrSchedule

创建新的备份计划。

参数：

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

Set-BckRstrSchedule

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

参数：

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

Set-BckRstrScheduleEnabled

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

参数：

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

Set-BckRstrScheduleDisabled

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

参数：

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

限制备份 cmdlet

Set-BckRstrOptions

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

参数：

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

还原 cmdlet

Restore-BckRstrBackups

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

参数：

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

History cmdlets

Get-BckRstrHistory

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

参数：

参数	说明
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识用于代替先前参数的现有安全配置文件的参数。看 XenApp 应用程序 & XenDesktop：适用于 Citrix Cloud 的远程 PowerShell SDK v2 了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于禁止输出到控制台的参数。

Get-BckRstrSpecificBackupHistory

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

参数：

参数	说明
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识用于代替先前参数的现有安全配置文件的参数。看 XenApp 应用程序 & XenDesktop：适用于 Citrix Cloud 的远程 PowerShell SDK v2 了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于禁止输出到控制台的参数。
`BackupName`	备份的名称。这 `.zip` extension 是可选的。

Set-BckRstrNotes

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

参数：

参数	说明
`CustomerId`	获取不记名令牌所需的客户 ID。
`CientId`	获取持有者令牌所需的客户端 ID。
`Secret`	获取持有者令牌所需的密钥。
`CustomerInforFileSpec`	包含安全和环境信息的客户信息文件的完全限定文件规范。
`ProfileName`	用于标识用于代替先前参数的现有安全配置文件的参数。看 XenApp 应用程序 & XenDesktop：适用于 Citrix Cloud 的远程 PowerShell SDK v2 了解如何设置安全配置文件。
`Environment`	生产环境的类型：Production、ProductionGov、ProductionJP、OnPrem。
`Quiet`	用于禁止输出到控制台的参数。
`BackupName`	备份的名称。这 `.zip` extension 是可选的。
`笔记`	要设置或更改的注释。

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

这是否有帮助？

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

January 30, 2025

投稿者:

在本文中

这是否有帮助？