Guide

URL health check

New-EdgeDiagnosticsURLHealthCheck

Suggest Edits

Synopsis

Run the URL health check.

Syntax

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

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) details.

Parameters

‑AccountSwitchKey
String Pipeline 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
Object Parameter sets: body Pipeline input: ByValue

Request body, either as a PSCustomObject or string. This parameter supports pipelining.
‑EdgeLocationID
String Parameter sets: attributes Pipeline input: False

The ID of an edge server location closest to end users experiencing issues with the URL.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑IPVersion
String Accepted values: IPV4, IPV6 Parameter sets: attributes Pipeline input: False

The IP version for the Connectivity problems scenario to use to run cURL and MTR commands, either IPV4 or IPV6.
‑PacketType
String Accepted values: TCP, ICMP Parameter sets: attributes Pipeline input: False

The packet type for the Connectivity problems scenario to use to run MTR, either ICMP or TCP.
‑Port
Int Accepted values: 80, 443 Parameter sets: attributes Pipeline input: False

The port number for the Connectivity problems scenario to use to run MTR, either 80 or 443.
‑QueryType
String Accepted values: A, AAAA, SOA, CNAME, PTR, MX, NS, TXT, SRV, CAA, ANY Parameter sets: attributes Pipeline input: False

The DNS record type you want to get. Possible values are: A, AAAA, SOA, CNAME, PTR, MX, NS, TXT, SRV, CAA, or ANY.
‑RequestHeaders
String Parameter sets: attributes Pipeline input: False

Customized headers for the curl request in the format header: value. The request includes Akamai Pragma headers by default.
‑RunFromSiteshield
Switch Parameter sets: attributes Pipeline input: False

Runs Connectivity problems from a Site Shield map.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑SensitiveRequestHeaderKeys
String Parameter sets: attributes Pipeline input: False

Sensitive requestHeaders you don't want to store in the database after running the request.
‑SpoofEdgeIP
String Parameter sets: attributes Pipeline input: False

The IP of the edge server you want to serve traffic from.
‑URL
Conditionally required
String Parameter sets: attributes Pipeline input: False

A fully qualified URL you want to get the error statistics for. You need to provide either this value or a -CPCode.
‑ViewsAllowed
String Parameter sets: attributes Pipeline input: False

Additional operations for the URL health check to run. CONNECTIVITY runs New-EdgeDiagnosticsMTR and LOGS runs Get-EdgeDiagnosticsLogs.

Related Links

Updated 11 days ago