PowerShell Cmdlet - New-PSSessionOption
 記事記号:[mg1932] 初版:2011/Sep/30

この文書は、Windows PowerShellのヘルプ機能で表示される内容を再構成したものです。

名前
    New-PSSessionOption
    
概要
    PSSession の詳細オプションが格納されているオブジェクトを作成します。
    
構文
    New-PSSessionOption [-ApplicationArguments <PSPrimitiveDictionary>] [-Cancel
    TimeOut <int>] [-Culture <CultureInfo>] [-IdleTimeOut <int>] [-MaximumReceiv
    edDataSizePerCommand <int>] [-MaximumReceivedObjectSize <int>] [-MaximumRedi
    rection <int>] [-NoCompression] [-NoEncryption] [-NoMachineProfile] [-OpenTi
    meOut <int>] [-OperationTimeOut <int>] [-ProxyAccessType {None | IEConfig | 
    WinHttpConfig | AutoDetect | NoProxyServer}] [-ProxyAuthentication {Default 
    | Basic | Negotiate | NegotiateWithImplicitCredential | Credssp | Digest | K
    erberos}] [-ProxyCredential <PSCredential>] [-SkipCACheck] [-SkipCNCheck] [-
    SkipRevocationCheck] [-UICulture <CultureInfo>] [-UseUTF16] [<CommonParamete
    rs>]
    
説明
    New-PSSessionOption コマンドレットは PSSession の詳細オプションが格納されて
    いるオブジェクトを作成します。このオブジェクトは、New-PSSession、Enter-PSSes
    sion、Invoke-Command など、PSSession を作成するコマンドレットの SessionOptio
    n パラメーターの値として使用できます。
    
    パラメーターがない場合、New-PSSessionOption はすべてのオプションの既定値を含
    むオブジェクトを生成します。すべてのプロパティを編集できるため、結果のオブジ
    ェクトをテンプレートとして使用し、エンタープライズ用の標準的なオプション オ
    ブジェクトを作成できます。
    
パラメーター
    -ApplicationArguments <PSPrimitiveDictionary>
        解釈されずに直接、セッション構成に送られるハッシュ テーブルを指定します。
        このハッシュ テーブルは、PSSenderInfo クラスのプロパティとしてセッション
        構成で使用できます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -CancelTimeOut <int>
        終了するまでに、操作の取り消し (Ctrl + C キー) の完了を Windows PowerShe
        ll が待機する時間を指定します。値をミリ秒単位で入力します。
        
        既定値は 60000 (1 分) です。値 0 (ゼロ) はタイムアウトなしを意味し、コマ
        ンドは無期限に継続します。
        
        必須                         false
        位置                         named
        既定値                       60000
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Culture <CultureInfo>
        PSSession に使用するカルチャを指定します。"ja-jP" のような <languagecode
        2>-<country/regioncode2> の形式のカルチャ名、CultureInfo オブジェクトが
        含まれている変数、または CultureInfo オブジェクトを取得するコマンド (get
        -culture など) を入力します。
        
        既定値は $null です。PSSession の作成の際にオペレーティング システムで設
        定されているカルチャが PSSession で使用されます。
        
        必須                         false
        位置                         named
        既定値                       現在のカルチャ
        パイプライン入力を許可する   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
        既定値                       無制限
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -MaximumReceivedObjectSize <int>
        ローカル コンピューターが 1 つのコマンドでリモート コンピューターから受
        け取るオブジェクトの最大サイズを指定します。値をバイト単位で入力します。
        既定では、データ サイズの制限はありません。
        
        このオプションは、クライアント コンピューターのリソースを保護することを
        目的としています。
        
        必須                         false
        位置                         named
        既定値                       無制限
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -MaximumRedirection <int>
        接続が失敗するまでに、Windows PowerShell が接続を代替 URI (Uniform Resou
        rce Identifier) にリダイレクトする回数を指定します。既定値は 5 です。値
        が 0 (ゼロ) である場合、すべてのリダイレクトが禁止されます。
        
        このオプションは、PSSession を作成するコマンドで AllowRedirection パラメ
        ーターが使用される場合にのみ、PSSession で使用されます。
        
        必須                         false
        位置                         named
        既定値                       5
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -NoCompression [<SwitchParameter>]
        PSSession のパケット圧縮を無効にします。圧縮した場合はより多くのプロセッ
        サ サイクルが使用されますが、送信が速くなります。
        
        必須                         false
        位置                         named
        既定値                       False
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -NoEncryption [<SwitchParameter>]
        データ暗号化を無効にします。
        
        必須                         false
        位置                         named
        既定値                       False
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -NoMachineProfile [<SwitchParameter>]
        ユーザーの 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、Wi
        nHttpConfig、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.Auto
        mation.Runspaces.AuthenticationMechanism 列挙体の説明 (http://go.microso
        ft.com/fwlink/?LinkID=144382) を参照してください。
        
        必須                         false
        位置                         named
        既定値                       Negotiate
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -ProxyCredential <PSCredential>
        プロキシ認証に使用する資格情報を指定します。PSCredential オブジェクトを
        含んでいる変数を入力するか、Get-Credential など、PSCredential オブジェク
        トを取得するコマンドを入力します。このオプションが設定されていない場合、
        資格情報が指定されません。
        
        必須                         false
        位置                         named
        既定値                       なし
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -SkipCACheck [<SwitchParameter>]
        HTTPS を使用して接続する場合にクライアントでは信頼された認証機関 (CA) に
        よってサーバー証明書が署名されているかどうかは検証されないことを指定しま
        す。
        
        このオプションは、リモート コンピューターが他のメカニズムによって信頼さ
        れている場合にのみ使用します。たとえば、物理的にセキュリティ保護されて孤
        立したネットワークの一部である場合や、WinRM 構成で信頼されたホストとして
        示されている場合などです。
        
        必須                         false
        位置                         named
        既定値                       False
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -SkipCNCheck [<SwitchParameter>]
        サーバーの証明書の共通名 (CN) が、サーバーのホスト名と一致している必要が
        ないことを指定します。このオプションは、HTTPS プロトコルを使用したリモー
        ト操作でのみ使用します。
        
        このオプションは、信頼されたコンピューターについてのみ使用します。
        
        必須                         false
        位置                         named
        既定値                       False
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -SkipRevocationCheck [<SwitchParameter>]
        サーバー証明書の失効状態を検証しません。
        
        必須                         false
        位置                         named
        既定値                       False
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -UICulture <CultureInfo>
        PSSession に使用する UI カルチャを指定します。
        
        "ja-jP" のような <languagecode2>-<country/regioncode2> の形式のカルチャ
        名、CultureInfo オブジェクトが含まれている変数、または CultureInfo オブ
        ジェクトを取得するコマンド (Get-Culture など) を入力します。
        
        既定値は $null です。PSSession の作成の際にオペレーティング システムで
        設定されている UI カルチャが PSSession で使用されます。
        
        必須                         false
        位置                         named
        既定値                       現在の UI カルチャ
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -UseUTF16 [<SwitchParameter>]
        要求を、UTF8 形式ではなく UTF16 形式でエンコードします。
        
        必須                         false
        位置                         named
        既定値                       False (UTF8 エンコーディング)
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help 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-pssessionop
    tion -noEncryption -noCompression)    
    
    説明
    -----------
    このコマンドは、Enter-PSSession コマンドレットを使用して、Server01 コンピュ
    ーターとの対話型のセッションを開始します。SessionOption パラメーターの値は、
    NoEncryption および NoCompression スイッチ パラメーターを指定した New-PSSess
    ionOption コマンドです。
    
    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-PS
    Session、および 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 オプションが必要となります。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=144305
    Enter-PSSession 
    New-PSSession 
    Invoke-Command 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、New-PSSessionOption
ご利用数: 1856928
感想・要望・問い合わせは こちら