Guide
  1. Edge Diagnostics
  2. New

MTR request

Synopsis

Test network connectivity with MTR.

Syntax

New-EdgeDiagnosticsMTR -Destination <String> -DestinationType <String> -PacketType <String> [-Port <Int32>] [-ResolveDNS] [-ShowIPs] [-ShowLocations] [-SiteShieldHostname <String>] -Source <String> -SourceType <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-EdgeDiagnosticsMTR -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Using MTR provides information about packet loss and latency between an edge server IP and a location or between a Site Shield map and a remote destination.

To run this operation for an IP, run the Test-EdgeDiagnosticsIP operation first to verify if it belongs to an edge server.

To run this operation for a GTM hostname, run the Get-EdgeDiagnosticsGTMProperties and Get-EdgeDiagnosticsGTMPropertyIPs operations first to get the test and target IPs for the hostname.

Parameters

‑AccountSwitchKey
StringPipeline input: False

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.

‑Body
Conditionally required
ObjectParameter sets: bodyPipeline input: ByValue

Request body, either as a PSCustomObject or string. This parameter supports pipelining.

‑Destination
Conditionally required
StringParameter sets: AttributesPipeline input: False

An MTR destination compliant with the destinationType, either a hostname or a destination IP.

To build an object for a GTM hostname, enter the target value returned by the List test and target IPs for a GTM hostname operation.

For a Site Shield hostname, enter a destination IP address.

‑DestinationType
Conditionally required
StringAccepted values: IP, HOSTParameter sets: AttributesPipeline input: False

The type of destination input, either IP or HOST. To build an object for a GTM or Site Shield hostname, choose IP.

‑EdgeRCFile
StringPipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑PacketType
Conditionally required
StringAccepted values: ICMP, TCPParameter sets: AttributesPipeline input: False

The packet type for the Connectivity problems scenario to use to run MTR, either ICMP or TCP.

‑Port
Int32Accepted values: 80, 443Parameter sets: AttributesPipeline input: False

The port number for the Connectivity problems scenario to use to run MTR, either 80 or 443.

‑ResolveDNS
SwitchParameter sets: AttributesPipeline input: False

Resolves DNS for each hop.

‑Section
StringPipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

‑ShowIPs
SwitchParameter sets: AttributesPipeline input: False

Shows IPs for each hop.

‑ShowLocations
SwitchParameter sets: AttributesPipeline input: False

Shows locations for each hop.

‑SiteShieldHostname
StringParameter sets: AttributesPipeline input: False

The Site Shield hostname you want to run the MTR for.

‑Source
Conditionally required
StringParameter sets: AttributesPipeline input: False

An MTR source compliant with the sourceType, either an edge server IP or a location.

For locations, enter edgeLocationId for an edge server location closest to your end users. To get this value, run Get-EdgeDiagnosticsLocations first.

For edge IPs, use the edge server IP value from the answerSection array in the New-EdgeDiagnosticsDig response.

To build an object for a GTM hostname, enter the testIp value returned by Get-EdgeDiagnosticsGTMPropertyIPs.

‑SourceType
Conditionally required
StringAccepted values: EDGE_IP, LOCATIONParameter sets: AttributesPipeline input: False

Type of the source input, either EDGE_IP or LOCATION. To build an object for a GTM hostname, choose EDGE_IP.

Related Links