Guide

Property hostname

Get-PropertyHostname

Suggest Edits

Synopsis

Get hostnames for a property version.

Syntax

Get-PropertyHostname [-Offset <Int32>] [-Limit <Int32>] [-Sort <String>] [-Hostname <String>] [-CnameTo <String>] [-Network <String>] [-GroupID <String>] [-ContractId <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

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

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

Description

Gets all hostnames for an entire account, or a specified property version. You can specify a property by its name, ID, or version. The -PropertyVersion parameter is either an integer or the word latest.

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.
‑CnameTo
String Parameter sets: all Pipeline input: False

Filters the results by edge hostname. Supports wildcard matches with *.
‑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.
‑Hostname
String Parameter sets: all Pipeline input: False

The cnameFrom for the hostname your end users see, indicated by the Host header in the end-user requests.
‑IncludeCertStatus
Switch Parameter sets: single-id, single-name Pipeline input: False

When enabled, the response includes the certificate status for the hostname on staging and production networks.
‑Limit
Int Parameter sets: all Pipeline input: False

For paginated responses, the number of hostnames objects to include on each page.
‑Network
String Accepted values: PRODUCTION, STAGING Parameter sets: all Pipeline input: False

The network to activate on, either STAGING or PRODUCTION.
‑Offset
Int Parameter sets: all Pipeline input: False

For paginated responses, the page of results you want to navigate to, starting from 0.
‑PropertyID
Conditionally required
String Parameter sets: single-id Pipeline input: False

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

A human-readable name for your property. Commonly, you only need to specify either -PropertyName or -PropertyID.
‑PropertyVersion
Conditionally required
String Parameter sets: single-id, single-name 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.
‑Sort
String Accepted values: hostname:a, hostname:d Parameter sets: all Pipeline input: False

Sorts the results based on the cnameFrom value, either hostname:a for ascending or hostname:d for descending order. The default is hostname:a.
‑ValidateHostnames
Switch Parameter sets: single-id, single-name 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 27 days ago