Install-SPFeature

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" 、"$env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES" (サイト コレクションが 15 モードの場合) です。 SharePoint 機能のファイルは、手動でまたはソリューション インストーラーを使用して、あらかじめ適切なディレクトリに置いておく必要があります。

If the value of the AllExistingFeatures parameter is true, the file system is scanned and all new features that are in both FEATURES folders are installed. This is generally only used during deployment and upgrade.

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

This example shows the unregistered features that are available on the file system and that are installed if this command is run without the WhatIf parameter. This is commonly done after an upgrade process.

-------------- 例 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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:SPAssignmentCollection
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-CompatibilityLevel

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

この値は、14 または 15 にすることができます。

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Confirm

コマンドを実行する前に確認メッセージを表示します。 詳細については、次のコマンドを入力します。get-help about_commonparameters

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Force

インストール済みの機能を上書きしてインストールします。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Path

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

The path to feature must be a literal path to the 14\Template\Features directory. The feature.xml file name is implied and does not need to be provided.

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

Type:String
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-ScanForFeatures

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-SolutionId

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-WhatIf

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition