Get-Trace Cmdlet
Parameters Output Objects Configuration Settings
The Get-Trace cmdlet 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 domainget-trace ncsu.edu# an example where hoplimit is necessaryget-trace www.microsoft.com -hoplimit 15Parameter List
The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.
| LogFile | The location of a file to which debug information is written. |
| Config | Specifies one or more configuration settings. |
| HopLimit | The maximum number of hops to allow for a trace. |
| HopTimeout | The timeout for each hop. |
| LocalIP | The IP address of the local interface to bind with. |
| LogFile | The location of a file to which debug information is written. |
| Resolve | Indicates whether or not to resolve the host IP addresses to host names for each hop. |
| Server | The address of the Server. |
| Timeout | The 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.
| Hop | Object 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.
| HopTimeoutInMilliseconds | The hop timeout is treated as milliseconds. |
| TimeoutInMilliseconds | The timeout is treated as milliseconds. |
| IcmpDllTimeout | The timeout for the cmdlet when using the icmp.dll. |
| MaxMessageSize | The maximum length of the messages that can be received. |
| MulticastTTL | The time to live (TTL) value for multicast ICMP packets sent by the component. |
| ReceiveAllMode | Enables a socket to receive all IPv4 or IPv6 packets on the network. |
| TimeoutInMilliseconds | The timeout is treated as milliseconds. |
| UseConnection | Determines whether to use a connected socket. |
| UseICMPDLL | Use the icmp.dll included on Windows Systems. |
| UseIPHLPDLL | Use the iphlpapi.dll included on Windows Systems. |
| UseIPv6 | Whether to use IPv6. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| UseBackgroundThread | Whether threads created by the cmdlet are background threads. |
| UseInternalSecurityAPI | Tells the cmdlet whether or not to use the system security libraries or an internal implementation. |