Skip to main content
SnapCenter 5.0 cmdlets

Rename-SmBackup

Contributors

Renames an existing backup.

Syntax

Rename-SmBackup [-BackupName]  <String>  [-NewBackupName]  <String>  [-PluginType]  <PluginCode>

Detailed Description

Renames an existing backup.

Parameters

Name Description Required? Pipeline Input Default Value

BackupName

Name of the existing backup.

true

false

NewBackupName

The new name you will give the backup.

true

false

PluginType

Provides the SnapCenter plug-in type. You can specify one of the following: SCSQL or SCW.

true

false

Examples

Example 1: Renames an existing backup

 Rename-SmBackup -BackupName SQL_DATASET_CLONE_csmdev-smsql-02_08-03-2015_13.45.19.4400
          -NewBackupName SQL_DATASET_CLONE_RENAMED -PluginType SCSQL -Verbose

This example command syntax renames an existing backup to a new name that you specify.

VERBOSE: Start Rename-SmBackup
VERBOSE: Rename-SmBackup ended successfully.