Guide

Edge hostname

Get-EdgeHostname

Suggest Edits

Synopsis

Get an edge hostname.

Syntax

Get-EdgeHostname [-DNSZone <String>] [-ChinaCDNEnabled] [-Comments <String>] [-CustomTarget <String>] [-IsEdgeIPBindingEnabled] [-Map <String>] [-MapAlias <String>] [-RecordNameSubstring <String>] [-SecurityType <String>] [-SlotNumber <Int32>] [-TTL <Int32>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-EdgeHostname [[-EdgeHostnameID] <Int32>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-EdgeHostname -RecordName <String> -DNSZone <String> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all edge hostnames or returns a specific edge hostname by its ID or a combination of its record name and DNS zone.

For an edge hostname of example.com.edgesuite.net, the record name would be example.com and the DNS zone would be edgesuite.net.

When listing all edge hostnames, you can filter the results by various parameters, including -DNSZone, -Map, -SlotNumber, and others.

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.
‑ChinaCDNEnabled
Switch Parameter sets: all Pipeline input: False

Filters by chinaCdnEnabled status.
‑Comments
String Parameter sets: all Pipeline input: False

Filters by comments value.
‑CustomTarget
String Parameter sets: all Pipeline input: False

Filter by customTarget value.
‑DNSZone
Conditionally required
String Parameter sets: single-components, all Pipeline input: False

Filters by dnsZone value.
‑EdgeHostnameID
Int Parameter sets: single-id Pipeline input: False

Your edge hostname's ID.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑IsEdgeIPBindingEnabled
Switch Parameter sets: all Pipeline input: False

Filters by isEdgeIPBindingEnabled status.
‑Map
String Parameter sets: all Pipeline input: False

Filters by map value.
‑MapAlias
String Parameter sets: all Pipeline input: False

Filter by mapAlias value.
‑RecordName
Conditionally required
String Parameter sets: single-components Pipeline input: False

A record name of the edge hostname, identified as the portion of the edge hostname before the Akamai domain, for example, edgesuite.net.
‑RecordNameSubstring
String Parameter sets: all Pipeline input: False

Filters by domain prefix substring.
‑Section
String Pipeline input: False

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

Filters by securityType value, either STANDARD-TLS or ENHANCED-TLS.
‑SlotNumber
Int Parameter sets: all Pipeline input: False

Filters by slotNumber value.
‑TTL
Int Parameter sets: all Pipeline input: False

Filters by ttl setting, in seconds.

Related Links

Updated 4 months ago