Restore-SPFarm
1 つまたは複数のアイテムをバックアップから復元します。
構文
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>]
説明
このコマンドレットには、複数のパラメーター セットが含まれています。 使用できるのは、1 つのパラメーター セットのパラメーターだけであり、異なるパラメーター セットのパラメーターを組み合わせることはできません。 パラメーター セットの使用法に関する詳しい情報については、「コマンドレットのパラメーター セット」を参照してください。
Restore-SPFarmコマンドレットは、個々のデータベース、Web アプリケーション、ファーム全体など、バックアップから 1 つ以上のアイテムを復元します。
このコマンドレットを使用して、ファーム テンプレートをファーム全体に適用することもできます。
Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。
例
例 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 アプリケーション ノードで復元されるが、実際には復元されないかを示しています。
例 3
Restore-SPFarm -Directory C:\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -RestoreMethod overwrite -RestoreThreads 10 -Force
この例では、10 個のスレッドを使用してファームを復元し、上書き警告を表示しないようにします。
パラメーター
-AssignmentCollection
適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。
Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。
Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。
パラメーターのプロパティ
| 型: | SPAssignmentCollection |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-BackupId
適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
復元するバックアップ パッケージの GUID を指定します。
バックアップ パッケージごとに一意な GUID が関連付けられています。
GUID は、 Get-SPBackupHistory コマンドレットを使用してバックアップ履歴を表示することで確認できます。
このパラメーターを指定しない場合は、 Directory パラメーターで指定されたパスにある、最後に行ったバックアップ パッケージが使用されます。
この型は、12345678-90ab-cdef-1234-567890abcdef という形式の有効な GUID であることが必要です。
パラメーターのプロパティ
| 型: | Guid |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ConfigurationOnly
適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
バックアップ パッケージから設定のみ (データなし) を復元し、復元先のファーム上のオブジェクトに適用することを指定します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 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 |
| DontShow: | False |
| Aliases: | Cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Directory
適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
SharePoint 製品でバックアップ パッケージが保存されたパスを指定します。 SQL Server と SharePoint 製品のインスタンスがインストールされているコンピューターがある場合は、ローカル ドライブ パスを使用できます。 This includes a basic installation. ただし、SQL Server および SharePoint 製品が複数のコンピューターにインストールされている場合は、SQL Server と SharePoint 製品が同じ場所 (\\computer_name \volume\Backup など) から読み取れるように、汎用名前付け規則 (UNC) の共有パスを使用する必要があります。
この型は、どちらかの形式の有効なパスであることが必要です。
- C:\folder_name
- \\server_name\folder_name
spbr* フォルダーは自動的に作成されます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-FarmCredentials
適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
復元されるすべてのコンポーネントに使用される資格情報を指定します。 たとえば、復元中の Web アプリケーションのアプリケーション プール資格情報などです。 復元中のアプリケーション プールが既にファームに存在する場合、そのアプリケーション プールを復元するときに FarmCredentials パラメーターで指定された資格情報は無視されます。
パラメーターのプロパティ
| 型: | PSCredential |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
DefaultSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
上書き方式の復元操作を行う場合に、コンポーネントが上書きされる旨の警告が表示されないようにします。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
DefaultSet
| 配置: | 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 |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-NewDatabaseServer
適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
有効な SQL データベース サーバー名を指定します。 指定した名前は、復元操作の対象となるすべてのデータベースの既定のデータベース サーバー名として使用されます。
このパラメーターは、新しい場所への復元操作を行う場合にのみ有効です。 上書き方式の復元操作に対しては無効です。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
DefaultSet
| 配置: | 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 |
| DontShow: | False |
パラメーター セット
DefaultSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RestoreMethod
適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
実行する復元方法を指定します。
有効な値は次のいずれかです。
- 新規;コンテンツを復元する新しい場所を指定します。これは、別のファームに復元するときに使用することを目的としています。 新しい設定を指定するための追加のプロンプトが表示されます。
- 上書き;コンテンツと設定を元の場所に復元します。バックアップ元のファームに復元するときに使用します。 Overwrite パラメーターを使用すると、確認プロンプトが表示されます。 確認プロンプトを抑制する場合は、[強制] パラメーターを使用します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
DefaultSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RestoreThreads
適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
復元中に使用するスレッドの数。
復元スレッドの数が少ないほど、復元ログが理解しやすくなります。 ただし、復元スレッドの数が多くなるほど、より多くのコンポーネントを同時に復元できるため、復元処理に要する時間が短縮されます。
有効な範囲は、1 ～ 10 です。 既定値は 3 です。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
DefaultSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ShowTree
適用対象: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
Restore-SPFarm コマンドレットに渡された他のパラメーター (Item パラメーターと ConfigurationOnly パラメーター) に基づいて復元されるファーム内のオブジェクトを表示します。
Restore-SPFarm コマンドレットに渡された他のパラメーターに基づいて復元から除外されるアイテムの先頭にはアスタリスク (*) が付きます。
復元できないアイテムは、角かっこ ([]) で囲まれます。
ShowTree パラメーターを指定すると、復元操作は実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ShowTree
| 配置: | 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 |
| DontShow: | False |
| Aliases: | wi |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、「about_CommonParameters」を参照してください。