New-VolumeGroupSnapshot
SYNOPSIS
Creates a snapshot of a volume group.
SYNTAX
ByName (Default)
New-VolumeGroupSnapshot [-Cluster] <Cluster> [-Name] <String> -VolumeGroupName <String> [-Description <String>]
[-Confirm] [-WhatIf] [<CommonParameters>]
ById
New-VolumeGroupSnapshot [-Cluster] <Cluster> [-Name] <String> -VolumeGroupId <String> [-Description <String>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Creates a snapshot of a volume group or clone of a volume group. The volume group can be specified by either its name or Id. Optionally provide a description for the snapshot.
EXAMPLES
Example 1
PS C:\> New-VolumeGroupSnapshot -Cluster $cluster -VolumeGroupId uuid -Name snapshot-vg -Description "Snapshot by uuid"
Where $cluster is a PowerStore cluster instance. Creates new snapshot of the volume group with Id uuid. The name of the snapshot is snapshot-vg and its description is “Clone by uuid”.
Example 2
PS C:\> New-VolumeGroupSnapshot -Cluster $cluster -VolumeGroupName vg -Name snapshot-vg -Description "Snapshot by name"
Where $cluster is a PowerStore cluster instance. Creates new snapshot of the volume group with name vg. The name of the snapshot is snapshot-vg and its description is “Clone by name”.
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
Name of snapshot to be created.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-VolumeGroupName
Name of the source volume group.
Type: String
Parameter Sets: ByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VolumeGroupId
Id of the source volume group.
Type: String
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Description
Optional description.
Type: String
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
-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.