Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: New-NcConfigBackup


NAME
New-NcConfigBackup

SYNOPSIS
Create a configuration backup.

SYNTAX
New-NcConfigBackup [-Node] <String> [[-Name] <String>] [-Type <String>] [-Co
ntroller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Create a configuration backup. A job will be queued to create the configurat
ion backup in the background. Creation of configuration backup may take seve
ral minutes. The progress of the job can be tracked using the job cmdlets.


PARAMETERS
-Node <String>
The node to own the configuration backup. This is the node that will hav
e the 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. It must be a valid file name. An e
xtension of .tgz will be added if the given backup-name doesn't have tha
t extension. If backup-name is not provided, software will generate the
name for configuration backup.

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

-Type <String>
Indicates if the backup is a node or a cluster backup. A node backup con
tains only node-specific configuration of a particular node in the clust
er. A cluster backup contains cluster-wide replicas in addition to node
backup of each node in the cluster. Possible values:
"node" - Node Backup
"cluster" - Cluster Backup

Required? false
Position? named
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.PowerShell.SDK.Cmdlets.JobStartResult


NOTES


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

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

C:\PS>New-NcConfigBackup -Node fas3070cluster01-01 -Name testbackup -Type no
de


Create a new config backup of node fas3070cluster01-01.






RELATED LINKS
Get-NcConfigBackup
Remove-NcConfigBackup
Rename-NcConfigBackup







 Data ONTAP® PowerShell Toolkit