Set-SPPassPhrase
パス フレーズに新しい値を設定します。
構文
Set-SPPassPhrase
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-LocalServerOnly]
[-WhatIf]
-PassPhrase <SecureString>
[<CommonParameters>] Set-SPPassPhrase
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-WhatIf]
-ConfirmPassPhrase <SecureString>
-PassPhrase <SecureString>
[<CommonParameters>] 説明
このコマンドレットには、複数のパラメーター セットが含まれています。 使用できるのは、1 つのパラメーター セットのパラメーターだけであり、異なるパラメーター セットのパラメーターを組み合わせることはできません。 パラメーター セットの使用法に関する詳しい情報については、「コマンドレットのパラメーター セット」を参照してください。
コマンドレットは Set-SPPassPhrase 、パスフレーズを新しいパスフレーズ値に設定します。
LocalServerOnly パラメーターを指定しない場合は、ファームの暗号化キーの更新が、ファーム内のすべてのサーバーに伝達されます。
LocalServerOnly パラメーターが使用されている場合、これはローカル コンピューターでのみ更新され、ファーム暗号化キーは変更されません。
サーバー ファームのすべてのコンピューターでパスフレーズ値が一致していないと、ファームは正しく機能しません。
パスフレーズが一部のサーバーに伝達されなかった場合は、LocalServerOnly パラメーターを使用して、そのサーバーに新しいパスフレーズ値を手動で設定できます。
Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。
例
------------------ 例 -----------------------
$passphrase = ConvertTo-SecureString -asPlainText -Force
Set-SPPassPhrase -PassPhrase $passphrase -Confirm次の使用例は、パスフレーズとして使用する文字列を照会し、ファームパスフレーズを新しい値に設定します。
パラメーター
-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 |
-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 |
-ConfirmPassPhrase
パスフレーズを 2 回入力し、最初の入力と一致していることを確認します。
| Type: | SecureString |
| 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 |
-LocalServerOnly
パスフレーズの変更をローカル サーバーに限定します。 このパラメーターを使用しない場合、パスフレーズの変更はファーム全体で実行されます。
| 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 |
-PassPhrase
新しいパスフレーズ値を指定します。
| Type: | SecureString |
| 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 |