Property hostname

Get-PropertyHostname

Synopsis

Get hostnames for a property version.

Syntax

all (Default)

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>]

single-name

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

single-id

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

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account switch keys can be found using Get-AccountSwitchKey.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CnameTo

Filter the results by edge hostname. Supports wildcard matches with *.

Type: String
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ContractId

Unique identifier for the contract. 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 create requests.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-GroupID

Unique identifier for the group. 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 create requests.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Hostname

The cnameFrom for the hostname your end users see, indicated by the Host header in end user requests.

Type: String
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IncludeCertStatus

Whether the response should include the certificate status for the hostname on staging and production networks.

Type: SwitchParameter
Parameter Sets: single-name, single-id
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Limit

For paginated responses, specifies the number of hostnames objects to include on each page.

Type: Int32
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Network

The network to activate on, either STAGING or PRODUCTION.

Type: String
Parameter Sets: all
Aliases:
Accepted values: PRODUCTION, STAGING

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Offset

For paginated responses, specifies the page of results you want to navigate to, starting from 0.

Type: Int32
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PropertyID

Unique identifier for the property. Commonly you only need to specify one of: PropertyName, PropertyID.

Type: String
Parameter Sets: single-id
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PropertyName

Name of your property. Commonly you only need to specify one of: PropertyName, PropertyID.

Type: String
Parameter Sets: single-name
Aliases: None
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PropertyVersion

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

Type: String
Parameter Sets: single-name, single-id
Aliases: None
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Sort

Sort the results based on the cnameFrom value, either hostname:a for ascending or hostname:d for descending order. The default is hostname:a.

Type: String
Parameter Sets: all
Aliases:
Accepted values: hostname:a, hostname:d

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ValidateHostnames

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

Type: SwitchParameter
Parameter Sets: single-name, single-id
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object