Install-SPFeature

リファレンス

モジュール:: SharePointServer

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

Feature.xml ファイルを使用して SharePoint の機能をインストールします。

構文

Install-SPFeature
       [-Path] <String>
       [-AssignmentCollection <SPAssignmentCollection>]
       [-CompatibilityLevel <Int32>]
       [-Confirm]
       [-Force]
       [-WhatIf]
       [<CommonParameters>]

Install-SPFeature
       [-AllExistingFeatures]
       [-AssignmentCollection <SPAssignmentCollection>]
       [-Confirm]
       [-Force]
       [-SolutionId <String>]
       [-WhatIf]
       [<CommonParameters>]

Install-SPFeature
       [-ScanForFeatures]
       [-AssignmentCollection <SPAssignmentCollection>]
       [-Confirm]
       [-Force]
       [-SolutionId <String>]
       [-WhatIf]
       [<CommonParameters>]

説明

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

Install-SPFeature コマンドレットは、機能に対するバージョン固有の共通 FEATURES フォルダーからの相対パスを Identity パラメーターで指定することによって、特定の SPFeature をインストールします。バージョン固有の FEATURES フォルダーは、サイトコレクションが 14 モードの場合は "$env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\FEATURES" で、サイトコレクションが 15 モードの場合は "$env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES" です。 SharePoint 機能のファイルは、手動でまたはソリューションインストーラーを使用して、あらかじめ適切なディレクトリに置いておく必要があります。

AllExistingFeatures パラメーターの値が true の場合は、ファイルシステムがスキャンされ、両方の FEATURES フォルダーにあるすべての新しい機能がインストールされます。このパラメーターは、通常、展開またはアップグレードにのみ使用します。

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

例

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

Install-SPFeature -path "MyCustomFeature"

この例では、$env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES\MyCustomFeature/feature.xml に新しい機能をインストールします。

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

Install-SPFeature -AllExistingFeatures -Whatif

この例では、WhatIf パラメーターを指定せずにこのコマンドを実行した場合、ファイルシステムの未登録の機能がインストールされることを示します。通常、この操作はアップグレードプロセスの後で実行します。

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

Install-SPFeature -path "MyCustomFeature"  -CompatibilityLevel 14

この例では、$env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\FEATURES\MyCustomFeature\feature.xmlに新しい機能をインストールします。

-------------- 例 4 -----------------

Install-SPFeature -path "MyCustomFeature"  -CompatibilityLevel 15

この例では、$env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES\MyCustomFeature\feature.xml にある新しい機能をインストールします。

パラメーター

-AllExistingFeatures

既存の未登録の機能をスキャンし、それをファームに登録します。

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

-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

-CompatibilityLevel

インストールする機能のバージョンを指定します。バージョンを指定しないと、既定で Web アプリケーションの MaxVersion 値になります。

この値は、14 または 15 のいずれかです。

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

-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

-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

-Path

実際のファイルパス (MyFeature など) を指定します。

機能のパスは、14\Template\Features ディレクトリへのリテラルパスである必要があります。ファイル名 feature.xml はあらかじめ決まっているため、指定する必要はありません。

機能のパスが見つからない場合は、"場所 14\Template\Features\<file path> で XML ファイルを見つけることができませんでした" というエラーメッセージが表示されます。

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ScanForFeatures

機能をスキャンし、表示します。 ScanForFeatures パラメーターでは、機能はインストールされません。

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

-SolutionId

機能のソリューション ID を指定します。 SolutionId パラメーターを指定しない場合、すべてのソリューション ID がスキャンされます。

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

-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