SnapCenter PowerShell Commands
Rename-SdSnapshot
Suggest changes
PDFs
Renames Snapshot copies created on a Windows disk or SMB share.
Syntax
Rename-SdSnapshot [-Path] <Object[]> [-Snapshot] <String> [-NewName] <String> [-Session] <String> [-Host] <String> [-StorageSystem] <String> [-VolumeName] <String> [-Snapshot] <String> [-NewName] <String> [-Session] <String> [-Host] <String>
Detailed Description
Renames Snapshot backups created on a Windows disk or SMB share.Related cmdlets: New-SdSnapshot and Remove-SdSnapshot
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
Path |
Specifies a list of SMB shares or Windows volumes. You cannot mix a logical disk or mount point with SMB shares in the same input path. |
true |
true (ByPropertyName) |
|
Snapshot |
Specifies the name of the Snapshot copy you want to rename. |
true |
true (ByPropertyName) |
|
NewName |
Indicates the new name of the Snapshot copy. |
true |
true (ByPropertyName) |
|
Session |
false |
true (ByPropertyName) |
||
Host |
Specifies the name or IP address of the host on which you execute the operation. The default is your local machine. |
false |
true (ByPropertyName) |
|
StorageSystem |
Specifies the name of storage system name for the Snapshot copy you are renaming. |
true |
true (ByPropertyName) |
|
VolumeName |
Specifies the storage system volume name for the Snapshot copy. |
true |
true (ByPropertyName) |
Examples
Example 1: Rename a single Snapshot copy
PS C:\> Rename-SdSnapshot -Path \\SQLCIFSServer\SalesDBShare -Snapshot MySnap -NewName MyNewSnap
This example renames a Snapshot copy from MySnap to MyNewSnap.
SnapshotName AccessPoint StorageSystemName Volume
------------ ----------- ----------------- ------
MyNewSnap \\SQLCIFSServer\SalesDBShare MyStorageSystem1 vol1
Example 2: Rename a Snapshot copy on two SMB shares
PS C:\> Rename-SdSnapshot -Path \\SQLCIFSServer1\SalesDBShare,\\SQLCIFSServer2\MarketDBShare -Snapshot MySnap -NewName MyNewSnap
This example renames a Snapshot copy located two SMB shares.
SnapshotName AccessPoint StorageSystemName Volume
------------ ----------- ----------------- ------
MyNewSnap \\SQLCIFSServer1\SalesDBShare MyStorageSystem1 vol1
MyNewSnap \\SQLCIFSServer2\MarketDBShare MyStorageSystem2 vol2
Example 3: Rename a Snapshot copy on a specified storage system and volume
PS C:\> Rename-SdSnapshot -StorageSystem MyStorageSystem1 -VolumeName vol1 -Snapshot MySnap -NewName MyNewSnap
This example renames a Snapshot copy from MySnap to MyNewSnap on a specified storage system and volume.
SnapshotName AccessPoint StorageSystemName Volume
------------ ----------- ----------------- ------
MyNewSnap MyStorageSystem1 vol1
Example 4: Renames a single Snapshot copy on a disk
PS C:\> Rename-SdSnapshot -Path F: -Snapshot MySnap -NewName MyNewSnap
This example renames a Snapshot copy on the disk drive :F from MySnap to MyNewSnap.