Get-Trace Cmdlet

Parameters   Output Objects   Configuration Settings  

The Get-Trace component allows you to trace the path IP packets take on the Internet.

Syntax

Get-Trace [parameters]

Remarks

This cmdlet implements a standard IP Traceroute as defined in RFC 1393.

To make a trace with the cmdlet, set the Server to the domain name or IP address of the host you want to trace the path to. Each hop of the trace will be returned in a Hop object.

The Resolve switch enables DNS resolution of each IP addresses received during the trace. If it is not set, only IP addresses are provided. When set, the cmdlet will attempt to resolve the names of the hosts in the route. This may considerably increase the time it takes to complete the trace.

The HopTimeout parameter determines the maximum amount of time to wait, in seconds, for a response in each hop of the trace. HopLimit specifies the maximum number of hops allowed for a trace.

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.


# trace a domain
get-trace ncsu.edu
# an example where hoplimit is necessary
get-trace www.microsoft.com -hoplimit 15

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.
HopLimitThe maximum number of hops to allow for a trace.
HopTimeoutThe timeout for each hop.
LocalIPThe IP address of the local interface to bind with.
LogFileThe location of a file to which debug information is written.
ResolveIndicates whether or not to resolve the host IP addresses to host names for each hop.
ServerThe address of the Server.
TimeoutThe maximum time allowed for the operation.

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.

HopObject created for each hop in the trace to Server .

Configuration Settings


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

HopTimeoutInMillisecondsThe hop timeout is treated as milliseconds.
TimeoutInMillisecondsThe timeout is treated as milliseconds.
DontFragmentWhether the DontFragment control flag is set.
IcmpDllTimeoutThe timeout for the component 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.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

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