New-CimSession

  • リファレンス
モジュール:
CimCmdlets

CIM セッションを作成します。

構文

New-CimSession
   [-Authentication <PasswordAuthenticationMechanism>]
   [[-Credential] <PSCredential>]
   [[-ComputerName] <String[]>]
   [-Name <String>]
   [-OperationTimeoutSec <UInt32>]
   [-SkipTestConnection]
   [-Port <UInt32>]
   [-SessionOption <CimSessionOptions>]
   [<CommonParameters>]
New-CimSession
   [-CertificateThumbprint <String>]
   [[-ComputerName] <String[]>]
   [-Name <String>]
   [-OperationTimeoutSec <UInt32>]
   [-SkipTestConnection]
   [-Port <UInt32>]
   [-SessionOption <CimSessionOptions>]
   [<CommonParameters>]

説明

New-CimSession コマンドレットは CIM セッションを作成します。 CIM セッションは、ローカル コンピューターまたはリモート コンピューターへの接続を表すクライアント側オブジェクトです。 CIM セッションには、 ComputerName、使用されるプロトコル、さまざまな識別子など、接続に関する情報が含まれます。

このコマンドレットは、他のすべての CIM コマンドレットで使用できる CIM セッション オブジェクトを返します。

例

例 1: 既定のオプションを使用して CIM セッションを作成する

この例では、既定のオプションを使用してローカル CIM セッションを作成します。 ComputerNameが指定されていない場合、New-CimSessionはローカル コンピューターへの DCOM セッションを作成します。

New-CimSession

例 2: 特定のコンピューターへの CIM セッションを作成する

この例では、 ComputerName で指定されたコンピューターへの CIM セッションを作成します。 既定では、 New-CimSession は、 ComputerName が指定されたときに WSMan セッションを作成します。

New-CimSession -ComputerName Server01

例 3: 複数のコンピューターへの CIM セッションを作成する

この例では、コンマ区切りリストで ComputerName で指定された各コンピューターへの CIM セッションを作成します。

New-CimSession -ComputerName Server01,Server02,Server03

例 4: フレンドリ名を使用して CIM セッションを作成する

この例では、コンマ区切りの一覧で ComputerName で指定された各コンピューターにリモート CIM セッションを作成し、 Name を指定して、新しいセッションにフレンドリ名を割り当てます。

New-CimSession -ComputerName Server01,Server02 -Name FileServers
Get-CimSession -Name File*

CIM セッションのフレンドリ名を使用して、他の CIM コマンドレットでセッションを参照できます (例: Get-CimSession。

例 5: PSCredential オブジェクトを使用してコンピューターへの CIM セッションを作成する

この例では、Credential で指定された PSCredential オブジェクトと、Authentication で指定された認証の種類を使用して、 ComputerName で指定されたコンピューターへの CIM セッションを作成します。

New-CimSession -ComputerName Server01 -Credential $cred -Authentication Negotiate

Get-Credential コマンドレットを使用して、PSCredential オブジェクトを作成できます。

例 6: 特定のポートを使用してコンピューターへの CIM セッションを作成する

この例では、Port で指定された TCP ポートを使用してComputerName で指定されたコンピューターへの CIM セッションを作成します。

New-CimSession -ComputerName Server01 -Port 1234

例 7: DCOM を使用して CIM セッションを作成する

この例では、WSMan ではなく分散 COM (DCOM) プロトコルを使用して CIM セッションを作成します。

$SessionOption = New-CimSessionOption -Protocol DCOM
New-CimSession -ComputerName Server1 -SessionOption $SessionOption

パラメーター

-Authentication

ユーザーの資格情報に使用される認証の種類を指定します。 このパラメーターの有効値は、次のとおりです。

  • 既定値
  • ダイジェスト
  • ネゴシエート
  • 基本
  • Kerberos
  • NtlmDomain
  • CredSsp

ローカル コンピューターへの接続に NtlmDomain 認証の種類を使用することはできません。 CredSSP 認証は、Windows Vista、Windows Server 2008、およびそれ以降のバージョンの Windows でのみ使用できます。

注意事項

資格情報セキュリティ サービス プロバイダー (CredSSP) 認証は、リモート ネットワーク共有へのアクセスなど、複数のリソースで認証を必要とするコマンド用に設計されています。 このメカニズムを使用すると、リモート操作のセキュリティ リスクが高まります。 リモート コンピューターのセキュリティが低下している場合は、そのリモート コンピューターに渡される資格情報を使用してネットワーク セッションが制御される場合があります。

型:PasswordAuthenticationMechanism
指定可能な値:Default, Digest, Negotiate, Basic, Kerberos, NtlmDomain, CredSsp
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-CertificateThumbprint

このアクションを実行するアクセス許可を持つユーザー アカウントのデジタル公開キー証明書 (X.509) を指定します。 証明書の拇印を入力します。

証明書は、クライアント証明書ベースの認証で使用されます。 これらの証明書は、ローカル ユーザー アカウントにしかマップできません。ドメイン アカウントでは機能しません。

証明書の拇印を取得するには、PowerShell 証明書プロバイダーの Get-Item または Get-ChildItem コマンドレットを使用します。

詳細については、「 about_Certificate_Provider」を参照してください。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ComputerName

CIM セッションを作成するコンピューターの名前を指定します。 1 つのコンピューター名、または複数のコンピューター名をコンマで区切って指定します。

ComputerNameが指定されていない場合は、ローカル コンピューターへの CIM セッションが作成されます。 コンピューター名の値は、次のいずれかの形式で指定できます。

  • 1 つ以上の NetBIOS 名
  • 1 つ以上の IP アドレス
  • 1 つ以上の完全修飾ドメイン名。

コンピューターがユーザーとは異なるドメインにある場合は、完全修飾ドメイン名を指定する必要があります。

型:String[]
Aliases:CN, ServerName
配置:1
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Credential

この処理を実行するアクセス許可を持つユーザー アカウントを指定します。 Credentialが指定されていない場合は、現在のユーザー アカウントが使用されます。

次のいずれかの形式を使用して、 Credential の値を指定します。

  • ユーザー名: "User01"
  • ドメイン名とユーザー名: "Domain01\User01"
  • ユーザー プリンシパル名: "User@Domain.com"
  • PSCredential オブジェクト ( Get-Credential コマンドレットによって返されるオブジェクトなど)。

ユーザー名を入力すると、パスワードの入力を促すメッセージが表示されます。

型:PSCredential
配置:2
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Name

CIM セッションのフレンドリ名を指定します。

Get-CimSession コマンドレットなどの他のコマンドレットを使用する場合は、名前を使用して CIM セッションを参照できます。 名前は、コンピューターや現在のセッションで一意である必要ありません。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-OperationTimeoutSec

コマンドレットがサーバーからの応答を待機する期間。

既定では、このパラメーターの値は 0 です。これは、コマンドレットがサーバーの既定のタイムアウト値を使用することを意味します。

OperationTimeoutSecパラメーターが堅牢な接続再試行タイムアウト 3 分未満の値に設定されている場合、クライアントが再接続する前にサーバーでの操作がタイムアウトするため、OperationTimeoutSec パラメーターの値を超えるネットワーク障害は復旧できません。

型:UInt32
Aliases:OT
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Port

この接続に使用するリモート コンピューター上のネットワーク ポートを指定します。 リモート コンピューターに接続するには、リモート コンピューターで、接続に使用されるポートをリッスンすることが必要です。 既定のポート番号は 5985 (HTTP 用の WinRM ポート) と 5986 (HTTPS 用の WinRM ポート) です。

代替ポートを使用する前に、そのポートでリッスンするようにリモート コンピューター上の WinRM リスナーを構成する必要があります。 リスナーを構成するには、次のコマンドを使用します。

winrm delete winrm/config/listener?Address=*+Transport=HTTP

winrm create winrm/config/listener?Address=*+Transport=HTTP @{Port="\<port-number>"}

必要な場合を除き、 Port パラメーターは使用しないでください。 コマンドのポート設定は、コマンドが実行されるすべてのコンピューターまたはセッションに適用されます。 代替ポートの設定によっては、コマンドがすべてのコンピューターで実行されない場合があります。

型:UInt32
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-SessionOption

新しい CIM セッションの詳細オプションを設定します。 New-CimSessionOption コマンドレットを使用して作成された CimSessionOption オブジェクトの名前を入力します。

型:CimSessionOptions
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-SkipTestConnection

既定では、 New-CimSession コマンドレットは、 Port パラメーターを使用して指定されたポート番号でリモート サーバーがリッスンしていることを確認し、指定されたアカウント資格情報を確認するという 2 つの理由で、リモート WS-Management エンドポイントとの接続を確立します。 検証は、標準の WS-Identity 操作を使用して行われます。 リモート WS-Management エンドポイントで WS-Identify を使用できない場合、またはデータ転送時間を短縮する場合は、 SkipTestConnection スイッチ パラメーターを追加できます。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

入力

None

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

出力

CimSession

このコマンドレットは CIM セッション オブジェクトを返します。