New-PSSessionOption

構文

New-PSSessionOption
   [-MaximumRedirection <Int32>]
   [-NoCompression]
   [-NoMachineProfile]
   [-Culture <CultureInfo>]
   [-UICulture <CultureInfo>]
   [-MaximumReceivedDataSizePerCommand <Int32>]
   [-MaximumReceivedObjectSize <Int32>]
   [-OutputBufferingMode <OutputBufferingMode>]
   [-MaxConnectionRetryCount <Int32>]
   [-ApplicationArguments <PSPrimitiveDictionary>]
   [-OpenTimeout <Int32>]
   [-CancelTimeout <Int32>]
   [-IdleTimeout <Int32>]
   [-ProxyAccessType <ProxyAccessType>]
   [-ProxyAuthentication <AuthenticationMechanism>]
   [-ProxyCredential <PSCredential>]
   [-SkipCACheck]
   [-SkipCNCheck]
   [-SkipRevocationCheck]
   [-OperationTimeout <Int32>]
   [-NoEncryption]
   [-UseUTF16]
   [-IncludePortInSPN]
   [<CommonParameters>]

説明

New-PSSessionOption コマンドレットは、ユーザー管理セッション (PSSession) の詳細オプションを含むオブジェクトを作成します。 このオブジェクトは、PSSession (New-PSSession、Enter-PSSession、Invoke-Commandなど) を作成するコマンドレットの SessionOption パラメーターの値として使用できます。

パラメーターがない場合、 New-PSSessionOption は、すべてのオプションの既定値を含むオブジェクトを生成します。 すべてのプロパティを編集できるため、結果のオブジェクトをテンプレートとして使用し、エンタープライズの標準オプション オブジェクトを作成できます。

SessionOption オブジェクトを$PSSessionOption基本設定変数に保存することもできます。 この変数の値は、セッション オプションの新しい既定値を確立します。 セッションに対してセッション オプションが設定されておらず、セッション構成で設定されたオプションよりも優先される場合に有効ですが、セッションを作成するコマンドレットでセッション オプションまたは SessionOption オブジェクトを指定することでオーバーライドできます。 $PSSessionOption基本設定変数の詳細については、about_Preference_Variablesを参照してください。

セッションを作成するコマンドレットで SessionOption オブジェクトを使用する場合、セッション オプションの値は、 $PSSessionOption 基本設定変数およびセッション構成で設定されたセッションの既定値よりも優先されます。 ただし、セッション構成で設定された最大値、クォータ、または制限よりも優先されることはありません。 セッション構成の詳細については、「 about_Session_Configurations」を参照してください。

例

例 1: 既定のセッション オプションを作成する

このコマンドは、既定値を使用して SessionOption オブジェクトを作成します。

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: セッション オプション オブジェクトを使用してセッションを構成する

この例では、 SessionOption オブジェクトを使用してセッションを構成する方法を示します。

$pso = New-PSSessionOption -Culture "fr-fr" -MaximumReceivedObjectSize 10MB
New-PSSession -ComputerName Server01 -SessionOption $pso

最初のコマンドは、新しい SessionOption オブジェクトを作成し、 $pso 変数の値に保存します。 2 番目のコマンドでは、 New-PSSession コマンドレットを使用して、Server01 リモート コンピューターにセッションを作成します。 このコマンドでは、$pso変数の値にSessionOption オブジェクトをコマンドの SessionOption パラメーターの値として使用します。

例 3: 対話型セッションを開始する

このコマンドでは、 Enter-PSSession コマンドレットを使用して、Server01 コンピューターとの対話型セッションを開始します。

Enter-PSSession -ComputerName Server01 -SessionOption (New-PSSessionOption -NoEncryption -NoCompression)

SessionOption パラメーターの値は、NoEncryption および NoCompression パラメーターを持つNew-PSSessionOption コマンドです。

New-PSSessionOption コマンドは、Enter-PSSession コマンドの前に実行されるようにかっこで囲まれています。

例 4: セッション・オプション・オブジェクトを変更する

この例では、 SessionOption オブジェクトを変更できることを示します。 すべてのプロパティは、読み取り/書き込み値を持ちます。

$a = New-PSSessionOption
$a.OpenTimeout

Days              : 0
Hours             : 0
Minutes           : 3
Seconds           : 0
Milliseconds      : 0
Ticks             : 1800000000
TotalDays         : 0.00208333333333333
TotalHours        : 0.05
TotalMinutes      : 3
TotalSeconds      : 180
TotalMilliseconds : 180000

$a.UICulture = (Get-UICulture)
$a.OpenTimeout = (New-Timespan -Minutes 4)
$a.MaximumConnectionRedirectionCount = 1
$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: 基本設定変数を作成する

このコマンドは、 $PSSessionOption ユーザー設定変数を作成します。

$PSSessionOption = New-PSSessionOption -OpenTimeOut 120000

セッションで $PSSessionOption 基本設定変数を設定すると、 New-PSSession、 Enter-PSSession、および Invoke-Command コマンドレットを使用して作成されるセッションのオプションの既定値が設定されます。

$PSSessionOption変数をすべてのセッションで使用できるようにするには、それを PowerShell セッションと PowerShell プロファイルに追加します。

$PSSessionOption基本設定変数の詳細については、about_Preference_Variablesを参照してください。 プロファイルの詳細については、「about_Profiles」を参照してください。

例 6: リモート セッション構成の要件を満たす

この例では、 SessionOption オブジェクトを使用して、リモート セッション構成の要件を満たす方法を示します。

$skipCN = New-PSSessionOption -SkipCNCheck
New-PSSession -ComputerName 171.09.21.207 -UseSSL -Credential Domain01\User01 -SessionOption $SkipCN

最初のコマンドでは、New-PSSessionOption コマンドレットを使用して、SkipCNCheck プロパティを持つ SessionOption オブジェクトを作成します。 このコマンドは、結果のセッション オブジェクトを $skipCN 変数に保存します。

2 番目のコマンドでは、 New-PSSession コマンドレットを使用して、リモート コンピューター上に新しいセッションを作成します。 $skipCN check 変数は、SessionOption パラメーターの値で使用されます。

コンピューターは IP アドレスによって識別されるため、 ComputerName パラメーターの値は、Secure Sockets Layer (SSL) に使用される証明書の共通名と一致しません。 その結果、 SkipCNCheck オプションが必要になります。

例 7: リモート セッションで引数を使用できるようにする

この例では、New-PSSessionOption コマンドレットの ApplicationArguments パラメーターを使用して、リモート セッションで追加のデータを使用できるようにする方法を示します。

$team = @{Team="IT"; Use="Testing"}
$TeamOption = New-PSSessionOption -ApplicationArguments $team
$s = New-PSSession -ComputerName Server01 -SessionOption $TeamOption
Invoke-Command -Session $s {$PSSenderInfo.ApplicationArguments}

Name                 Value
----                 -----
Team                 IT
Use                  Testing
PSVersionTable       {CLRVersion, BuildVersion, PSVersion, WSManStackVersion...}

Invoke-Command -Session $s {
  if ($PSSenderInfo.ApplicationArguments.Use -ne "Testing") {
    .\logFiles.ps1
  }
  else {
    "Just testing."
  }
}

Just testing.

最初のコマンドは、 Team と Use の 2 つのキーを持つハッシュ テーブルを作成します。 このコマンドは、ハッシュ テーブルを $team 変数に保存します。 ハッシュ テーブルの詳細については、「about_Hash_Tables (ハッシュ テーブルについて)」をご覧ください。

次に、New-PSSessionOption コマンドレットは、ApplicationArguments パラメーターを使用して、$team変数に保存された SessionOption オブジェクトを作成します。 セッション オプション オブジェクト New-PSSessionOption 作成すると、 ApplicationArguments パラメーターの値のハッシュ テーブルが PrimitiveDictionary に自動的に変換されるため、データをリモート セッションに確実に送信できます。

New-PSSession コマンドレットは、Server01 コンピューターでセッションを開始します。 SessionOption パラメーターを使用して、$teamOption変数にオプションを含めます。

Invoke-Command コマンドレットは、リモート セッションのコマンドで$team変数のデータを使用できる方法を示しています。 データは、$PSSenderInfo自動変数の ApplicationArguments プロパティに表示されます。

最後の Invoke-Command は、データがどのように使用されるかを示しています。

パラメーター

-ApplicationArguments

-CancelTimeout

-Culture

-IdleTimeout

-IncludePortInSPN

-MaxConnectionRetryCount

-MaximumReceivedDataSizePerCommand

-MaximumReceivedObjectSize

-MaximumRedirection

-NoCompression

-NoEncryption

-NoMachineProfile

-OpenTimeout

-OperationTimeout

-OutputBufferingMode

-ProxyAccessType

-ProxyAuthentication

-ProxyCredential

-SkipCACheck

-SkipCNCheck

-SkipRevocationCheck

-UICulture

-UseUTF16

入力

None

このコマンドレットにオブジェクトをパイプすることはできません。

出力

PSSessionOption

メモ

SessionOptionパラメーターをコマンドで使用してPSSessionを作成しない場合、セッション オプションは、$PSSessionOption基本設定変数のプロパティ値 (設定されている場合) によって決まります。 $PSSessionOption 変数の詳細については、「about_Preference_Variables」を参照してください。

セッション構成オブジェクトのプロパティは、セッション構成に設定されているオプションとその値によって異なります。 また、セッション構成ファイルを使用するセッション構成には追加のプロパティがあります。

関連リンク

• Enter-PSSession
• Invoke-Command
• New-PSSession