Remove-SnapshotRule
SYNOPSIS
Removes a snapshot rule from the PowerStore cluster.
SYNTAX
ByName (Default)
Remove-SnapshotRule [-Cluster] <Cluster> [-Name] <String[]> [-RemoveSnapshots] [-Confirm] [-Force] [-PassThru] [-WhatIf]
[<CommonParameters>]
ById
Remove-SnapshotRule [-Cluster] <Cluster> -Id <String[]> [-RemoveSnapshots] [-Confirm] [-Force] [-PassThru] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
Removes one or more snapshot rules from the PowerStore cluster.
EXAMPLES
Example 1
PS C:\> Remove-SnapshotRule -Cluster $cluster -Name snapRule
Where $cluster is a PowerStore cluster instance. Removes the snapshot rule snapRule1.
Example 2
PS C:\> Remove-SnapshotRule -Cluster $cluster -Id snapId
Where $cluster is a PowerStore cluster instance. Removes the snapshot rule with Id snapId.
PARAMETERS
-Cluster
The PowerStore cluster.
Type: Cluster
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
The snapshot rule name.
Type: String[]
Parameter Sets: ByName
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
The snapshot rule Id.
Type: String[]
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RemoveSnapshots
Removes snapshots created using the snapshot rule.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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 volume.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Returns the snapshot rule instance that was 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.