TestConnectionCommand Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

Microsoft.PowerShell.Commands.Management.dll

Package:

Microsoft.PowerShell.Commands.Management v7.4.0

The implementation of the "Test-Connection" cmdlet.

[System.Management.Automation.Cmdlet("Test", "Connection", DefaultParameterSetName="DefaultPing", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2097144")]
[System.Management.Automation.OutputType(typeof(Microsoft.PowerShell.Commands.TestConnectionCommand+PingStatus), ParameterSetName=new System.String[] { "DefaultPing" })]
[System.Management.Automation.OutputType(typeof(Microsoft.PowerShell.Commands.TestConnectionCommand+PingStatus), ParameterSetName=new System.String[] { "RepeatPing", "MtuSizeDetect" })]
[System.Management.Automation.OutputType(typeof(System.Boolean), ParameterSetName=new System.String[] { "DefaultPing", "RepeatPing", "TcpPort" })]
[System.Management.Automation.OutputType(typeof(Microsoft.PowerShell.Commands.TestConnectionCommand+PingMtuStatus), ParameterSetName=new System.String[] { "MtuSizeDetect" })]
[System.Management.Automation.OutputType(typeof(System.Int32), ParameterSetName=new System.String[] { "MtuSizeDetect" })]
[System.Management.Automation.OutputType(typeof(Microsoft.PowerShell.Commands.TestConnectionCommand+TraceStatus), ParameterSetName=new System.String[] { "TraceRoute" })]
[System.Management.Automation.OutputType(typeof(Microsoft.PowerShell.Commands.TestConnectionCommand+TcpPortStatus), ParameterSetName=new System.String[] { "TcpPort" })]
[System.Runtime.CompilerServices.Nullable(0)]
[System.Runtime.CompilerServices.NullableContext(1)]
public class TestConnectionCommand : System.Management.Automation.PSCmdlet, IDisposable

[<System.Management.Automation.Cmdlet("Test", "Connection", DefaultParameterSetName="DefaultPing", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2097144")>]
[<System.Management.Automation.OutputType(typeof(Microsoft.PowerShell.Commands.TestConnectionCommand+PingStatus), ParameterSetName=new System.String[] { "DefaultPing" })>]
[<System.Management.Automation.OutputType(typeof(Microsoft.PowerShell.Commands.TestConnectionCommand+PingStatus), ParameterSetName=new System.String[] { "RepeatPing", "MtuSizeDetect" })>]
[<System.Management.Automation.OutputType(typeof(System.Boolean), ParameterSetName=new System.String[] { "DefaultPing", "RepeatPing", "TcpPort" })>]
[<System.Management.Automation.OutputType(typeof(Microsoft.PowerShell.Commands.TestConnectionCommand+PingMtuStatus), ParameterSetName=new System.String[] { "MtuSizeDetect" })>]
[<System.Management.Automation.OutputType(typeof(System.Int32), ParameterSetName=new System.String[] { "MtuSizeDetect" })>]
[<System.Management.Automation.OutputType(typeof(Microsoft.PowerShell.Commands.TestConnectionCommand+TraceStatus), ParameterSetName=new System.String[] { "TraceRoute" })>]
[<System.Management.Automation.OutputType(typeof(Microsoft.PowerShell.Commands.TestConnectionCommand+TcpPortStatus), ParameterSetName=new System.String[] { "TcpPort" })>]
[<System.Runtime.CompilerServices.Nullable(0)>]
[<System.Runtime.CompilerServices.NullableContext(1)>]
type TestConnectionCommand = class
    inherit PSCmdlet
    interface IDisposable

Public Class TestConnectionCommand
Inherits PSCmdlet
Implements IDisposable

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

TestConnectionCommand

Attributes

CmdletAttribute OutputTypeAttribute NullableAttribute NullableContextAttribute

Implements

IDisposable

Constructors

TestConnectionCommand()

Fields

Detailed

Gets or sets whether to enable detailed output mode while running a TCP connection test. Without this flag, the TCP test will return a boolean result.

Properties

BufferSize	Gets or sets the buffer size to send with the ping packet. The default (from Windows) is 32 bytes. Max value is 65500 (limitation imposed by Windows API).
CommandOrigin	This property tells you if you were being invoked inside the runspace or if it was an external request. (Inherited from InternalCommand)
CommandRuntime	Holds the command runtime object for this command. This object controls what actually happens when a write is called. (Inherited from Cmdlet)
Count	Gets or sets the number of ping attempts. The default (from Windows) is 4 times.
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet)
Delay	Gets or sets the delay between ping attempts. The default (from Windows) is 1 second.
DontFragment	Gets or sets whether to prevent fragmentation of the ICMP packets. Currently CoreFX not supports this on Unix.
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
InvokeCommand	Provides access to utility routines for executing scripts and creating script blocks. (Inherited from PSCmdlet)
InvokeProvider	Gets the instance of the provider interface APIs for the current runspace. (Inherited from PSCmdlet)
IPv4	Gets or sets whether to force use of IPv4 protocol.
IPv6	Gets or sets whether to force use of IPv6 protocol.
JobManager	Manager for JobSourceAdapters registered. (Inherited from PSCmdlet)
JobRepository	Repository for jobs. (Inherited from PSCmdlet)
MaxHops	Gets or sets the number of times the Ping data packets can be forwarded by routers. As gateways and routers transmit packets through a network, they decrement the Time-to-Live (TTL) value found in the packet header. The default (from Windows) is 128 hops.
MtuSize	Gets or sets whether to detect Maximum Transmission Unit size. When selected, only a single ping result is returned, indicating the maximum buffer size the route to the destination can support without fragmenting the ICMP packets.
MyInvocation	Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet)
PagingParameters	If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters. Otherwise PagingParameters property is null. (Inherited from PSCmdlet)
ParameterSetName	The name of the parameter set in effect. (Inherited from PSCmdlet)
Ping	Gets or sets whether to do ping test. Default is true.
Quiet	Gets or sets whether to enable quiet output mode, reducing output to a single simple value only. By default, PingStatus, PingMtuStatus, or TraceStatus objects are emitted. With this switch, standard ping and -Traceroute returns only true / false, and -MtuSize returns an integer.
Repeat	Gets or sets whether to continue pinging until user presses Ctrl-C (or Int.MaxValue threshold reached).
ResolveDestination	Gets or sets whether to do reverse DNS lookup to get names for IP addresses.
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
Source	Gets the source from which to run the selected test. The default is localhost. Remoting is not yet implemented internally in the cmdlet.
Stopping	Is this command stopping? (Inherited from Cmdlet)
TargetName	Gets or sets the destination hostname or IP address.
TcpPort	Gets or sets whether to perform a TCP connection test.
TimeoutSeconds	Gets or sets the timeout value for an individual ping in seconds. If a response is not received in this time, no response is assumed. The default (from Windows) is 5 seconds.
Traceroute	Gets or sets whether to perform a traceroute test.

Methods

BeginProcessing()	BeginProcessing implementation for TestConnectionCommand. Sets Count for different types of tests unless specified explicitly.
CurrentProviderLocation(String)	(Inherited from PSCmdlet)
Dispose()	IDisposable implementation, dispose of any disposable resources created by the cmdlet.
Dispose(Boolean)	Implementation of IDisposable for both manual Dispose() and finalizer-called disposal of resources.
EndProcessing()	When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
Finalize()	Finalizes an instance of the TestConnectionCommand class.
GetResolvedProviderPathFromPSPath(String, ProviderInfo)	(Inherited from PSCmdlet)
GetResourceString(String, String)	Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior. (Inherited from Cmdlet)
GetUnresolvedProviderPathFromPSPath(String)	(Inherited from PSCmdlet)
GetVariableValue(String)	(Inherited from PSCmdlet)
GetVariableValue(String, Object)	(Inherited from PSCmdlet)
Invoke()	Invoke this cmdlet object returning a collection of results. (Inherited from Cmdlet)
Invoke<T>()	Returns a strongly-typed enumerator for the results of this cmdlet. (Inherited from Cmdlet)
ProcessRecord()	Process a connection test.
ShouldContinue(String, String)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldProcess(String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. (Inherited from Cmdlet)
ShouldProcess(String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action. (Inherited from Cmdlet)
ShouldProcess(String, String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
StopProcessing()	On receiving the StopProcessing() request, the cmdlet will immediately cancel any in-progress ping request. This allows a cancellation to occur during a ping request without having to wait for the timeout.
ThrowTerminatingError(ErrorRecord)	Terminate the command and report an error. (Inherited from Cmdlet)
TransactionAvailable()	Returns true if a transaction is available and active. (Inherited from Cmdlet)
WriteCommandDetail(String)	Write text into pipeline execution log. (Inherited from Cmdlet)
WriteDebug(String)	Display debug information. (Inherited from Cmdlet)
WriteError(ErrorRecord)	Internal variant: Writes the specified error to the error pipe. (Inherited from Cmdlet)
WriteInformation(InformationRecord)	Route information to the user or host. (Inherited from Cmdlet)
WriteInformation(Object, String[])	Route information to the user or host. (Inherited from Cmdlet)
WriteObject(Object)	Writes the object to the output pipe. (Inherited from Cmdlet)
WriteObject(Object, Boolean)	Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually. (Inherited from Cmdlet)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)