Bucket hostname

Add-BucketHostname

Synopsis

Add hostnames to a property's hostname bucket.

Syntax

Add-BucketHostname [-PropertyName] <String> -Network <String> -NewHostnames <Object[]> [-GroupID <String>] [-ContractId <String>] [-IncludeCertStatus] [-ValidateHostnames] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Add-BucketHostname -PropertyID <String> -Network <String> -NewHostnames <Object[]> [-GroupID <String>] [-ContractId <String>] [-IncludeCertStatus] [-ValidateHostnames] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Adds hostnames to a property's hostname bucket. Each Hostname object you provide in this operation needs to be made up of the certProvisioningType, cnameFrom (the hostname itself), cnameType (always EDGE_HOSTNAME), and edgeHostnameId.

Parameters

‑AccountSwitchKey

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.

‑ContractId

Your contract's ID. 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 the create requests.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑GroupID

Your group's ID. 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 the create requests.

‑IncludeCertStatus

When enabled, the response includes the certificate status for the hostname on staging and production networks.

‑Network
Required

The network to activate on, either STAGING or PRODUCTION.

‑NewHostnames
Required

An array of hostnames to be added. Each entry needs to contain these members: cnameFrom, cnameType, edgeHostnameId, and certProvisioningType.

‑PropertyID
Conditionally required

Your property's ID. Commonly, you only need to specify either -PropertyName or -PropertyID.

‑PropertyName
Conditionally required

A human-readable name for your property. Commonly, you only need to specify either -PropertyName or -PropertyID.

‑Section

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

‑ValidateHostnames

When enabled, runs validation tests that would identify potential hostname-related problems within the response object's errors and warnings arrays.

Related Links