Synopsis
Run the URL health check.
Syntax
attributes (Default)
New-EdgeDiagnosticsURLHealthCheck -URL <String> [-EdgeLocationID <String>] [-IPVersion <String>]
[-PacketType <String>] [-Port <Int32>] [-QueryType <String>] [-RequestHeaders <String>] [-RunFromSiteshield]
[-SensitiveRequestHeaderKeys <String>] [-SpoofEdgeIP <String>] [-ViewsAllowed <String>] [-EdgeRCFile <String>]
[-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
body
New-EdgeDiagnosticsURLHealthCheck -Body <Object> [-EdgeRCFile <String>] [-Section <String>]
[-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Launches an asynchronous request to run in parallel the New-EdgeDiagnosticsGrep
, New-EdgeDiagnosticsDig
, New-EdgeDiagnosticsCurl
, New-EdgeDiagnosticsMTR
, and Get-EdgeDiagnosticsURLTranslation
operations for a URL.
Operations with the executionStatus
of SUCCESS
return the fetched GREP, DIG, cURL, and MTR data as well as Akamaized URL (ARL) (https://techdocs.akamai.com/edge-diagnostics/docs/arl-Syntax)details.
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
-EdgeLocationID
Unique identifier for an edge server location closest to end users experiencing issues with the URL.
Type: String
Parameter Sets: attributes
Aliases: None
Required: False
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
-IPVersion
IP version for the Connectivity problems scenario to use to run cURL and MTR commands, either IPV4
or IPV6
.
Type: String
Parameter Sets: attributes
Aliases:
Accepted values: IPV4, IPV6
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: TCP, ICMP
Required: False
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
-QueryType
DNS record type you want to get.
Possible values are: A
, AAAA
, SOA
, CNAME
, PTR
, MX
, NS
, TXT
, SRV
, CAA
, or ANY
.
Type: String
Parameter Sets: attributes
Aliases:
Accepted values: A, AAAA, SOA, CNAME, PTR, MX, NS, TXT, SRV, CAA, ANY
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequestHeaders
Customized headers for the curl
request in the format header: value
.
The request includes Akamai Pragma headers by default.
Type: String
Parameter Sets: attributes
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RunFromSiteshield
Runs Connectivity problems from a Site Shield map.
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
-SensitiveRequestHeaderKeys
Sensitive requestHeaders
you don't want to store in the database after running the request.
Type: String
Parameter Sets: attributes
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SpoofEdgeIP
IP of the edge server you want to serve traffic from.
Type: String
Parameter Sets: attributes
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-URL
Fully qualified URL you want to get the error statistics for.
You need to provide either this value or CPCode.
Type: String
Parameter Sets: attributes
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ViewsAllowed
Additional operations for the URL health check to run.
CONNECTIVITY
runs New-EdgeDiagnosticsMTR and LOGS
runs Get-EdgeDiagnosticsLogs.
Type: String
Parameter Sets: attributes
Aliases: None
Required: False
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
System.Object