Restore-SPFarm
1 つまたは複数のアイテムをバックアップから復元します。
構文
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>]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 アプリケーション ノードの下で復元されるファームのコンポーネントを示しますが、実際には復元されません。
-------------------EXAMPLE 3-----------------------
Restore-SPFarm -Directory C:\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -RestoreMethod overwrite -RestoreThreads 10 -Force次の使用例は、10 個のスレッドを使用してファームを復元し、上書き警告を抑制します。
パラメーター
-AssignmentCollection
適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。
Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。
Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。
| Type: | SPAssignmentCollection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-BackupId
復元するバックアップ パッケージの GUID を指定します。
バックアップ パッケージごとに一意な GUID が関連付けられています。
GUID は、コマンドレットを使用して Get-SPBackupHistory バックアップ履歴を表示することで確認できます。
このパラメーターを指定しない場合は、 Directory パラメーターで指定されたパスにある、最後に行ったバックアップ パッケージが使用されます。
この型は、12345678-90ab-cdef-1234-567890abcdef という形式の有効な GUID であることが必要です。
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-ConfigurationOnly
バックアップ パッケージから設定のみ (データなし) を復元し、復元先のファーム上のオブジェクトに適用することを指定します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Confirm
コマンドを実行する前に確認メッセージを表示します。
詳細については、次のコマンドを入力します。get-help about_commonparameters
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Directory
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* フォルダーは自動的に作成されます。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-FarmCredentials
復元するすべてのコンポーネントに使用する資格情報を指定します。 たとえば、復元される Web アプリケーションのアプリケーション プールの資格情報です。 復元するアプリケーション プールが既にファームに存在する場合、そのアプリケーション プールを復元するときに FarmCredentials パラメーターで指定された資格情報は無視されます。
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Force
上書き方式の復元操作を行う場合に、コンポーネントが上書きされる旨の警告が表示されないようにします。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Item
バックアップ パッケージの復元する部分を指定します。 ShowTree パラメーターで表示される完全なファーム パスを使用するか、パスに含まれる対象のコンポーネント名 (名前が一意である場合) を使用することができます。 同じ名前で複数のアイテムがある場合は、完全パスを指定する必要があります。 アイテムやパスにスペースが含まれている場合は、二重引用符で囲みます。 パラメーターを指定しない場合は、バックアップ パッケージ全体が復元されます。
この型は、有効なアイテムであることが必要です。次に例を示します。
Farm\Microsoft SharePoint Foundation Web Application\SharePoint - 80
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-NewDatabaseServer
有効な SQL データベース サーバー名を指定します。 指定した名前は、復元操作の対象となるすべてのデータベースの既定のデータベース サーバー名として使用されます。
このパラメーターは、新しい場所への復元操作を行う場合にのみ有効です。 上書き方式の復元操作に対しては無効です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Percentage
復元操作の進行状況をパーセンテージで表示する場合の増分単位を指定します。 たとえば、値 5 は、復元操作の進行状況を 5% 単位で表示し、値 10 は、復元操作の進行状況を 10% 単位で表示します。
注: 進行状況は、-Verbose パラメーターが指定されている場合にのみ出力に表示されます。 それ以外の場合は、復元ログ ファイルで進行状況を確認できます。
このパーセンテージは正確ではなく、実際には要求とは異なるパーセンテージで進行状況が更新される場合もあります。
非常に大きなデータベースの場合、推奨される値は 1 です。
この型は、 1 ～ 100 の範囲の整数値であることが必要です。
既定値は 5 です。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-RestoreMethod
実行する復元方法を指定します。
有効な値は次のいずれかです。
- 新機能;コンテンツを復元する新しい場所を指定し、別のファームに復元するときに使用することを目的としています。 新しい設定を指定するための追加のプロンプトが表示されます。
- 上書き;コンテンツと設定を元の場所に復元し、バックアップ元と同じファームに復元するときに使用することを目的としています。 Overwrite パラメーターを使用すると、確認プロンプトが表示されます。 確認プロンプトを抑制する場合は、Force パラメーターを使用します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-RestoreThreads
復元中に使用するスレッドの数。
復元スレッドの数が少ないほど、復元ログが理解しやすくなります。 ただし、復元スレッドの数が多くなるほど、より多くのコンポーネントを同時に復元できるため、復元処理に要する時間が短縮されます。
有効な範囲は、1 ～ 10 です。 既定値は 3 です。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-ShowTree
コマンドレットに渡 Restore-SPFarm される他のパラメーター (Item パラメーターと ConfigurationOnly パラメーター) に基づいて、ファーム内のどのオブジェクトを復元するかを表示します。
コマンドレットに渡される他のパラメーターに基づいて復元から除外される項目の前に Restore-SPFarm アスタリスク (*) が付きます。
復元できないアイテムは、角かっこ ([]) で囲まれます。
ShowTree パラメーターを指定すると、復元操作は実行されません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-WhatIf
コマンドを実行する代わりに、コマンドの実行結果を説明するメッセージを表示します。
詳細については、次のコマンドを入力します。get-help about_commonparameters
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |