Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Rename-NcConfigBackup


NAME
Rename-NcConfigBackup

SYNOPSIS
Rename a configuration backup.

SYNTAX
Rename-NcConfigBackup [-Node] <String> [[-Name] <String>] [[-NewName] <Strin
g>] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Rename a configuration backup. Renamed backups stay on the same node.


PARAMETERS
-Node <String>
The node that owns the configuration backup. This is the node that has t
he backup file on its root volume.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Name <String>
The name of the configuration backup.

Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-NewName <String>
The new name for the configuration backup. It must be a valid file name.
An extension of .tgz will be added if the given new-name doesn't have t
hat extension.

Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
DataONTAP.C.Types.ConfigBackup.ConfigBackupInfoType


NOTES


Category: config-backup
API: config-backup-rename
Family: cluster

-------------- Example 1 --------------

C:\PS>Rename-NcConfigBackup -Node fas3070cluster01-01 -Name testbackup.7z -N
ewName backup.7z


Rename the config backup testbackup.7z to backup.7z on node fas3070cluster01
-01.


Created Node BackupName
BackupSize BackupType
------- ---- ----------
---------- ----------
6/7/2012 fas3070cluster01-01 backup.7z
11.0 MB node



RELATED LINKS
Remove-NcConfigBackup
New-NcConfigBackup
Copy-NcConfigBackup
Get-NcConfigBackup







 Data ONTAP® PowerShell Toolkit