Edge hostname

Get-EdgeHostname

Synopsis

Get an edge hostname.

Syntax

all (Default)

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

single-id

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

single-components

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

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run the Get-AccountSwitchKey command to list the account switch keys available to you.

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

-ChinaCDNEnabled

Filter by chinaCdnEnabled status.

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

-Comments

Filter by comments value.

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

-CustomTarget

Filter by customTarget value.

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

-DNSZone

Filter by dnsZone value.

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

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

-EdgeHostnameID

Unique identifier for an edge hostname.

Type: Int32
Parameter Sets: single-id
Aliases: None
Required: False
Position: 0
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

-IsEdgeIPBindingEnabled

Filter by isEdgeIPBindingEnabled status.

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

-Map

Filter by map value.

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

-MapAlias

Filter by mapAlias value.

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

-RecordName

Record name of the edge hostname, identified as the portion of the edge hostname before the Akamai domain, for example, edgesuite.net.

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

-RecordNameSubstring

Filter by domain prefix substring.

Type: String
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
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

-SecurityType

Filter by securityType value, either STANDARD-TLS or ENHANCED-TLS.

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

-SlotNumber

Filter by slotNumber value.

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

-TTL

Filter by ttl setting, in seconds.

Type: Int32
Parameter Sets: all
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

None

Outputs

System.Object