Set-VolumeGroupSnapshot
SYNOPSIS
Modifies properties of a volume group snapshot.
SYNTAX
ByNameVolumeGroupName (Default)
Set-VolumeGroupSnapshot [-Cluster] <Cluster> [-Name] <String> -VolumeGroupName <String> [-NewName <String>]
[-Description <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
ByNameVolumeGroupId
Set-VolumeGroupSnapshot [-Cluster] <Cluster> [-Name] <String> -VolumeGroupId <String> [-NewName <String>]
[-Description <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
ById
Set-VolumeGroupSnapshot [-Cluster] <Cluster> -Id <String> [-NewName <String>] [-Description <String>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Modifies the name and/or description of a volume group snapshot.
EXAMPLES
Example 1
PS C:\> Set-VolumeGroupSnapshot -Cluster $cluster -Id uuid1 -NewName newSnapName -Description "new description"
Where $cluster is a PowerStore cluster instance. Changes the name of the snapshot with Id uuid1 to newSnapName and changes the description to “new description”.
Example 2
PS C:\> Set-VolumeGroupSnapshot -Cluster $cluster -VolumeGroupId uuid1 -Name snapshot -NewName newSnapName -Description "new description"
Where $cluster is a PowerStore cluster instance. Changes the name of the snapshot named snapshot, of source volume group with Id uuid1, to newSnapName and changes the description to “new description”.
Example 3
PS C:\> Set-VolumeGroupSnapshot -Cluster $cluster -VolumeGroupName volumeGroup -Name snapshot -NewName newSnapName -Description "new description"
Where $cluster is a PowerStore cluster instance. Changes the name of the snapshot named snapshot, of source volume group with name volumeGroup, to newSnapName and changes the description to “new description”.
PARAMETERS
-Cluster
The 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
Snapshot name.
Type: String
Parameter Sets: ByNameVolumeGroupName, ByNameVolumeGroupId
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
Snapshot Id.
Type: String
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VolumeGroupName
Source volume group name.
Type: String
Parameter Sets: ByNameVolumeGroupName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VolumeGroupId
Source volume group Id.
Type: String
Parameter Sets: ByNameVolumeGroupId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NewName
New snapshot name.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
Volume group 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.