Test-Connection

  • リファレンス
モジュール:
Microsoft.PowerShell.Management

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

構文

Test-Connection
    [-TargetName] <string[]>
    [-Ping]
    [-IPv4]
    [-IPv6]
    [-ResolveDestination]
    [-Source <string>]
    [-MaxHops <int>]
    [-Count <int>]
    [-Delay <int>]
    [-BufferSize <int>]
    [-DontFragment]
    [-TimeoutSeconds <int>]
    [-Quiet]
    [<CommonParameters>]
Test-Connection
    [-TargetName] <string[]>
    -Repeat
    [-Ping]
    [-IPv4]
    [-IPv6]
    [-ResolveDestination]
    [-Source <string>]
    [-MaxHops <int>]
    [-Delay <int>]
    [-BufferSize <int>]
    [-DontFragment]
    [-TimeoutSeconds <int>]
    [-Quiet]
    [<CommonParameters>]
Test-Connection
    [-TargetName] <string[]>
    -MtuSize
    [-IPv4]
    [-IPv6]
    [-ResolveDestination]
    [-TimeoutSeconds <int>]
    [-Quiet]
    [<CommonParameters>]
Test-Connection
    [-TargetName] <string[]>
    -Traceroute
    [-IPv4]
    [-IPv6]
    [-ResolveDestination]
    [-Source <string>]
    [-MaxHops <int>]
    [-TimeoutSeconds <int>]
    [-Quiet]
    [<CommonParameters>]
Test-Connection
    [-TargetName] <string[]>
    -TcpPort <int>
    [-IPv4]
    [-IPv6]
    [-ResolveDestination]
    [-Source <string>]
    [-TimeoutSeconds <int>]
    [-Quiet]
    [<CommonParameters>]

説明

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

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

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

例

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

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

Test-Connection -TargetName Server01 -IPv4

Destination: Server01

Ping Source           Address                   Latency BufferSize Status
                                                   (ms)        (B)
---- ------           -------                   ------- ---------- ------
   1 ADMIN1           10.59.137.44                   24         32 Success
   2 ADMIN1           10.59.137.44                   39         32 Success
   3 ADMIN1           *                               *          * TimedOut
   4 ADMIN1           10.59.137.44                   28         32 Success

Test-Connectionは TargetName パラメーターを使用して Server01 コンピューターを指定します。 IPv4 パラメーターは、テストのプロトコルを指定します。

一連の TestConnectionCommand+PingStatus オブジェクトが出力ストリームに送信され、ターゲット コンピューターからの ping 応答ごとに 1 つのオブジェクトが送信されます。

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

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

Test-Connection -TargetName Server01, Server02, Server12

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

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

Test-Connection -TargetName Server01 -Count 3 -Delay 2 -MaxHops 255 -BufferSize 256

Test-Connectionは TargetName パラメーターを使用して Server01 を指定します。 Count パラメーターは、2 秒の間隔で 3 つの ping が Server01 コンピューターに送信されるように指定します。

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

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

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

$job = Start-Job -ScriptBlock { Test-Connection -TargetName (Get-Content -Path "Servers.txt") }
$Results = Receive-Job $job -Wait

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

コマンドは Receive-Job 、ジョブが完了するまで に -Wait 指示され、結果を取得して変数に $Results 格納します。

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

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

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

コマンドレットはTest-Connection、Quiet パラメーターをServer01指定してコンピューターに ping を実行します。 結果の値は、 $True 4 つの ping のいずれかが成功した場合です。 ping が成功しない場合、値は です $False。

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

例 6: Traceroute パラメーターを使用する

PowerShell 6.0 で導入された Traceroute パラメーターは、ローカル コンピューターと TargetName パラメーターで指定したリモート接続先との間のルートをマップします。

Test-Connection -TargetName www.google.com -Traceroute

Target: google.com

Hop Hostname                  Ping Latency Status           Source       TargetAddress
                                      (ms)
--- --------                  ---- ------- ------           ------       -------------
  1 172.20.0.1                   1       4 Success          Lira         172.217.9.174
  1 172.20.0.1                   2       3 Success          Lira         172.217.9.174
  1 172.20.0.1                   3       2 Success          Lira         172.217.9.174
  2 12.108.153.193               1       3 Success          Lira         172.217.9.174
  2 12.108.153.193               2       3 Success          Lira         172.217.9.174
  2 12.108.153.193               3       2 Success          Lira         172.217.9.174
  3 12.244.85.177                1      11 Success          Lira         172.217.9.174
  3 12.244.85.177                2      12 Success          Lira         172.217.9.174
  3 12.244.85.177                3      12 Success          Lira         172.217.9.174
  4 *                            1      14 DestinationNetw… Lira         172.217.9.174
  4 *                            2       * TimedOut         Lira         172.217.9.174
  4 *                            3      20 DestinationNetw… Lira         172.217.9.174
  5 *                            1       * TimedOut         Lira         172.217.9.174
  5 *                            2      15 DestinationNetw… Lira         172.217.9.174
  5 *                            3       * TimedOut         Lira         172.217.9.174
  6 *                            1      18 DestinationNetw… Lira         172.217.9.174
  6 *                            2       * TimedOut         Lira         172.217.9.174
  6 *                            3      16 DestinationNetw… Lira         172.217.9.174
  7 *                            1       * TimedOut         Lira         172.217.9.174
  7 *                            2       * TimedOut         Lira         172.217.9.174
  7 *                            3       * TimedOut         Lira         172.217.9.174
  8 *                            1       * TimedOut         Lira         172.217.9.174
  8 *                            2       * TimedOut         Lira         172.217.9.174
  8 *                            3       * TimedOut         Lira         172.217.9.174
  9 *                            1       * TimedOut         Lira         172.217.9.174
  9 *                            2       * TimedOut         Lira         172.217.9.174
  9 *                            3       * TimedOut         Lira         172.217.9.174
 10 *                            1       * TimedOut         Lira         172.217.9.174
 10 *                            2       * TimedOut         Lira         172.217.9.174
 10 *                            3       * TimedOut         Lira         172.217.9.174
 11 172.217.9.174                1      23 Success          Lira         172.217.9.174
 11 172.217.9.174                2      21 Success          Lira         172.217.9.174
 11 172.217.9.174                3      22 Success          Lira         172.217.9.174

コマンドは Test-ConnectionTraceroute パラメーターを使用して呼び出されます。 結果 (オブジェクト) [Microsoft.PowerShell.Commands.TestConnectionCommand+TraceStatus] は 、Success 出力ストリームに出力されます。

パラメーター

-BufferSize

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

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

-Count

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

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

-Delay

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

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

-DontFragment

このパラメーターは、IP ヘッダーに フラグメント化しない フラグを設定します。 このパラメーターを BufferSize パラメーターと共に使用して、パス MTU サイズをテストできます。 パス MTU の詳細については、wikipedia の パス MTU 検出 に関する記事を参照してください。

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

-IPv4

コマンドレットでテストに IPv4 プロトコルを強制的に使用します。

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

-IPv6

コマンドレットでテストに IPv6 プロトコルを強制的に使用します。

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

-MaxHops

ICMP 要求メッセージを送信できるホップの最大数を設定します。 既定値はオペレーティング システムによって制御されます。 Windows 10 以上の既定値は 128 ホップです。

Type:Int32
Aliases:Ttl, TimeToLive, Hops
Position:Named
Default value:128
Accept pipeline input:False
Accept wildcard characters:False

-MtuSize

このパラメーターは、パス MTU サイズを検出するために使用されます。 コマンドレットは、ターゲットへのパス MTU サイズを含む PingReply#MTUSize オブジェクトを返します。 パス MTU の詳細については、wikipedia の パス MTU 検出 に関する記事を参照してください。

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

-Ping

コマンドレットで ping テストを実行します。 これは コマンドレットの既定の Test-Connection モードです。

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

-Quiet

Quiet パラメーターはブール値を返します。 このパラメーターを使用すると、すべてのエラーが抑制されます。

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

特定のターゲットに対 する ping が 成功した場合は、 $True が返されます。

特定のターゲットに対 するすべての ping が失敗した場合は、 $False が返されます。

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

-Repeat

コマンドレットが ping 要求を継続的に送信するようにします。 このパラメーターは Count パラメーターでは使用できません。

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

-ResolveDestination

コマンドレットがターゲットの DNS 名の解決を試みます。 Traceroute パラメーターと組み合わせて使用すると、可能であれば、すべての中間ホストの DNS 名も取得されます。

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

-Source

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

注意

このパラメーターは、PowerShell バージョン 6 以降ではサポートされていません。 このパラメーターを指定すると、エラーが発生します。

Type:String
Position:Named
Default value:Local computer
Accept pipeline input:False
Accept wildcard characters:False

-TargetName

テストするコンピューターを指定します。 コンピューター名を入力するか、IP アドレスを IPv4 または IPv6 形式で入力します。

Type:String[]
Aliases:ComputerName
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-TcpPort

TCP 接続テストで使用するターゲットの TCP ポート番号を指定します。 コマンドレットは、ターゲット上の指定されたポートへの TCP 接続を試行します。

接続できる場合は、 $True が返されます。

接続できない場合は、 $False が返されます。

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

-TimeoutSeconds

テストのタイムアウト値を設定します。 タイムアウトが切れる前に応答が受信されない場合、テストは失敗します。 既定値は 5 秒です。

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

Type:Int32
Position:Named
Default value:5 seconds
Accept pipeline input:False
Accept wildcard characters:False

-Traceroute

コマンドレットでトレース ルート テストを実行します。 このパラメーターを使用すると、 コマンドレットは オブジェクトを TestConnectionCommand+TraceStatus 返します。

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

入力

None

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

出力

TestConnectionCommand+PingStatus

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

TestConnectionCommand+TraceStatus

Traceroute パラメーターを使用すると、このコマンドレットはルートに沿った ping 応答ごとに TestConnectionCommand+TraceStatus オブジェクトを返します。

Boolean

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

TestConnectionCommand+PingMtuStatus

MtuSize パラメーターを使用すると、このコマンドレットは ping 応答ごとに TestConnectionCommand+PingMtuStatus オブジェクトを返します。