Send-Ping Cmdlet

Parameters   Output Objects   Configuration Settings  

The Send-Ping cmdlet encapsulates ICMP ECHO functionality, used to check whether there is a communications link between two computers.

Syntax

Send-Ping [parameters]

Remarks

This cmdlet will send an ICMP echo request packet to the remote host indicated by Server. The results of the ping will be returned in a PingResponse object.

The cmdlet operates synchronously by default (waits for a response before returning control to the caller), however, the cmdlet may also operate asynchronously (return control immediately), by setting Timeout to 0.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.


# send a ping
send-ping -server microsoft.com
# send 5 pings
send-ping -server nsoftware.com -count 5

Parameter List


The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.

LogFileThe location of a file to which debug information is written.
ConfigSpecifies one or more configuration settings.
CountThe number of packets to send to the remote host.
LocalIPThe IP address of the local interface to use.
LogFileThe location of a file to which debug information is written.
PacketSizeThe size of the packet to be sent.
ServerThe address of the Server.
TimeoutThe maximum time allowed for the operation.
TimeToLiveThe time to live (TTL) value for the ICMP packets sent by the cmdlet.
TypeOfServiceThe type of the ICMP message sent as a ping request.

Output Objects


The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.

PingResponseObject returned in response to a Ping request.

Configuration Settings


The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.

TimeoutInMillisecondsThe timeout is treated as milliseconds.
DontFragmentWhether the DontFragment control flag is set.
IcmpDllTimeoutThe timeout for the cmdlet when using the icmp.dll.
MaxMessageSizeThe maximum length of the messages that can be received.
MulticastTTLThe time to live (TTL) value for multicast ICMP packets sent by the component.
ReceiveAllModeEnables a socket to receive all IPv4 or IPv6 packets on the network.
TimeoutInMillisecondsThe timeout is treated as milliseconds.
UseConnectionDetermines whether to use a connected socket.
UseICMPDLLUse the icmp.dll included on Windows Systems.
UseIPHLPDLLUse the iphlpapi.dll included on Windows Systems.
UseIPv6Whether to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
UseInternalSecurityAPITells the cmdlet whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
NetCmdlets 2020 - Version 20.0 [Build 7877]