Test-Connection

Updated: August 9, 2015

Test-Connection

Sends ICMP echo request packets ("pings") to one or more computers.

Syntax

Parameter Set: Default
Test-Connection [-ComputerName] <String[]> [-AsJob] [-BufferSize <Int32> ] [-Count <Int32> ] [-DcomAuthentication <System.Management.AuthenticationLevel> {Default | None | Connect | Call | Packet | PacketIntegrity | PacketPrivacy | Unchanged} ] [-Delay <Int32> ] [-Impersonation <ImpersonationLevel> {Default | Anonymous | Identify | Impersonate | Delegate} ] [-Protocol <String> {DCOM | WSMan} ] [-ThrottleLimit <Int32> ] [-TimeToLive <Int32> ] [-WsmanAuthentication <String> {Default | Basic | Negotiate | CredSSP | Digest | Kerberos} ] [ <CommonParameters>]

Parameter Set: Quiet
Test-Connection [-ComputerName] <String[]> [-BufferSize <Int32> ] [-Count <Int32> ] [-DcomAuthentication <System.Management.AuthenticationLevel> {Default | None | Connect | Call | Packet | PacketIntegrity | PacketPrivacy | Unchanged} ] [-Delay <Int32> ] [-Impersonation <ImpersonationLevel> {Default | Anonymous | Identify | Impersonate | Delegate} ] [-Protocol <String> {DCOM | WSMan} ] [-Quiet] [-TimeToLive <Int32> ] [-WsmanAuthentication <String> {Default | Basic | Negotiate | CredSSP | Digest | Kerberos} ] [ <CommonParameters>]

Parameter Set: Source
Test-Connection [-ComputerName] <String[]> [-Source] <String[]> [-AsJob] [-BufferSize <Int32> ] [-Count <Int32> ] [-Credential <PSCredential> ] [-DcomAuthentication <System.Management.AuthenticationLevel> {Default | None | Connect | Call | Packet | PacketIntegrity | PacketPrivacy | Unchanged} ] [-Delay <Int32> ] [-Impersonation <ImpersonationLevel> {Default | Anonymous | Identify | Impersonate | Delegate} ] [-Protocol <String> {DCOM | WSMan} ] [-ThrottleLimit <Int32> ] [-TimeToLive <Int32> ] [-WsmanAuthentication <String> {Default | Basic | Negotiate | CredSSP | Digest | Kerberos} ] [ <CommonParameters>]




Detailed Description

The Test-Connection cmdlet sends Internet Control Message Protocol (ICMP) echo request packets, or pings, to one or more remote computers and returns the echo response replies. You can use this cmdlet to determine whether a particular computer can be contacted across an IP network.

You can use the parameters of Test-Connection to specify both the sending and receiving computers, to run the command as a background job, to set a time-out and number of pings, and to configure the connection and authentication.

Unlike the familiar ping command, Test-Connection returns a Win32_PingStatus object that you can investigate in Windows PowerShell. You can use the Quiet parameter to force it to return only a Boolean value.

Parameters

-AsJob

Indicates that this cmdlet runs as a background job.

To use this parameter, the local and remote computers must be configured for remoting and, on Windows Vista and later versions of the Windows operating system, you must open Windows PowerShell by using the Run as administrator option. For more information, see about_Remote_Requirements.

When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from remote computers are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs and about_Remote_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-BufferSize<Int32>

Specifies the size, in bytes, of the buffer sent with this command. The default value is 32.


Aliases

Size,Bytes,BS

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputerName<String[]>

Specifies the computers to ping. Type the computer names or type IP addresses in IPv4 or IPv6 format. Wildcard characters are not permitted. This parameter is required.

This parameter does not rely on Windows PowerShell remoting. You can use the ComputerName parameter even if your computer is not configured to run remote commands.


Aliases

CN,IPAddress,__SERVER,Server,Destination

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Count<Int32>

Specifies the number of echo requests to send. The default value is 4.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Credential<PSCredential>

Specifies a user account that has permission to send a ping request from the source computer. Type a user name, such as User01 or Domain01\User01, or enter a PSCredential object, such as one from the Get-Credential cmdlet.

The Credential parameter is valid only when the Source parameter is used in the command. The credentials do not affect the destination computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DcomAuthentication<System.Management.AuthenticationLevel>

Specifies the authentication level that this cmdlet uses with WMI. Test-Connection uses WMI. The acceptable values for this parameter are:

-- Default. Windows Authentication
-- None. No COM authentication
-- Connect. Connect-level COM authentication
-- Call. Call-level COM authentication
-- Packet . Packet-level COM authentication
-- PacketIntegrity. Packet Integrity-level COM authentication
-- PacketPrivacy. Packet Privacy-level COM authentication
-- Unchanged. Same as the previous command

The default value is Packet.

For more information about the values of this parameter, see AuthenticationLevel Enumeration (http://go.microsoft.com/fwlink/?LinkID=235229) in the Microsoft Developer Library (MSDN).


Aliases

Authentication

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Delay<Int32>

Specifies the interval between pings, in seconds.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Impersonation<ImpersonationLevel>

Specifies the impersonation level to use when this cmdlet calls WMI. Test-Connection uses WMI. The acceptable values for this parameter are:

-- Default. Default impersonation.
-- Anonymous. Hides the identity of the caller.
-- Identify. Allows objects to query the credentials of the caller.
-- Impersonate. Allows objects to use the credentials of the caller.

The default value is Impersonate.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Protocol<String>

Specifies a protocol. The acceptable values for this parameter are: DCOM and WSMan.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Quiet

Indicates that this cmdlet suppresses all errors. If any pings succeed, this cmdlet returns $True. If all pings fail, this cmdlet returns $False.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Source<String[]>

Specifies the names of the computers where the ping originates. Enter a comma-separated list of computer names. The default is the local computer.


Aliases

FCN,SRC

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this parameter or enter a value of 0, the default value, 32, is used.

The throttle limit applies only to the current command, not to the session or to the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TimeToLive<Int32>

Specifies the maximum time, in seconds, that each echo request packet, or ping, is active. Enter an integer between 1 and 255. The default value is 80 (seconds). The alias of the TimeToLive parameter is TTL.


Aliases

TTL

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WsmanAuthentication<String>

Specifies the mechanism that is used to authenticate the user credentials when this cmdlet uses the WSMan protocol. The acceptable values for this parameter are:

-- Basic
-- CredSSP
-- Default
-- Digest
-- Kerberos
-- Negotiate.

The default value is Default.

For more information about the values of this parameter, see AuthenticationMechanism Enumeration (http://go.microsoft.com/fwlink/?LinkID=235230) in the MSDN library.

Caution: Credential Security Service Provider (CredSSP) authentication, in which the user credentials are passed to a remote computer to be authenticated, is designed for commands that require authentication on more than one resource, such as accessing a remote network share. This mechanism increases the security risk of the remote operation. If the remote computer is compromised, the credentials that are passed to it can be used to control the network session.

This parameter was introduced in Windows PowerShell 3.0.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

    You cannot pipe input to this cmdlet.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Management.ManagementObject#root\cimv2\Win32_PingStatus, System.Management.Automation.RemotingJob, System.Boolean

    This cmdlet returns a job object, if you specify the AsJob parameter. If you specify the Quiet parameter, it returns a Boolean. Otherwise, this cmdlet returns a Win32_PingStatus object for each ping.


Notes

  • This cmdlet uses the Win32_PingStatus class. A Get-WMIObject Win32_PingStatus command is equivalent to a Test-Connection command.

  • The Source parameter set was introduced in Windows PowerShell 3.0.

Examples

Example 1: Send echo requests to a remote computer

This command sends echo request packets from the local computer to the Server01 computer. This command uses the ComputerName parameter to specify the Server01 computer, but omits the optional parameter name.


PS C:\>Test-Connection "Server01"

Example 2: Send echo requests to several computers

This command sends pings from the local computer to several remote computers.


PS C:\>Test-Connection -ComputerName "Server01", "Server02", "Server12"

Example 3: Send echo requests from several computers to a computer

This command sends pings from different source computers to a single remote computer, Server01. It uses the Credential parameter to specify the credentials of a user who has permission to send a ping request from the source computers. Use this command format to test the latency of connections from multiple points.


PS C:\>Test-Connection -Source "Server02", "Server12", "localhost" -ComputerName "Server01" -Credential Domain01\Admin01

Example 4: Customize the test command

This command sends three pings from the local computer to the Server01 computer. It uses the parameters of Test-Connection to customize the command.

Use this command format when the ping response is expected to take longer than usual, either because of an extended number of hops or a high-traffic network condition.


PS C:\>Test-Connection -ComputerName "Server01" -Count 3 -Delay 2 -TTL 255 -BufferSize 256 -ThrottleLimit 32

Example 5: Run a test as a background job

This example shows how to run a Test-Connection command as a Windows PowerShell background job.

The first command uses the Test-Connection cmdlet to ping many computers in an enterprise. The value of the ComputerName parameter is a Get-Content command that reads a list of computer names from the Servers.txt file. The command uses the AsJob parameter to run the command as a background job and it saves the job in the $job variable.

The second command checks to see that the job is not still running, and if it is not, it uses a Receive-Job command to get the results and store them in the $Results variable.


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

Example 6: Ping a remote computer with credentials

This command uses the Test-Connection cmdlet to ping a remote computer. The command uses the Credential parameter to specify a user account that has permission to ping the remote computer and the Impersonation parameter to change the impersonation level to Identify.


PS C:\>Test-Connection "Server55" -Credential Domain55\User01 -Impersonation Identify

Example 7: Create a session only if a connection test succeeds

This command creates a session on the Server01 computer only if at least one of the pings sent to the computer succeeds.

The command uses the Test-Connection cmdlet to ping the Server01 computer. The command uses the Quiet parameter, which returns a Boolean value, instead of a Win32_PingStatus object. The value is $True if any of the four pings succeed and is, otherwise, $False.

If the Test-Connection command returns a value of $True, the command uses the New-PSSession cmdlet to create the PSSession.


PS C:\>if (Test-Connection -ComputerName "Server01" -Quiet) {New-PSSession Server01}

Related topics

Community Additions

ADD
Show: