Guide

Property hostname

Add-PropertyHostname

Suggest Edits

Synopsis

Add hostnames to a property version.

Syntax

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

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

Description

Adds one or more hostnames to a property version. The -PropertyVersion you provide in this operation needs to be INACTIVE on both the production and staging networks. To see the format of hostnames to add, it's recommended that you run the Get-PropertyHostname operation and clone the object from the returned data.

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.
‑ContractId
String Pipeline input: False

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
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GroupID
String Pipeline input: False

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
Switch Pipeline input: False

When enabled, the response includes the certificate status for the hostname on staging and production networks.
‑NewHostnames
Required
Object[] Pipeline input: ByValue

An array of hostnames to be added. Each entry needs to contain these members: cnameFrom, cnameType, edgeHostnameId, and certProvisioningType.
‑PropertyID
Conditionally required
String Parameter sets: id Pipeline input: False

Your property's ID. Commonly, you only need to specify either -PropertyName or -PropertyID.
‑PropertyName
Conditionally required
String Parameter sets: name Pipeline input: False

A human-readable name for your property. Commonly, you only need to specify either -PropertyName or -PropertyID.
‑PropertyVersion
Required
String Pipeline input: False

Property's incremental version number. Can be an integer or the word latest.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑ValidateHostnames
Switch Pipeline input: False

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

Related Links

Updated 4 months ago