|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: New-NaSnapvault
NAME
New-NaSnapvault
SYNOPSIS
Configure a new snapvault relationship.
SYNTAX
New-NaSnapvault [-SecondaryPath] <String> [-PrimarySystem] <String> [-Primar
yPath] <String> [-MaxTries <Int32>] [-MaxTransferRate <Int64>] [-AllowOpenFi
leBackup [<Boolean>]] [-IgnoreAccessTimeChange [<Boolean>]] [-UseCompression
<String>] [-NoLunCloneExpansion [<Boolean>]] [-Controller <NaController>] [
-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Request the secondary system to configure a new snapvault relationship with
the given primary and secondary systems and paths. This API is equivalent t
o the 'snapvault start' Data ONTAP command. All the inputs provided with th
is request will be stored in the configuration entry maintained by the secon
dary system. These values will be used as default settings for further incr
emental update transfers for this relationship. The Set-NaSnapvault cmdlet
can be used to change these configured settings. A successful configuration
will automatically be followed by a baseline transfer from the primary to t
he secondary. The secondary path will be created during the baseline transf
er hence it is required that the secondary path must not exist when issuing
this request. This request will only begin the baseline transfer and return
. The transfer will proceed asynchronously and there is no guarantee that it
will succeed. The Get-NaSnapvaultSecStatus cmdlet should be used to check t
he status of the transfer.
PARAMETERS
-SecondaryPath <String>
The secondary path that will be used as destination for this relationshi
p as well as baseline transfer. The secondary path will be created duri
ng the baseline transfer and hence it must not exist when issuing this r
equest.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-PrimarySystem <String>
The primary system for this relationship as well as for the baseline tra
nsfer. This input will be used by the secondary system to establish con
tact with the primary. Therefore this input is expected to be a hostnam
e that the secondary can resolve.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-PrimaryPath <String>
The primary path that will be used as the source for this relationship a
s well as for baseline transfer.
Required? true
Position? 3
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-MaxTries <Int32>
The maximum number of times a transfer will be tried. Transfers that ar
e retried using this mechanism may be capable of restarting from where t
he previous attempt failed. If a transfer does not succeed even after t
hose many attempts, then the secondary will give up. All the data that
was transferred during previous tries for this transfer will be discarde
d. The default value for this parameter is 2. When set to 0, the relat
ionship will become dormant. In other words no transfers will be allowe
d to this secondary path. The maximum value accepted for this input is
120. Range:[0..120]
Required? false
Position? named
Default value 2
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-MaxTransferRate <Int64>
The maximum transfer rate in bytes per second that will be used for this
relationship as well as baseline transfer. The default value for this
parameter will allow transfers to proceed as fast as possible. Range:[1
..2^31-2]
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-AllowOpenFileBackup [<Boolean>]
Sets the back_up_open_files option in the snapvault configuration entry.
This option is used to allow or disallow the inclusion of open files o
n the primary system at the time of the transfer. This option is curren
tly applicable only for OSSV relationships. When set to 'false' the OSS
V primary agents will exclude files that are open from the transfer. Th
e default value for this parameter is 'true'.
Required? false
Position? named
Default value true
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-IgnoreAccessTimeChange [<Boolean>]
Sets the ignore_atime option in snapvault configuration entry. When set
to 'true', snapvault primary does not send files with only access time
changes during incremental transfers. The default value is 'false'
Required? false
Position? named
Default value false
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-UseCompression <String>
Specifies whether to compress the network data stream. Possible values
are 'on', 'off', and 'default'. When the value is set to 'on', stream c
ompression will be enabled. When the value is set to 'off', stream comp
ression will be disabled. When the value is set to 'default' then the d
efault value will be used. When this option is not specified, the defau
lt value will be used. The default value for this option is the value o
f global compression option.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-NoLunCloneExpansion [<Boolean>]
This option dictates how a lun clone would be transferred from source to
destination. If this option is "false", a LUN clone would be transferre
d as a LUN and if it is "true", it will be transferred as a clone. By de
fault the value of the option is "false".
Required? false
Position? named
Default value false
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm
Required? false
Position? named
Default value
Accept pipeline input? false
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
NetApp.Ontapi.Filer.Snapvault73.SnapvaultConfigurationInfo
NOTES
Category: snapvault
API: snapvault-secondary-create-relationship
-------------- Example 1 --------------
C:\PS>New-NaSnapvault /vol/vol0/svsec dunn /vol/vol0/svpri
Create a SnapVault relationship from primary 'dunn:/vol/vol0/svpri' to the s
econdary path '/vol/vol0/svsec'.
PrimarySystem : dunn
PrimaryPath : /vol/vol0/svpri
SecondaryPath : /vol/vol0/svsec
MaxTransferRate : 1048576
TriesCount : 10
UseCompression :
IsAccessTimeChangeIgnored : False
IsOpenFileBackupAllowed : True
IsPrimaryPathUtf8Encoded :
RELATED LINKS
Get-NaSnapvault
Remove-NaSnapvault
Set-NaSnapvault
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|