Install-SPFeature
Feature.xml ファイルを使用して SharePoint の機能をインストールします。
構文
PathSet
Install-SPFeature
[-Path] <String>
[-AssignmentCollection <SPAssignmentCollection>]
[-CompatibilityLevel <Int32>]
[-Confirm]
[-Force]
[-WhatIf]
[<CommonParameters>]
AllExistingFeatures
Install-SPFeature
[-AllExistingFeatures]
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-Force]
[-SolutionId <String>]
[-WhatIf]
[<CommonParameters>]
ScanForFeatures
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
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
既存の未登録の機能をスキャンし、それをファームに登録します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AllExistingFeatures
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-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 |
-CompatibilityLevel
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
インストールする機能のバージョンを指定します。 バージョンを指定しないと、既定で Web アプリケーションの MaxVersion 値になります。
この値は、14 または 15 のいずれかです。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
PathSet
| 配置: | 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 |
-Force
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
インストール済みの機能を上書きしてインストールします。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Path
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
実際のファイル パス (MyFeature など) を指定します。
機能のパスは、14\Template\Features ディレクトリへのリテラル パスである必要があります。 ファイル名 feature.xml はあらかじめ決まっているため、指定する必要はありません。
機能のパスが見つからない場合は、"場所 14\Template\Features\<file path> で XML ファイルを見つけることができませんでした" というエラー メッセージが表示されます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
PathSet
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ScanForFeatures
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
機能をスキャンし、表示します。 ScanForFeatures パラメーターでは、機能はインストールされません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ScanForFeatures
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SolutionId
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
機能のソリューション ID を指定します。 SolutionId パラメーターを指定しない場合、すべてのソリューション ID がスキャンされます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AllExistingFeatures
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ScanForFeatures
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | 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: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。