New-CimSession
CIM セッションを作成します。
構文
CredentialParameterSet (既定)
New-CimSession
[[-Credential] <PSCredential>]
[[-ComputerName] <String[]>]
[-Authentication <PasswordAuthenticationMechanism>]
[-Name <String>]
[-OperationTimeoutSec <UInt32>]
[-SkipTestConnection]
[-Port <UInt32>]
[-SessionOption <CimSessionOptions>]
[<CommonParameters>]
CertificateParameterSet
New-CimSession
[[-ComputerName] <String[]>]
[-CertificateThumbprint <String>]
[-Name <String>]
[-OperationTimeoutSec <UInt32>]
[-SkipTestConnection]
[-Port <UInt32>]
[-SessionOption <CimSessionOptions>]
[<CommonParameters>]
説明
New-CimSession コマンドレットは CIM セッションを作成します。
CIM セッションは、ローカル コンピューターまたはリモート コンピューターへの接続を表すクライアント側オブジェクトです。
CIM セッションには、接続に使用されるプロトコルである ComputerName、セッション ID、インスタンス ID など、接続に関する情報が含まれます。
このコマンドレットは、他のすべての CIM コマンドレットで使用できる CIM セッション オブジェクトを返します。
例
例 1: 既定のオプションを使用して CIM セッションを作成する
New-CimSession
このコマンドは、既定のオプションを使用してローカル CIM セッションを作成します。
ComputerName が指定されていない場合、New-CimSession はローカル コンピューターへの DCOM セッションを作成します。
例 2: 特定のコンピューターへの CIM セッションを作成する
New-CimSession -ComputerName Server01
このコマンドは、ComputerNameで指定されたコンピューター
例 3: 複数のコンピューターへの CIM セッションを作成する
New-CimSession -ComputerName Server01,Server02,Server03
このコマンドは,コンマ区切りリストで ComputerName
例 4: フレンドリ名を使用して CIM セッションを作成する
CIM セッションのフレンドリ名を使用すると、他の CIM コマンドレットでセッションを簡単に参照できます (例: Get-CimSession
New-CimSession -ComputerName Server01,Server02 -Name FileServers
Get-CimSession -Name File*
このコマンドは,ComputerNameで指定された各コンピューターへのリモート CIM セッションをコンマ区切りリストに作成し,名前を指定して新しいセッションにフレンドリ名を割り当てます。
例 5: PSCredential オブジェクトを使用してコンピューターへの CIM セッションを作成する
New-CimSession -ComputerName Server01 -Credential $cred -Authentication Negotiate
このコマンドは、
psCredential オブジェクトは、Get-Credential コマンドレットを使用して作成できます。
例 6: 特定のポートを使用してコンピューターへの CIM セッションを作成する
New-CimSession -ComputerName Server01 -Port 1234
このコマンドは、ポートで指定された TCP ポートを使用して、ComputerName で指定されたコンピューター
例 7: DCOM を使用して CIM セッションを作成する
$SessionOption = New-CimSessionOption -Protocol DCOM
New-CimSession -ComputerName Server1 -SessionOption $SessionOption
このコマンドは、WSMan の代わりに分散 COM (DCOM) プロトコルを使用して CIM セッションを作成します。
パラメーター
-Authentication
ユーザーの資格情報に使用される認証の種類を指定します。 このパラメーターに使用できる値は次のとおりです。
- 既定値
- ダイジェスト
- 交渉する
- Basic
- Kerberos
- NtlmDomain
- CredSsp
ローカル コンピューターへの接続に NtlmDomain 認証の種類を使用することはできません。 CredSSP 認証は、Windows Vista、Windows Server 2008、およびそれ以降のバージョンの Windows でのみ使用できます。
注意: ユーザーの資格情報が認証されるリモート コンピューターにユーザーの資格情報が渡される資格情報セキュリティ サービス プロバイダー (CredSSP) 認証は、リモート ネットワーク共有へのアクセスなど、複数のリソースで認証を必要とするコマンド用に設計されています。 このメカニズムにより、リモート操作のセキュリティ リスクが高まります。 リモート コンピューターが侵害された場合、それに渡される資格情報を使用してネットワーク セッションを制御できます。
パラメーターのプロパティ
| 型: | PasswordAuthenticationMechanism |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CredentialParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-CertificateThumbprint
このアクションを実行するアクセス許可を持つユーザー アカウントのデジタル公開キー証明書 (X.509) を指定します。 証明書の拇印を入力します。
証明書は、クライアント証明書ベースの認証で使用されます。 これらはローカル ユーザー アカウントにのみマップできます。ドメイン アカウントでは機能しません。
証明書の拇印を取得するには、PowerShell 証明書プロバイダーの Get-Item または Get-ChildItem コマンドレットを使用します。
PowerShell 証明書プロバイダーの使用方法の詳細については、「
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CertificateParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ComputerName
CIM セッションを作成するコンピューターの名前を指定します。 1 つのコンピューター名、または複数のコンピューター名をコンマで区切って指定します。
ComputerName が指定されていない場合は、ローカル コンピューターへの CIM セッションが作成されます。
コンピューター名の値は、次のいずれかの形式で指定できます。
- 1 つ以上の NetBIOS 名
- 1 つ以上の IP アドレス
- 1 つ以上の完全修飾ドメイン名。
コンピューターがユーザーとは異なるドメインにある場合は、完全修飾ドメイン名を指定する必要があります。
パイプラインを使用して、コンピューター名 (引用符で囲む) を New-CimSession に渡すこともできます。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | CN, サーバー名 |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Credential
このアクションを実行するアクセス許可を持つユーザー アカウントを指定します。 資格情報 が指定されていない場合は、現在のユーザー アカウントが使用されます。
次のいずれかの形式を使用して、資格情報 の値を指定します。
- ユーザー名: "User01"
- ドメイン名とユーザー名: "Domain01\User01"
- ユーザー プリンシパル名: "User@Domain.com"
- psCredential オブジェクト (
Get-Credentialコマンドレットによって返されるオブジェクトなど)。
ユーザー名を入力すると、パスワードの入力を求められます。
パラメーターのプロパティ
| 型: | PSCredential |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CredentialParameterSet
| 配置: | 2 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
CIM セッションのフレンドリ名を指定します。
Get-CimSession コマンドレットなどの他のコマンドレットを使用する場合は、名前を使用して CIM セッションを参照できます。
名前は、コンピューターまたは現在のセッションに対して一意である必要はありません。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-OperationTimeoutSec
コマンドレットがサーバーからの応答を待機する期間。
既定では、このパラメーターの値は 0 です。これは、コマンドレットがサーバーの既定のタイムアウト値を使用することを意味します。
OperationTimeoutSec パラメーターが、堅牢な接続再試行タイムアウトの 3 分未満の値に設定されている場合、OperationTimeoutSec パラメーターの値を超えるネットワーク 障害は復旧できません。これは、クライアントが再接続する前にサーバーでの操作がタイムアウトするためです。
パラメーターのプロパティ
| 型: | UInt32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | OT |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | 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 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-SessionOption
新しい CIM セッションの詳細オプションを設定します。
New-CimSessionOption コマンドレットを使用して作成された CimSessionOption オブジェクトの名前を入力します。
パラメーターのプロパティ
| 型: | CimSessionOptions |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-SkipTestConnection
既定では、New-CimSession コマンドレットは、リモート WS-Management エンドポイントとの接続を確立します。リモート サーバーが Port パラメーターを使用して指定されたポート番号をリッスンしていることを確認し、指定したアカウント資格情報を確認します。
検証は、標準の WS-Identity 操作を使用して行われます。
リモート WS-Management エンドポイントで WS-Identify を使用できない場合、またはデータ転送時間を短縮する場合は、SkipTestConnection スイッチ パラメーターを追加できます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
None
このコマンドレットは入力を受け入れていません。