Edge hostname

New-EdgeHostname

Synopsis

Create a new edge hostname.

Syntax

attributes (Default)

New-EdgeHostname -DomainPrefix <String> -DomainSuffix <String> -IPVersionBehavior <String> -ProductID <String>
 [-SecureNetwork <String>] [-SlotNumber <Int32>] [-CertEnrollmentID <Int32>] -GroupID <String>
 -ContractId <String> [-Options <String>] [-EdgeRCFile <String>] [-Section <String>]
 [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

postbody

New-EdgeHostname -Body <Object> -GroupID <String> -ContractId <String> [-Options <String>]
 [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Description

Creates a new edge hostname on either the amaized.net, edgesuite.net, or edgekey.net domains. If using edgekey.net, you need to provide the certificate enrollment ID to associate the new edge hostname with a certificate slot.

You can retrieve this ID by running the Get-CPSEnrollment operation and filtering the results for your desired certificate.

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: postbody
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-CertEnrollmentID

When creating an Enhanced TLS edge hostname, this sets the certificate enrollment ID. Specify this with SecureNetwork set to ENHANCED_TLS. Enrollment IDs can be retrieved with Get-CPSEnrollment.

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

-ContractId

Unique identifier for the contract. The parameter is optional if a property belongs to only one contract, otherwise you need to specify it along with the GroupID. This parameter is optional except for create requests.

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

-DomainPrefix

The customer-specific namePrefix of an edge hostname, such as www.example.com. As opposed to the Akamai-specific domainSuffix, such as edgesuite.net. The edge hostname's final DNS CNAME combines the two, for example, www.example.com.edgesuite.net.

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

-DomainSuffix

The Akamai-specific portion of the edge hostname, for example, edgesuite.net.

Type: String
Parameter Sets: attributes
Aliases:
Accepted values: akamaized.net, edgesuite.net, edgekey.net

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

-GroupID

Unique identifier for the group. The parameter is optional if a property belongs to only one group, otherwise you need to specify it along with the ContractID. This parameter is optional except for create requests.

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

-IPVersionBehavior

Which version of the IP protocol to use: IPV4 for version 4 only, or IPV6_COMPLIANCE for both 4 and 6. The default value for requests is IPV4.

Type: String
Parameter Sets: attributes
Aliases:
Accepted values: IPV4, IPV6_COMPLIANCE, IPV6_PERFORMANCE

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

-Options

Currently the only supported option is mapDetails that enables extra mapping-related information.

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

-ProductID

Unique identifier for the product.

Type: String
Parameter Sets: attributes
Aliases: None
Required: True
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

-SecureNetwork

Specify the type of security for the new edge hostname.

For STANDARD_TLS, provide a domainSuffix of edgesuite.net.
For SHARED_CERT, provide a domainSuffix of akamaized.net.
For ENHANCED_TLS, provide a certEnrollmentId value along with a domainSuffix of edgekey.net.

Type: String
Parameter Sets: attributes
Aliases:
Accepted values: ENHANCED_TLS, STANDARD_TLS, SHARED_CERT

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

-SlotNumber

Sets the slot number for Enhanced TLS edge hostnames. Slot numbers can be retrieved with Get-CPSEnrollment.

Type: Int32
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