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 セッションを作成します。
既定では、ComputerName
New-CimSession -ComputerName Server01
例 3: 複数のコンピューターへの CIM セッションを作成する
次の使用例では、コンマ区切りの一覧で指定された各コンピューター ComputerName
New-CimSession -ComputerName Server01, Server02, Server03
例 4: フレンドリ名を使用して CIM セッションを作成する
この例では、ComputerNameで指定された各コンピューターに対してリモート CIM セッションをコンマ区切りリストに作成し、新しいセッションにフレンドリ名 割り当てます。
New-CimSession -ComputerName Server01, Server02 -Name FileServers
Get-CimSession -Name File*
CIM セッションのフレンドリ名を使用して、他の CIM コマンドレット (例: Get-CimSession) でそのセッション
例 5: PSCredential オブジェクトを使用してコンピューターへの CIM セッションを作成する
この例では、
New-CimSession -ComputerName Server01 -Credential $cred -Authentication Negotiate
コマンドレットを使用して、Get-Credential
オブジェクトを作成できます。
例 6: 特定のポートを使用してコンピューターへの CIM セッションを作成する
この例では、ComputerName で指定されたコンピューターに、Portで指定された TCP ポートを使用して 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
ユーザーの資格情報に使用される認証の種類を指定します。 このパラメーターに使用できる値は次のとおりです。
- 既定値
- ダイジェスト
- 交渉する
- Basic
- 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
このアクションを実行するアクセス許可を持つユーザー アカウントを指定します。 資格情報 が指定されていない場合は、現在のユーザー アカウントが使用されます。
次のいずれかの形式を使用して、資格情報 の値を指定します。
- ユーザー名: "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
オブジェクトの名前を入力します。
型: | CimSessionOptions |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-SkipTestConnection
既定では、New-CimSession
コマンドレットは、リモート WS-Management エンドポイントとの接続を確立します。リモート サーバーが Port パラメーターを使用して指定されたポート番号をリッスンしていることを確認し、指定されたアカウント資格情報を確認します。 検証は、標準の WS-Identity 操作を使用して実行されます。 リモート WS-Management エンドポイントで WS-Identify を使用できない場合、またはデータ転送時間を短縮する場合は、SkipTestConnection スイッチ パラメーターを追加できます。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
入力
None
このコマンドレットにオブジェクトをパイプすることはできません。
出力
このコマンドレットは CIM セッション オブジェクトを返します。
メモ
PowerShell には、New-CimSession
の次のエイリアスが含まれています。
- ウィンドウズ:
ncms
このコマンドレットは、Windows プラットフォームでのみ使用できます。