New-VolumeSnapshot
SYNOPSIS
Creates a new snapshot of a volume or clone.
SYNTAX
ByName (Default)
New-VolumeSnapshot [-Cluster] <Cluster> [-Name] <string> -VolumeName <String> [-Description <string>]
[-PerformancePolicy {Low | Medium | High}] [-ExpirationTimestamp <DateTime>] [Confirm] [-WhatIf] [<CommonParameters>]
ById
New-VolumeSnapshot [-Cluster] <Cluster> [-Name] <string> -VolumeId <String> [-Description <string>]
[-PerformancePolicy {Low | Medium | High}] [-ExpirationTimestamp <DateTime>] [Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Creates a new snapshot of a volume or clone. Optionally provide description, performance policy, or expiration timestamp.
EXAMPLES
Example 1
PS C:\> New-VolumeSnapshot -Cluster $cluster -VolumeName volume1 -Name snapshot1
Where $cluster is a PowerStore cluster instance. Creates new snapshot with name snapshot1 for source volume volume1.
Example 2
PS C:\> New-VolumeSnapshot -Cluster $cluster -VolumeId uuid1 -Name snapshot1 -Description 'snapshot1 of volume1' -PerformancePolicy High -ExpirationTimestamp '2050/11/11 12:12:12'
Where $cluster is a PowerStore cluster instance. Creates new snapshot with name snapshot1 for source volume uuid1 with ‘snapshot1 of volume1’ as description, High as performance policy and ‘2050/11/11 12:12:12’ as expiration timestamp.
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
Snapshot name.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-VolumeName
Source volume name.
Type: String
Parameter Sets: ByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VolumeId
Source volume Id.
Type: String
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Description
Snapshot description.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PerformancePolicy
Performance policy.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Low, Medium, High
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExpirationTimestamp
Expiration timestamp. If the option is not provided, the snapshot will never expire.
Type: DateTime
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.