Guide

Bucket hostname

Get-BucketHostname

Suggest Edits

Synopsis

Get hostnames for a property.

Syntax

Get-BucketHostname [-PropertyName] <String> -Network <String> [-GroupID <String>] [-ContractId <String>] [-OffSet <String>] [-Limit <String>] [-Sort <String>] [-HostnameFilter <String>] [-CNAMEToFilter <String>] [-IncludeCertStatus] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-BucketHostname -PropertyID <String> -Network <String> [-GroupID <String>] [-ContractId <String>] [-OffSet <String>] [-Limit <String>] [-Sort <String>] [-HostnameFilter <String>] [-CNAMEToFilter <String>] [-IncludeCertStatus] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets active property hostnames on either the staging or production network. You can filter the results by -HostnameFilter or -CNAMEToFilter. Use the -IncludeCertStatus switch to retrieve the property hostnames with the Secure by Default status.

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

Filters the results by cnameFrom. Supports wildcard matches with *.
‑IncludeCertStatus
Switch Pipeline input: False

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

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

The network to activate on, either STAGING or PRODUCTION.
‑OffSet
String Pipeline input: False

For paginated responses, the page of results you want to navigate to, starting from 0.
‑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.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Sort
String 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.

Related Links

Updated 14 days ago