PSSession の詳細オプションが格納されているオブジェクトを作成します。
構文
New-PSSessionOption [-ApplicationArguments <PSPrimitiveDictionary>] [-CancelTimeOut <int>] [-Culture <CultureInfo>] [-IdleTimeOut <int>] [-MaximumReceivedDataSizePerCommand <int>] [-MaximumReceivedObjectSize <int>] [-MaximumRedirection <int>] [-NoCompression] [-NoEncryption] [-NoMachineProfile] [-OpenTimeOut <int>] [-OperationTimeOut <int>] [-ProxyAccessType {<None> | <IEConfig> | <WinHttpConfig> | <AutoDetect> | <NoProxyServer>}] [-ProxyAuthentication {<Default> | <Basic> | <Negotiate> | <NegotiateWithImplicitCredential> | <Credssp> | <Digest> | <Kerberos>}] [-ProxyCredential <PSCredential>] [-SkipCACheck] [-SkipCNCheck] [-SkipRevocationCheck] [-UICulture <CultureInfo>] [-UseUTF16] [<CommonParameters>]
説明
New-PSSessionOption コマンドレットは PSSession の詳細オプションが格納されているオブジェクトを作成します。このオブジェクトは、New-PSSession、Enter-PSSession、Invoke-Command など、PSSession を作成するコマンドレットの SessionOption パラメーターの値として使用できます。
パラメーターがない場合、New-PSSessionOption はすべてのオプションの既定値を含むオブジェクトを生成します。すべてのプロパティを編集できるため、結果のオブジェクトをテンプレートとして使用し、エンタープライズ用の標準的なオプション オブジェクトを作成できます。
パラメーター
-ApplicationArguments <PSPrimitiveDictionary>
解釈されずに直接、セッション構成に送られるハッシュ テーブルを指定します。このハッシュ テーブルは、PSSenderInfo クラスのプロパティとしてセッション構成で使用できます。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-CancelTimeOut <int>
終了するまでに、操作の取り消し (Ctrl + C キー) の完了を Windows PowerShell が待機する時間を指定します。値をミリ秒単位で入力します。
既定値は 60000 (1 分) です。値 0 (ゼロ) はタイムアウトなしを意味し、コマンドは無期限に継続します。
必須 |
false |
位置 |
named |
既定値 |
60000 |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Culture <CultureInfo>
PSSession に使用するカルチャを指定します。"ja-jP" のような <languagecode2>-<country/regioncode2> の形式のカルチャ名、CultureInfo オブジェクトが含まれている変数、または CultureInfo オブジェクトを取得するコマンド (get-culture など) を入力します。
既定値は $null です。PSSession の作成の際にオペレーティング システムで設定されているカルチャが PSSession で使用されます。
必須 |
false |
位置 |
named |
既定値 |
Current culture |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-IdleTimeOut <int>
リモート コンピューターがローカル コンピューターからハートビート信号などの通信を受信しない場合に、PSSession が開いたままでいる時間を指定します。この時間が経過すると、PSSession は閉じます。
値をミリ秒単位で入力します。既定値は 240000 (4 分) です。最小値は 60000 (1 分) です。
ローカル コンピューターおよびリモート コンピューターの両方でアイドル状態のタイムアウト値が指定されている場合、PSSession は小さい方のタイムアウト値を使用します。ローカル コンピューターは、このパラメーターを使用しても、$PSSessionOption preference 設定変数でアイドル状態のタイムアウトを設定しても、アイドル状態のタイムアウト値を設定できます。リモート コンピューターは、WS-Management 設定 (WSMAN:\localhost\shell\idletimeout) でアイドル状態のタイムアウト値を指定できます。
必須 |
false |
位置 |
named |
既定値 |
240000 |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-MaximumReceivedDataSizePerCommand <int>
ローカル コンピューターが 1 つのコマンドでリモート コンピューターから受け取る最大バイト単位を指定します。値をバイト単位で入力します。既定では、データ サイズの制限はありません。
このオプションは、クライアント コンピューターのリソースを保護することを目的としています。
必須 |
false |
位置 |
named |
既定値 |
No limit |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-MaximumReceivedObjectSize <int>
ローカル コンピューターが 1 つのコマンドでリモート コンピューターから受け取るオブジェクトの最大サイズを指定します。値をバイト単位で入力します。既定では、データ サイズの制限はありません。
このオプションは、クライアント コンピューターのリソースを保護することを目的としています。
必須 |
false |
位置 |
named |
既定値 |
No limit |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-MaximumRedirection <int>
接続が失敗するまでに、Windows PowerShell が接続を代替 URI (Uniform Resource Identifier) にリダイレクトする回数を指定します。既定値は 5 です。値が 0 (ゼロ) である場合、すべてのリダイレクトが禁止されます。
このオプションは、PSSession を作成するコマンドで AllowRedirection パラメーターが使用される場合にのみ、PSSession で使用されます。
必須 |
false |
位置 |
named |
既定値 |
5 |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-NoCompression
PSSession のパケット圧縮を無効にします。圧縮した場合はより多くのプロセッサ サイクルが使用されますが、送信が速くなります。
必須 |
false |
位置 |
named |
既定値 |
False |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-NoEncryption
データ暗号化を無効にします。
必須 |
false |
位置 |
named |
既定値 |
False |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-NoMachineProfile
ユーザーの Windows ユーザー プロファイルの読み込みを禁止します。その結果、PSSession はより速く作成される可能性がありますが、ユーザー固有のレジストリ設定、環境変数などの項目、および証明書は PSSession で使用できません。
必須 |
false |
位置 |
named |
既定値 |
False |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-OpenTimeOut <int>
セッション接続が確立されるまでにクライアント コンピューターが待機する時間を指定します。この時間が経過すると、接続を確立するコマンドは失敗します。値をミリ秒単位で入力します。
既定値は 180000 (3 分) です。値 0 (ゼロ) はタイムアウトなしを意味し、コマンドは無期限に継続します。
必須 |
false |
位置 |
named |
既定値 |
180000 |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-OperationTimeOut <int>
PSSession の操作を実行できる最大時間を指定します。この時間が経過すると、操作は失敗します。値をミリ秒単位で入力します。
既定値は 180000 (3 分) です。値 0 (ゼロ) はタイムアウトなしを意味し、操作は無期限に継続します。
必須 |
false |
位置 |
named |
既定値 |
180000 |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-ProxyAccessType <ProxyAccessType>
ホスト名の解決に使用するメカニズムを指定します。有効な値は、IEConfig、WinHttpConfig、AutoDetect、NoProxyServer、および None です。既定値は None です。
このパラメーターの値の詳細については、MSDN (Microsoft Developer Network) ライブラリの System.Management.Automation.Remoting.ProxyAccessType 列挙体の説明 () を参照してください。
必須 |
false |
位置 |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-ProxyAuthentication <AuthenticationMechanism>
プロキシ解決に使用する認証方法を指定します。有効な値は、Basic、Digest、および Negotiate です。既定値は Negotiate です。
このパラメーターの値については、MSDN ライブラリの System.Management.Automation.Runspaces.AuthenticationMechanism 列挙体の説明 (https://go.microsoft.com/fwlink/?LinkID=144382) を参照してください。
必須 |
false |
位置 |
named |
既定値 |
Negotiate |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-ProxyCredential <PSCredential>
プロキシ認証に使用する資格情報を指定します。PSCredential オブジェクトを含んでいる変数を入力するか、Get-Credential など、PSCredential オブジェクトを取得するコマンドを入力します。このオプションが設定されていない場合、資格情報が指定されません。
必須 |
false |
位置 |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-SkipCACheck
HTTPS を使用して接続する場合にクライアントでは信頼された認証機関 (CA) によってサーバー証明書が署名されているかどうかは検証されないことを指定します。
このオプションは、リモート コンピューターが他のメカニズムによって信頼されている場合にのみ使用します。たとえば、物理的にセキュリティ保護されて孤立したネットワークの一部である場合や、WinRM 構成で信頼されたホストとして示されている場合などです。
必須 |
false |
位置 |
named |
既定値 |
False |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-SkipCNCheck
サーバーの証明書の共通名 (CN) が、サーバーのホスト名と一致している必要がないことを指定します。このオプションは、HTTPS プロトコルを使用したリモート操作でのみ使用します。
このオプションは、信頼されたコンピューターについてのみ使用します。
必須 |
false |
位置 |
named |
既定値 |
False |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-SkipRevocationCheck
サーバー証明書の失効状態を検証しません。
必須 |
false |
位置 |
named |
既定値 |
False |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-UICulture <CultureInfo>
PSSession に使用する UI カルチャを指定します。
"ja-jP" のような <languagecode2>-<country/regioncode2> の形式のカルチャ名、CultureInfo オブジェクトが含まれている変数、または CultureInfo オブジェクトを取得するコマンド (Get-Culture など) を入力します。
既定値は $null です。PSSession の作成の際にオペレーティング システムで設定されている UI カルチャが PSSession で使用されます。
必須 |
false |
位置 |
named |
既定値 |
Current UI culture |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-UseUTF16
要求を、UTF8 形式ではなく UTF16 形式でエンコードします。
必須 |
false |
位置 |
named |
既定値 |
False (UTF8 encoding) |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。Ô”¼š¤Ë¤Ä¤¤¤Æ¤Ï¡¢次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
入力 |
None パイプを使用してこのコマンドレットに入力を渡すことはできません。 |
出力 |
System.Management.Automation.Remoting.PSSessionOption |
注
PSSession を作成するコマンドで SessionOption parameter パラメーターを使用しない場合、セッションのオプションは $PSSessionOption 設定変数のプロパティ値 (設定されている場合) により指定されます。$PSSessionOption 変数の詳細については、「about_Preference_Variables」を参照してください。
例 1
C:\PS>New-PSSessionOption MaximumConnectionRedirectionCount : 5 NoCompression : False NoMachineProfile : False ProxyAccessType : IEConfig ProxyAuthentication : Negotiate ProxyCredential : SkipCACheck : False SkipCNCheck : False SkipRevocationCheck : False OperationTimeout : 00:03:00 NoEncryption : False UseUTF16 : False Culture : UICulture : MaximumReceivedDataSizePerCommand : MaximumReceivedObjectSize : ApplicationArguments : OpenTimeout : 00:03:00 CancelTimeout : 00:01:00 IdleTimeout : 00:04:00 説明 ----------- このコマンドは、セッション オプション オブジェクトをすべて既定値で作成します。
例 2
C:\PS>$pso = new-pssessionoption -Culture "fr-fr" -MaximumReceivedObjectSize 10MB C:\PS> new-pssession -computerName Server01 -SessionOption $pso 説明 ----------- この例は、セッション オプション オブジェクトを使用してセッションを構成する方法を示しています。 最初のコマンドは、新しいセッション オプション オブジェクトを作成し、$pso 変数の値で保存します。 2 番目のコマンドは、New-PSSession コマンドレットを使用して Server01 リモート コンピューターで PSSession を作成します。このコマンドは、$pso 変数の値のセッション オプション オブジェクトを、コマンドの SessionOption パラメーターの値として使用します。
例 3
C:\PS>enter-pssession -computername Server01 -sessionOption (new-pssessionoption -noEncryption -noCompression) 説明 ----------- このコマンドは、Enter-PSSession コマンドレットを使用して、Server01 コンピューターとの対話型のセッションを開始します。SessionOption パラメーターの値は、NoEncryption および NoCompression スイッチ パラメーターを指定した New-PSSessionOption コマンドです。 New-PSSessionOption コマンドは、Enter-PSSession コマンドの前に確実に実行されるように、丸かっこで囲みます。
例 4
C:\PS>$a = new-pssessionoption MaximumConnectionRedirectionCount : 5 NoCompression : False NoMachineProfile : False ProxyAccessType : IEConfig ProxyAuthentication : Negotiate ProxyCredential : SkipCACheck : False SkipCNCheck : False SkipRevocationCheck : False OperationTimeout : 00:03:00 NoEncryption : False UseUTF16 : False Culture : UICulture : MaximumReceivedDataSizePerCommand : MaximumReceivedObjectSize : ApplicationArguments : OpenTimeout : 00:03:00 CancelTimeout : 00:01:00 IdleTimeout : 00:04:00 C:\PS> $a.UICulture = (get-UICulture) C:\PS> $a.OpenTimeout = (new-timespan -minutes 4) C:\PS> $a.MaximumConnectionRedirectionCount = 1 C:\PS> $a MaximumConnectionRedirectionCount : 1 NoCompression : False NoMachineProfile : False ProxyAccessType : IEConfig ProxyAuthentication : Negotiate ProxyCredential : SkipCACheck : False SkipCNCheck : False SkipRevocationCheck : False OperationTimeout : 00:03:00 NoEncryption : False UseUTF16 : False Culture : UICulture : en-US MaximumReceivedDataSizePerCommand : MaximumReceivedObjectSize : ApplicationArguments : OpenTimeout : 00:04:00 CancelTimeout : 00:01:00 IdleTimeout : 00:04:00 説明 ----------- この例は、セッション オプション オブジェクトを編集できることを示しています。すべてのプロパティは、読み取り/書き込みの値を持っています。 このメソッドを使用してエンタープライズ用の標準的なセッション オブジェクトを作成してから、特定の使用のためのカスタム バージョンを作成します。
例 5
C:\PS>$PSSessionOption = New-PSSessionOption -OpenTimeOut 120000 説明 ----------- このコマンドは、$PSSessionOption 設定変数を作成します。 $PSSessionOption 設定変数がセッションに存在する場合、New-PSSession、Enter-PSSession、および Invoke-Command コマンドレットを使用して作成される PSSessions のオプションの既定値を設定します。 $PSSessionOption 変数がすべてのセッションで使用できるようにするには、Windows PowerShell セッションおよび Windows PowerShell プロファイルにコマンドを追加します。 $PSSessionOption 変数の詳細については、「about_Preference_Variables」を参照してください。プロファイルの詳細については、「about_Profiles」を参照してください。
例 6
C:\PS>$skipCN = new-pssessionoption -SkipCNCheck C:\PS> new-pssession -computername 171.09.21.207 -UseSSL -credential domain01\user01 -sessionOption $skipCN 説明 ----------- この例は、SessionOption オブジェクトを使用してリモート セッション構成の要件を満たす方法を示しています。 最初のコマンドは、New-PSSessionOption コマンドレットを使用し、SkipCNCheck プロパティを持つ、セッション オプション オブジェクトを作成します。このコマンドは、結果のセッション オブジェクトを $skipCN 変数に保存します。 2 番目のコマンドは、New-PSSession コマンドレットを使用してリモート コンピューターで新しい PSSession を作成します。$skipCN 変数は SessionOption パラメーターの値に使用されます。 コンピューターは IP アドレスで識別されるため、ComputerName パラメーターの値は SSL (Secure Sockets Layer) に使用される証明書の共通名と一致しません。その結果、SkipCNCheck オプションが必要となります。
関連項目