Restore-SPFarm

从备份还原一个或多个项目。

语法

DefaultSet

Restore-SPFarm
    -Directory <String>
    -RestoreMethod <String>
    [-AssignmentCollection <SPAssignmentCollection>]
    [-BackupId <Guid>]
    [-ConfigurationOnly]
    [-Confirm]
    [-FarmCredentials <PSCredential>]
    [-Force]
    [-Item <String>]
    [-NewDatabaseServer <String>]
    [-Percentage <Int32>]
    [-RestoreThreads <Int32>]
    [-WhatIf]
    [<CommonParameters>]

ShowTree

Restore-SPFarm
    -Directory <String>
    [-ShowTree]
    [-AssignmentCollection <SPAssignmentCollection>]
    [-BackupId <Guid>]
    [-ConfigurationOnly]
    [-Confirm]
    [-Item <String>]
    [-WhatIf]
    [<CommonParameters>]

说明

此 cmdlet 包含多个参数集。 只能使用一个参数集中的参数,而不能结合使用不同参数集中的参数。 若要详细了解如何使用参数集,请参阅 Cmdlet 参数集

cmdlet Restore-SPFarm 从备份(例如单个数据库、Web 应用程序或整个场)还原一个或多个项。 此 cmdlet 还可用于将服务器场模板应用于整个服务器场。

有关适用于 SharePoint 产品的 Windows PowerShell 的权限和最新信息,请参阅 SharePoint Server cmdlet

示例

示例 1

Restore-SPFarm -Directory \\file_server\share\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -RestoreMethod new -ConfigurationOnly

此示例将配置设置从 \\file_server\share\Backup 目录中的备份包还原到服务器场。

示例 2

Restore-SPFarm -ShowTree -Directory \\file_server\share\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -Item "Microsoft SharePoint Foundation Web Application" -Verbose

此示例显示在 Microsoft SharePoint Foundation Web Application 节点下将还原的服务器场的组件,但实际并不进行还原。

示例 3

Restore-SPFarm -Directory C:\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef  -RestoreMethod overwrite -RestoreThreads 10 -Force

此示例使用 10 个线程还原服务器场并阻止 overwrite 警告。

参数

-AssignmentCollection

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

管理对象以便正确进行处理。 使用 SPWeb 或 SPSite 等对象可能会耗用大量内存,而且在 Windows PowerShell 脚本中使用这些对象需要正确管理内存。 通过使用 SPAssignment 对象,可以将对象分配给变量,然后在不需要这些对象时对它们进行处理,以释放内存。 在使用 SPWeb、SPSite 或 SPSiteAdministration 对象时,如果不使用分配集合或 Global 参数,则会自动处理这些对象。

使用全局参数时,所有对象均包含在全局存储中。 如果未立即使用对象,或未通过使用 Stop-SPAssignment 命令来处理对象,则可能会发生内存不足的情况。

参数属性

类型:SPAssignmentCollection
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-BackupId

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定要还原的备份包的 GUID。 每个备份包都有与其关联的唯一 GUID。 可以使用 Get-SPBackupHistory cmdlet 查看备份历史记录来查看 GUID。 如果未指定此参数,则使用通过 Directory 参数指定的路径中的最新备份包。

键入的值必须为有效 GUID,格式为 12345678-90ab-cdef-1234-567890abcdef。

参数属性

类型:Guid
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ConfigurationOnly

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

仅指定将从备份包中还原并应用于目标服务器场上对象的设置(没有数据)。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Confirm

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

执行命令前,看到确认提示。 有关详细信息,请键入以下命令:get-help about_commonparameters

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Directory

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定 SharePoint 产品存储备份包的路径。 如果你有一台安装了 SQL Server 和 SharePoint 产品实例的计算机,则可以使用本地驱动器路径。 这包括基本安装。 但是,如果在多台计算机上安装SQL Server和 SharePoint 产品,则必须使用通用命名约定 (UNC) 共享路径,以便SQL Server和 SharePoint 产品可以从同一位置读取 (,例如 \\computer_name \volume\Backup) 。

键入的值必须为有效路径之一:

  • C:\folder_name
  • \\server_name\folder_name

将自动创建 spbr* 文件夹。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-FarmCredentials

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定将用于还原的所有组件的凭据。 例如,正在还原的 Web 应用程序的应用程序池凭据。 如果场中已存在正在还原的应用程序池,还原该应用程序池时将忽略 FarmCredentials 参数指定的凭据。

参数属性

类型:PSCredential
默认值:None
支持通配符:False
不显示:False

参数集

DefaultSet
Position:Named
必需:False
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Force

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

阻止执行覆盖还原操作时将覆盖组件的提示警告。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

DefaultSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Item

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

表示要还原的部分备份包。 可以使用完整服务器场路径表示法,如 ShowTree 参数所示,或者路径中目标组件的名称(如果有唯一的名称)。 如果该名称具有多个匹配项,则必须提供完整路径。 如果包含空格,则用双引号引住项目或路径。 如果此参数不存在,将还原整个备份包。

键入的值必须为有效的项目,例如:

Farm\Microsoft SharePoint Foundation Web Application\SharePoint - 80

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-NewDatabaseServer

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定有效的 SQL 数据库服务器名称。 如果指定,将用作还原操作中所有数据库的默认数据库服务器名称。

此参数仅在全新还原时有效。 对于覆盖还原无效。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

DefaultSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Percentage

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

要求以该百分比的增量显示有关还原操作的进度更新。 例如,值为 5 将以 5% 的增量显示完成的还原进度更新,而值为 10 将以 10% 的增量显示完成的还原进度更新。

注意:如果指定了 -Verbose 参数,则只在输出中显示进度。 否则,可以在还原日志文件中看到进度。

该百分比并不精确,实际更新进度可能低于或高于要求的百分比。

对于非常大的数据库,建议使用值 1 。

键入的值必须是介于 1 和 100 之间的整数值。

默认值为 5。

参数属性

类型:Int32
默认值:None
支持通配符:False
不显示:False

参数集

DefaultSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-RestoreMethod

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定要执行的还原方法。

有效值为:

  • New ;指定还原内容的新位置,此参数旨在当还原到其他服务器场时使用。 还会显示其他提示,以指定新设置。
  • Overwrite ;将内容和设置还原至其初始位置,此参数旨在当还原到备份所在的同一服务器场时使用。 如果使用 Overwrite 参数,则显示确认提示。 如果要阻止确认提示,请使用 Force 参数。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

DefaultSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-RestoreThreads

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

还原期间应使用的线程数。

还原线程越少,越容易理解还原日志。 但是,还原线程越多,越多的组件可以并行还原,可能导致速度更快的还原。

有效范围介于 1 和 10 之间。 默认值为 3。

参数属性

类型:Int32
默认值:None
支持通配符:False
不显示:False

参数集

DefaultSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ShowTree

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

显示将根据传递给 Restore-SPFarm cmdlet 的其他参数(即 Item 和 ConfigurationOnly 参数)还原服务器场中的哪些对象。 将基于传递给 Restore-SPFarm cmdlet 的其他参数从还原中排除的项目前面将带有星号 (*) 。 无法还原的项目将括在方括号 ([ ]) 中。 如果 ShowTree 参数存在,将不执行还原操作。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

ShowTree
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

显示一条描述命令作用的消息,而不执行命令。 有关详细信息,请键入以下命令:get-help about_commonparameters

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters