Synopsis
Remove hostnames from a property's hostname bucket.
Syntax
name (Default)
Remove-BucketHostname [-PropertyName] <String> -Network <String> -HostnamesToRemove <String>
[-GroupID <String>] [-ContractId <String>] [-IncludeCertStatus] [-ValidateHostnames] [-EdgeRCFile <String>]
[-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
id
Remove-BucketHostname -PropertyID <String> -Network <String> -HostnamesToRemove <String> [-GroupID <String>]
[-ContractId <String>] [-IncludeCertStatus] [-ValidateHostnames] [-EdgeRCFile <String>] [-Section <String>]
[-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Removes hostnames from a property's hostname bucket.
The property version you provide needs to be INACTIVE
on both the production and staging networks.
The operation applies to a property with the useHostnameBucket
switch enabled.
> Note: When removing hostnames, you don't need to specify more than the hostname itself.
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
-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
-HostnamesToRemove
Array of hostnames to be removed.
Only the actual hostname is required when removing.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
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: (All)
Aliases: None
Required: False
Position: Named
Default value: False
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: STAGING, PRODUCTION
Required: True
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: 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: name
Aliases: None
Required: True
Position: 0
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
-ValidateHostnames
Run validation tests that would identify potential hostname-related problems within the response object's errors
and warnings
arrays.
Type: SwitchParameter
Parameter Sets: (All)
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