Test-Connection

ICMP エコー要求パケット (ping) を 1 つ以上のコンピューターに送信します。

構文

Test-Connection
    [-AsJob]
    [-DcomAuthentication <AuthenticationLevel>]
    [-WsmanAuthentication <String>]
    [-Protocol <String>]
    [-BufferSize <Int32>]
    [-ComputerName] <String[]>
    [-Count <Int32>]
    [-Impersonation <ImpersonationLevel>]
    [-ThrottleLimit <Int32>]
    [-TimeToLive <Int32>]
    [-Delay <Int32>]
    [<CommonParameters>]
Test-Connection
    [-AsJob]
    [-DcomAuthentication <AuthenticationLevel>]
    [-WsmanAuthentication <String>]
    [-Protocol <String>]
    [-BufferSize <Int32>]
    [-ComputerName] <String[]>
    [-Count <Int32>]
    [-Credential <PSCredential>]
    [-Source] <String[]>
    [-Impersonation <ImpersonationLevel>]
    [-ThrottleLimit <Int32>]
    [-TimeToLive <Int32>]
    [-Delay <Int32>]
    [<CommonParameters>]
Test-Connection
    [-DcomAuthentication <AuthenticationLevel>]
    [-WsmanAuthentication <String>]
    [-Protocol <String>]
    [-BufferSize <Int32>]
    [-ComputerName] <String[]>
    [-Count <Int32>]
    [-Impersonation <ImpersonationLevel>]
    [-TimeToLive <Int32>]
    [-Delay <Int32>]
    [-Quiet]
    [<CommonParameters>]

説明

このコマンドレットは Test-Connection 、インターネット制御メッセージ プロトコル (ICMP) エコー要求パケット (ping) を 1 つ以上のリモート コンピューターに送信し、エコー応答を返します。 このコマンドレットを使用して、特定のコンピューターに IP ネットワーク経由で接続できるかどうかを判断できます。

パラメーターを使用すると、送受信コンピューターの Test-Connection 両方を指定したり、バックグラウンド ジョブとしてコマンドを実行したり、タイムアウトと ping の数を設定したり、接続と認証を構成したりできます。

使い慣れた ping コマンドとは異なり、 Test-Connection PowerShell で調査できるWin32_PingStatus オブジェクトが返されます。 Quiet パラメーターはテストされた各接続の System.Boolean オブジェクトのブール値を返します。 複数の接続がテストされる場合は、ブール値の配列が返されます。

例 1: リモート コンピューターにエコー要求を送信する

この例では、ローカル コンピューターから Server01 コンピューターにエコー要求パケットを送信します。

Test-Connection -ComputerName Server01

Source        Destination     IPV4Address     IPV6Address  Bytes    Time(ms)
------        -----------     -----------     -----------  -----    --------
ADMIN1        Server01         10.59.137.44                32       0
ADMIN1        Server01         10.59.137.44                32       0
ADMIN1        Server01         10.59.137.44                32       0
ADMIN1        Server01         10.59.137.44                32       1

Test-Connection は、 ComputerName パラメーターを使用して Server01 コンピューターを指定します。

例 2: 複数のコンピューターにエコー要求を送信する

この例では、ローカル コンピューターから複数のリモート コンピューターに ping を送信します。

Test-Connection -ComputerName Server01, Server02, Server12

例 3: 複数のコンピューターから 1 台のコンピューターにエコー要求を送信する

この例では、異なるソース コンピューターから 1 台のリモート コンピューター Server01 に ping を送信します。

Test-Connection -Source Server02, Server12, localhost -ComputerName Server01 -Credential Domain01\Admin01

Test-Connectionでは、Credential パラメーターを使用して、ソース コンピューターから ping 要求を送信するアクセス許可を持つユーザーの資格情報を指定します。 複数のポイントからの接続の待機時間をテストするには、このコマンド形式を使用します。

例 4: パラメーターを使用してテスト コマンドをカスタマイズする

この例では、パラメーター Test-Connection を使用してコマンドをカスタマイズします。 ローカル コンピューターからリモート コンピューターに ping テストが送信されます。

Test-Connection -ComputerName Server01 -Count 3 -Delay 2 -TTL 255 -BufferSize 256 -ThrottleLimit 32

Test-Connectionは、ComputerName パラメーターを使用して Server01 を指定します。 Count パラメーターは、2 秒間隔の遅延Server01 コンピューターに 3 つの ping を送信することを指定します。

これらのオプションは、ホップ数が長いか、トラフィックの多いネットワーク状態が原因で、ping 応答に通常よりも長い時間がかかると予想される場合に使用できます。

例 5: バックグラウンド ジョブとしてテストを実行する

この例では、PowerShell バックグラウンド ジョブとしてコマンドを Test-Connection 実行する方法を示します。

$job = Test-Connection -ComputerName (Get-Content Servers.txt) -AsJob
if ($job.JobStateInfo.State -ne "Running") {$Results = Receive-Job $job}

このコマンドは Test-Connection 、企業内の多くのコンピューターに ping を実行します。 ComputerName パラメーターの値は、Get-Contentコンピューター名Servers.txt fileの一覧を読み取るコマンドです。 このコマンドでは、AsJob パラメーターを使用してバックグラウンド ジョブとしてコマンドを実行し、そのジョブを変数に$job保存します。

このコマンドチェックif、ジョブがまだ実行されていないことを確認します。 ジョブが実行されていない場合は、 Receive-Job 結果を取得し、変数に $Results 格納します。

例 6: 資格情報を使用してリモート コンピューターに ping を実行する

このコマンドでは、コマンドレットを Test-Connection 使用してリモート コンピューターに ping を実行します。

Test-Connection Server55 -Credential Domain55\User01 -Impersonation Identify

このコマンドでは、Credential パラメーターを使用して、リモート コンピューターに ping を実行するアクセス許可を持つユーザー アカウントを指定し、偽装パラメーターを使用して偽装レベルを [識別] に変更します。

例 7: 接続テストが成功した場合にのみセッションを作成する

この例では、コンピューターに送信された ping の少なくとも 1 つが成功した場合にのみ、Server01 コンピューターにセッションを作成します。

if (Test-Connection -ComputerName Server01 -Quiet) {New-PSSession Server01}

このコマンドでは if 、コマンドレットを Test-Connection 使用して Server01 コンピューターに ping を実行します。 このコマンドでは、quiet パラメーターを使用します。このパラメーターは、Win32_PingStatus オブジェクトの代わりにブール値をします。 この値は、 $True 4 つの ping のいずれかが成功し、それ以外の場合 $Falseは .

コマンドが値をTest-Connection返す場合、コマンドはコマンドレットをNew-PSSession使用して PSSession作成$Trueします。

パラメーター

-AsJob

このコマンドレットがバックグラウンド ジョブとして実行されることを示します。

このパラメーターを使用するには、リモート処理用にローカル コンピューターとリモート コンピューターを構成する必要があります。Windows Vista 以降のバージョンの Windows オペレーティング システムでは、[管理者として実行] オプションを使用して PowerShell を開く必要があります。 詳細については、「about_Remote_Requirements」を参照してください

AsJob パラメーターを指定すると、コマンドはバックグラウンド ジョブを表すオブジェクトを直ちに返します。 ジョブが完了しても、引き続きセッションで作業できます。 ジョブは、ローカル コンピューターで作成され、リモート コンピューターでの結果は自動的にローカル コンピューターに返されます。 ジョブの結果を取得するには、コマンドレットを Receive-Job 使用します。

PowerShell バックグラウンド ジョブの詳細については、「about_Jobsとabout_Remote_Jobs」を参照してください

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

-BufferSize

このコマンドで送信されるバッファーのサイズをバイト単位で指定します。 既定値は 32 です。

Type:Int32
Aliases:Size, Bytes, BS
Position:Named
Default value:32
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

ping するコンピューターを指定します。 コンピューター名を入力するか、IP アドレスを IPv4 または IPv6 形式で入力します。 ワイルドカード文字は使用できません。 このパラメーターは必須です。

このパラメーターは、PowerShell リモート処理には依存しません。 コンピューターがリモート コマンドを 実行するように構成されていない場合でも、ComputerName パラメーターを使用できます。

Note

ComputerName パラメーターの名前は、PowerShell 6.0 以降では TargetName に変更されます

Type:String[]
Aliases:CN, IPAddress, __SERVER, Server, Destination
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Count

送信するエコー要求の数を指定します。 既定値は 4 ですが、

Type:Int32
Position:Named
Default value:4
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

送信元コンピューターから ping 要求を送信するアクセス許可を持つユーザー アカウントを指定します。 User01 や Doメイン01\User01 などのユーザー名を入力するか、コマンドレットのオブジェクトなどの PSCredential オブジェクトをGet-Credential入力します。

Credential パラメーターは、Source パラメーターがコマンドで使用されている場合にのみ有効です。 資格情報は、対象のコンピューターには影響しません。

Type:PSCredential
Position:Named
Default value:Current user
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DcomAuthentication

このコマンドレットが WMI で使用する認証レベルを指定します。 Test-Connection は WMI を使用します。 このパラメーターの有効値は、次のとおりです。

  • 既定。 Windows 認証
  • なし。 COM 認証なし
  • 接続。 接続レベルの COM 認証
  • 呼び出す。 呼び出しレベルの COM 認証
  • パケット。 パケット レベルの COM 認証
  • PacketIntegrity。 パケット整合性レベルの COM 認証
  • PacketPrivacy。 パケット プライバシー レベルの COM 認証
  • 変更なし。 前のコマンドと同じ

既定値は、列挙値が 4 の Packet です。 このパラメーターの値の詳細については、「AuthenticationLevel 列挙型」を参照してください

Type:AuthenticationLevel
Aliases:Authentication
Accepted values:Default, None, Connect, Call, Packet, PacketIntegrity, PacketPrivacy, Unchanged
Position:Named
Default value:Packet (enumerated value of 4)
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Delay

ping 間の間隔を秒単位で指定します。

Type:Int32
Position:Named
Default value:1 (second)
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Impersonation

このコマンドレットが WMI を呼び出すときに使用する偽装レベルを指定します。 Test-Connection は WMI を使用します。

このパラメーターに使用できる値は次のとおりです。

  • 既定。 既定の偽装。
  • 匿名。 呼び出し元の ID は非表示になります。
  • 識別する。 オブジェクトによる呼び出し元の資格情報のクエリが許可されます。
  • 偽装する。 オブジェクトによる呼び出し元の資格情報の使用が許可されます。

既定値は Impersonate です

Type:ImpersonationLevel
Accepted values:Default, Anonymous, Identify, Impersonate, Delegate
Position:Named
Default value:Impersonate
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Protocol

プロトコルを指定します。 このパラメーターに使用できる値は、DCOM と WSMan です。

Type:String
Accepted values:DCOM, WSMan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Quiet

Quiet パラメーターはSystem.Boolean オブジェクトのブール値を返します。 このパラメーターを使用すると、すべてのエラーが抑制されます。

テストされた各接続はブール値を返します。 ComputerName パラメーターで複数のコンピューターを指定した場合は、ブール値の配列が返されます。

ping が成功した場合は、$True返されます。

すべての ping が失敗した場合は、$False返されます。

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

-Source

ping の送信元コンピューターの名前を指定します。 コンピューター名のコンマ区切りのリストを入力します。 既定値はローカル コンピューターです。

Type:String[]
Aliases:FCN, SRC
Position:1
Default value:Local computer
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

このコマンドを実行するために確立できる最大コンカレント接続数を指定します。 このパラメーターを省略した場合、または値 0 を入力した場合は、既定値の 32 が使用されます。

スロットル制限は現在のコマンドのみに適用され、セッションまたはコンピューターには適用されません。

Type:Int32
Position:Named
Default value:32
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TimeToLive

パケットを転送できる最大時間を指定します。 ゲートウェイ、ルーターなどの ホップごとに、TimeToLive 値が 1 ずつ減少します。 ゼロの場合、パケットはカード解除され、エラーが返されます。 Windows では、既定値は 128 です。 TimeToLive パラメーターのエイリアスは TTL です

Type:Int32
Aliases:TTL
Position:Named
Default value:128 in Windows
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WsmanAuthentication

このコマンドレットが WSMan プロトコルを使用するときにユーザー資格情報を認証するために使用されるメカニズムを指定します。 このパラメーターの有効値は、次のとおりです。

  • 基本
  • CredSSP
  • 既定値
  • Digest
  • Kerberos
  • 交渉。

既定値は Default です。

このパラメーターの値の詳細については、「AuthenticationMechanism 列挙型」を参照してください

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

このパラメーターは Windows PowerShell 3.0 で導入されました。

Type:String
Accepted values:Default, Basic, Negotiate, CredSSP, Digest, Kerberos
Position:Named
Default value:Default
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

None

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

出力

ManagementObject

既定では、このコマンドレットは ping 応答ごとに Win32_PingStatus オブジェクトを返します。

System.Management.Automation.RemotingJob

AsJob パラメーターを指定すると、このコマンドレットはジョブ オブジェクトを返します。

Boolean

Quiet パラメーターを使用すると、ブール値がされます。 コマンドレットが複数の接続をテストする場合は、ブール値の配列を返します。

メモ

このコマンドレットでは、Win32_PingStatus クラスを使用します。 Get-WMIObject Win32_PingStatusコマンドは、コマンドとTest-Connection同じです。

Source パラメーター セットは、PowerShell 3.0 で導入されました。