Remove-VolumeGroup
SYNOPSIS
Removes a volume group.
SYNTAX
ByName (Default)
Remove-VolumeGroup [-Cluster] <Cluster> [-Name] <String[]> [-DeleteMembers] [-Confirm] [-Force] [-PassThru] [-WhatIf]
[<CommonParameters>]
ById
Remove-VolumeGroup [-Cluster] <Cluster> -Id <String[]> [-DeleteMembers] [-Confirm] [-Force] [-PassThru] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
Removes a volume group and optionally removes member volumes.
EXAMPLES
Example 1
PS C:\> Remove-VolumeGroup -Cluster $cluster -Name volumegroup1
Where $cluster is a PowerStore cluster instance. Removes the volume group named volumegroup1. Member volumes are preserved.
Example 1
PS C:\> Remove-VolumeGroup -Cluster $cluster -Id uuid1 -DeleteMembers
Where $cluster is a PowerStore cluster instance. Removes the volume group with Id uuid1. Member volumes are removed.
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
Volume group 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
Volume group Id.
Type: String[]
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-DeleteMembers
Delete member volumes.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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 volume group.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Returns the volume group instances that were removed.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
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.