Refresh-Volume
SYNOPSIS
Refreshes the contents of a volume from another volume in the same family.
SYNTAX
ByNameVolumeName (Default)
Refresh-Volume [-Cluster] <Cluster> [-Name] <String> -VolumeName <String> [-SkipBackupSnapshot] [-BackupSnapshotName] [-BackupSnapshotDescription]
[-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
ByNameVolumeId
Refresh-Volume [-Cluster] <Cluster> [-Name] <String> -VolumeId <String> [-SkipBackupSnapshot] [-BackupSnapshotName] [-BackupSnapshotDescription]
[-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
ByNameSnapshotName
Refresh-Volume [-Cluster] <Cluster> [-Name] <String> -SnapshotName <String> [-SkipBackupSnapshot] [-BackupSnapshotName] [-BackupSnapshotDescription]
[-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
ByNameSnapshotId
Refresh-Volume [-Cluster] <Cluster> [-Name] <String> -SnapshotId <String> [-SkipBackupSnapshot] [-BackupSnapshotName] [-BackupSnapshotDescription]
[-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
ByIdVolumeName
Refresh-Volume [-Cluster] <Cluster> -Id <String> -VolumeName <String> [-SkipBackupSnapshot] [-BackupSnapshotName] [-BackupSnapshotDescription]
[-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
ByIdVolumeId
Refresh-Volume [-Cluster] <Cluster> -Id <String> -VolumeId <String> [-SkipBackupSnapshot] [-BackupSnapshotName] [-BackupSnapshotDescription]
[-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
ByIdSnapshotName
Refresh-Volume [-Cluster] <Cluster> -Id <String> -SnapshotName <String> [-SkipBackupSnapshot] [-BackupSnapshotName] [-BackupSnapshotDescription]
[-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
ByIdSnapshotId
Refresh-Volume [-Cluster] <Cluster> -Id <String> -SnapshotId <String> [-SkipBackupSnapshot] [-BackupSnapshotName] [-BackupSnapshotDescription]
[-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Refreshes the contents of a primary or clone volume from another primary, clone, or snapshot in the same family. Creates a backup snapshot of the volume before refresh by default. Use BackupSnapshotName to create a snapshot with name of choice, otherwise system generated name will be used. Use SkipBackupSnapshot if no backup snapshot is required.
EXAMPLES
Example 1
PS C:\> Refresh-Volume -Cluster $cluster -Id targetVolumeId1 -VolumeId volumeId1
Where $cluster is a PowerStore cluster instance. Refreshes volume with Id targetVolumeId1 from volume using Id volumeId1 and backup snapshot will be created using a system generated timestamp.
Example 2
PS C:\> Refresh-Volume -Cluster $cluster -Name targetVolumeName1 -VolumeId volumeId1 -BackupSnapshotName snapName1
Where $cluster is a PowerStore cluster instance. Refreshes volume with name targetVolumeName1 from volume using Id volumeId1 and backup snapshot will be created with snapName1.
Example 3
PS C:\> Refresh-Volume -Cluster $cluster -Name targetVolumeName1 -VolumeName volumeName1
Where $cluster is a PowerStore cluster instance. Refreshes volume with name targetVolumeName1 from volume using name volumeName1 and backup snapshot will be created using a system generated timestamp.
Example 4
PS C:\> Refresh-Volume -Cluster $cluster -Name targetVolumeName1 -SnapshotName snapshotName1 -SkipBackupSnapshot
Where $cluster is a PowerStore cluster instance. Refreshes volume with name targetVolumeName1 from snapshot using name snapshotName1 and no backup snapshot will be created before the refresh operation.
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 volume to refresh.
Type: String
Parameter Sets: ByNameVolumeId, ByNameVolumeName, ByNameSnapshotId, ByNameSnapshotName
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
Id of volume to refresh.
Type: String
Parameter Sets: ByIdVolumeId, ByIdVolumeName, ByIdSnapshotId, ByIDSnapshotName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VolumeName
Name of volume to refresh from.
Type: String
Parameter Sets: ByIdVolumeName, ByNameVolumeName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VolumeId
Id of volume to refresh from.
Type: String
Parameter Sets: ByIdVolumeId, ByNameVolumeId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SnapshotName
Name of snapshot to refresh from.
Type: String
Parameter Sets: ByIdSnapshotName, ByNameSnapshotName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SnapshotId
Id of snapshot to refresh from.
Type: String
Parameter Sets: ByIdSnapshotId, ByNameSnapshotId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SkipBackupSnapshot
Set if no backup snapshot is required.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BackupSnapshotName
Backup snapshot name.
Type: String
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BackupSnapshotDescription
Backup snapshot description.
Type: String
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 refresh.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Returns refreshed volume instance.
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.