Remove-Host
SYNOPSIS
Removes a PowerStore host.
SYNTAX
ByName (Default)
Remove-Host [-Cluster] <Cluster> [-Name] <String[]> [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
ById
Remove-Host [-Cluster] <Cluster> -Id <String[]> [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Removes a PowerStore host.
EXAMPLES
Example 1
PS C:\> Remove-Host -Cluster $cluster -Name name1
Where $cluster is a PowerStore cluster instance. Removes the host named name1.
Example 2
PS C:\> Remove-Host -Cluster $cluster -Id uuid1
Where $cluster is a PowerStore cluster instance. Removes the host with Id uuid1.
PARAMETERS
-Cluster
A PowerStore cluster instance.
Type: Cluster
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
Host name.
Type: String[]
Parameter Sets: ByName
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Id
Host Id.
Type: String[]
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Force
Suppress confirmation prompt before removing the host.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Returns the host instances that were removed.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
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.