Backup-SPFarm

リファレンス

モジュール:: SharePointServer

適用対象:: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

個別のデータベース、Web アプリケーション、またはファーム全体のバックアップを作成します。

構文

Backup-SPFarm
      -BackupMethod <String>
      -Directory <String>
      [-AssignmentCollection <SPAssignmentCollection>]
      [-BackupThreads <Int32>]
      [-ConfigurationOnly]
      [-Force]
      [-Item <String>]
      [-Percentage <Int32>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Backup-SPFarm
      [-ShowTree]
      [-AssignmentCollection <SPAssignmentCollection>]
      [-ConfigurationOnly]
      [-Item <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

このコマンドレットには、複数のパラメーターセットが含まれています。使用できるのは、1 つのパラメーターセットのパラメーターだけであり、異なるパラメーターセットのパラメーターを組み合わせることはできません。パラメーターセットの使用法に関する詳しい情報については、「コマンドレットのパラメーターセット」を参照してください。

Backup-SPFarm コマンドレットでは、ファーム全体またはファーム内のコンポーネント別のバックアップを作成します。ファームの構成設定だけをバックアップし、他の SharePoint ファームのファームテンプレートとして使用することもできます。単一のサイトコレクションをバックアップする場合は、Backup-SPSite コマンドレットを使用します。

バックアップする使用可能なオブジェクトを表示するには、パラメーターセットを -ShowTree 使用します。

Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンラインドキュメントをご覧ください。

例

--------------------例 1---------------------

Backup-SPFarm -Directory \\file_server\share\Backup -BackupMethod full -ConfigurationOnly

この例では、ファームの構成設定を \\<ファイルサーバー>\share\Backup ディレクトリにバックアップします。

-------------------- 例 2 ---------------------

Backup-SPFarm -ShowTree -Item "Microsoft SharePoint Foundation Web Application" -Verbose

この例では、"Microsoft SharePoint Foundation Web Application" ノードにあるファームのバックアップ対象のコンポーネントを表示しますが、実際にはバックアップしません。

-------------------- 例 3 ---------------------

Backup-SPFarm -Directory C:\Backup -BackupMethod full -BackupThreads 10 -Force

この例では、10 個のスレッドを使用してファームをバックアップし、SharePoint に十分な領域がないと推測される場合でも、バックアップを C:\Backup ディレクトリに強制的に保存します。

--------------------EXAMPLE 4---------------------

Backup-SPFarm -ShowTree

この例では、でバックアップ Backup-SPFarmできるオブジェクトを示します。

パラメーター

-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

-BackupMethod

作成するバックアップファイルの種類を指定します。

-ShowTree パラメーターを使用してバックアップを実行する場合、BackupMethod パラメーターは使用されません。

完全バックアップとは、選択したデータすべてのバックアップです。差分バックアップとは、選択したデータのうち、最後に完全バックアップしてから変更されたすべてのデータのバックアップです。アイテムで差分バックアップがサポートされない場合は、完全バックアップが実行されます。

この型は、次のどちらかであることが必要です。

Full
差分

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

-BackupThreads

バックアップ中に使用するスレッドの数を指定します。スレッド数が少ないほど、バックアップログファイルを読んだり理解したりするのが容易になります。スレッド数が多いほど、より多くのコンポーネントを同時にバックアップできるため、バックアップ処理に要する時間が短縮されます。最小値は 1 、最大値は 10 です。

既定値は 3 です。

-ShowTree パラメーターを使用してバックアップを実行する場合、BackupMethod パラメーターは使用されません。

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

-ConfigurationOnly

設定した場合、バックアップにはバックアップ対象の各オブジェクトの構成設定だけが格納されます (データは格納されません)。

SharePoint は、構成のみのバックアップに必要な領域の量を過大評価する可能性があります。これにより、SharePoint は、指定されたパスにバックアップを格納するのに十分な領域がないことを推定する可能性があります。構成のみのバックアップを -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

-Confirm

コマンドレットを実行する前に確認メッセージを表示します。

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 製品が複数のコンピューターにインストールされている場合、または SharePoint 製品を実行しているサーバーが複数ある場合は、SQL Server データベースと検索コンポーネントが同じ場所 (\\computer_name\volume\Backup など) に書き込まれるように、汎用名前付け規則 (UNC) 共有パスを使用する必要があります。

複数のバックアップパッケージを同じ場所に格納することができます。これは、 Restore-SPFarm コマンドレットの Directory パラメーターに渡す場合と同じパスです。

この型は、どちらかの形式の有効なパスであることが必要です。

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

-Force

バックアップディレクトリにバックアップ全体を格納できる領域がないと推測される場合でも、バックアップ操作を続行するように指定します。

ShowTree パラメーターを使用してバックアップを実行する場合、 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

-Percentage

バックアップ操作に関する進行状況の更新を、その割合の増分で表示するように要求します。たとえば、値 5 は、完了した 5% ごとにバックアップの進行状況の更新を表示し、値 10 は完了した 10% ごとにバックアップの進行状況の更新を表示します。進行状況の出力を表示するには、Verbose パラメーターを指定する必要があります。

このパーセンテージは正確ではなく、実際には要求した値とは異なるパーセンテージで進行状況が更新される場合もあります。進行状況の更新は、バックアップログファイルに常に記録されます。

このパーセンテージは正確ではなく、実際には要求した値とは異なるパーセンテージで進行状況が更新される場合もあります。

既定値は 5 です。非常に大規模なデータベースの場合の推奨値は 1 です。

有効な値は、 1 ～ 100 の整数値です。

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

Backup-SPFarm コマンドレットに渡す他のパラメーター ( Item パラメーター) に基づいてバックアップされるファームのオブジェクトを表示します。 Backup-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

次の方法で共有