MTR request

New-EdgeDiagnosticsMTR

Synopsis

Test network connectivity with MTR.

Syntax

attributes (Default)

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>]

body

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, you need to 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

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account switch keys can be found using Get-AccountSwitchKey.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Body

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

Type: Object
Parameter Sets: body
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Destination

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.

Type: String
Parameter Sets: attributes
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DestinationType

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

Type: String
Parameter Sets: attributes
Aliases:
Accepted values: IP, HOST

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PacketType

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

Type: String
Parameter Sets: attributes
Aliases:
Accepted values: ICMP, TCP

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Port

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

Type: Int32
Parameter Sets: attributes
Aliases:
Accepted values: 80, 443

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResolveDNS

Resolves DNS for each hop.

Type: SwitchParameter
Parameter Sets: attributes
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ShowIPs

Shows IPs for each hop.

Type: SwitchParameter
Parameter Sets: attributes
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ShowLocations

Shows locations for each hop.

Type: SwitchParameter
Parameter Sets: attributes
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-SiteShieldHostname

Site Shield hostname you want to run the MTR for.

Type: String
Parameter Sets: attributes
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Source

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.

Type: String
Parameter Sets: attributes
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourceType

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

Type: String
Parameter Sets: attributes
Aliases:
Accepted values: EDGE_IP, LOCATION

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.Object

Outputs