New-CimSession

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>]

説明

このコマンドレットは、Windows プラットフォームでのみ使用できます。

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

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

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

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

New-CimSession

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

この例では、 ComputerName で指定されたコンピューターへの CIM セッションを作成します。 既定では、 New-CimSessionComputerName が指定されたときに 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 オブジェクトと認証で指定された認証の種類を使用して、ComputerName で指定されたコンピューターへの CIM セッションを作成します。

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

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

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

次の使用例は、ポートで指定された 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

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

  • Default
  • ダイジェスト
  • ネゴシエート
  • Basic
  • Kerberos
  • NtlmDomain
  • CredSsp

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

注意事項

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

Type:PasswordAuthenticationMechanism
Accepted values:Default, Digest, Negotiate, Basic, Kerberos, NtlmDomain, CredSsp
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-CertificateThumbprint

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

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

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

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

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-ComputerName

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

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

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

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

Type:String[]
Aliases:CN, ServerName
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Credential

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

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

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

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

Type:PSCredential
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Name

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

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

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-OperationTimeoutSec

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

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

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

Type:UInt32
Aliases:OT
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters: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 パラメーターを使用しないでください。 コマンドのポート設定は、コマンドが実行されるすべてのコンピューターまたはセッションに適用されます。 代替ポートの設定によっては、コマンドがすべてのコンピューターで実行されない場合があります。

Type:UInt32
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-SessionOption

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

Type:CimSessionOptions
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-SkipTestConnection

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

入力

None

このコマンドレットは入力を受け入れありません。

出力

CimSession