Property hostname

Set-PropertyHostname

Synopsis

Update hostnames for a property version.

Syntax

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

Description

Updates the list of hostnames that apply to a specific property version. You can retrieve the existing hostnames with the Get-PropertyHostname operation.

Note: Running this function replaces all hostnames on the specified property. To add or remove hostnames (without affecting existing hostnames), run the Add-PropertyHostname or Remove-PropertyHostname operation.

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.

‑Body
Required

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.

‑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.

‑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.

‑PropertyVersion
Required

Property's incremental version number. Can be an integer or the word latest.

‑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