Description
Issue a SnapReplicate command.
Request
Parameter
|
Required?
|
snapverify
|
Y
|
remotenode
|
Y
|
userid
|
Y
|
password
|
Y
|
initsnapreplicate
|
Y
|
type
|
Y
|
keyexchange
|
Y
|
keyfile
|
Y
|
pubEncoded
|
Y
|
serverEncoded
|
Y
|
serverIP
|
Y
|
snapreplicatestatus
|
Y
|
start
|
Y
|
limit
|
Y
|
snapreplog
|
Y
|
snapreplicatetasks
|
Y
|
forcesync
|
Y
|
replicatenow
|
Y
|
activate
|
Y
|
deactivate
|
Y
|
takeover
|
Y
|
giveback
|
Y
|
deletereplication
|
Y
|
getsettings
|
Y
|
modifysettings
|
Y
|
transportcmd
|
Y
|
transportflags
|
Y
|
cipherspec
|
Y
|
compressenabled
|
Y
|
throttleenabled
|
Y
|
throttlelimit
|
Y
|
throttleunits
|
Y
|
Command Options
Command
|
Possible Values
|
snapverify
|
verify the remote node.
|
Related Options:
|
remotenode
|
ip adress of remote node
|
userid
|
username for remote node
|
password
|
password of remote node
|
initsnapreplicate
|
begin initial replicate with remote node
|
type
|
type of remote node possible values source or target
|
keyexchange
|
Exchange servers keys and allow remote servers ssh connection for each node
|
keyfile
|
public key file path
(/var/www/softnas/keys/SoftNAS-PrimaryPublic.pem)
|
pubEncoded
|
Keyfile content, base 64 encoded
|
serverEncoded
|
RSA public host key content file, base 64 encoded (/etc/ssh/ssh_host_rsa_key.pub)
|
serverIP
|
server node ip (sender)
|
snapreplicatestatus
|
get the current status of replication
|
start
|
position to start from (used for pagination)
|
limit
|
number of items to get
|
snapreplog
|
get snapreplicate log
|
snapreplicatetasks
|
get snapreplicate tasks
|
forcesync
|
forces full synchronization between nodes
|
replicatenow
|
replicates changed content/files
|
activate
|
activate replication
|
deactivate
|
deactivate replication
|
takeover
|
takeover as replication source
|
giveback
|
giveback replication source duties
|
deletereplication
|
remove the replication
|
getsettings
|
get replication settings
|
modifysettings
|
edit replication settings
|
|
loglevel
|
Logging Level
|
Related Options:
|
info
|
Informational, warning and error messages (default)
|
debug
|
Debug, informational, warning and error messages (all messages)
|
warn
|
Warning and error messages
|
error
|
Error messages only
|
fatal
|
Fatal messages only
|
off
|
No messages (not recommended)
|
|
transportcmd
|
Transport Command
|
transportflags
|
Transport Flags
|
cipherspec
|
Cipher Spec
|
compressenabled
|
Compress data stream (consumes additional CPU)
|
throttleenabled
|
enable bandwidth Throttle (per stream)
|
throttlelimit
|
limit size
|
throttleunits
|
These are the possible size unit values:
|
Example 1
Initiate SnapReplicate.
$ softnas-cmd snaprepcommand initsnapreplicate remotenode=10.227.57.227 userid=softnas password=Pass4W0rd type=target -t
|
Example 2
SnapReplicate - verify remote node
$ softnas-cmd snaprepcommand snapverify remotenode=10.227.57.227 userid=softnas password=Pass4W0rd -t
|
Example 3
SnapReplicate - get snapreplicate status.
$ softnas-cmd snaprepcommand snapreplicatestatus start=0 limit=10 -t
|
Example 4
SnapReplicate - get snapreplicate logs.
$ softnas-cmd snaprepcommand snapreplog start=0 limit=10 -t
|
Example 5
Delete SnapReplication.
$ softnas-cmd snaprepcommand deletereplication -t
|
Example 6
SnapReplicate - get replication settings.
$ softnas-cmd snaprepcommand getsettings -t
|
Example 7
SnapReplicate - force synchronization between 2 nodes.
$ softnas-cmd snaprepcommand forcesync -t
|
Example 8
SnapReplicate - start replication cycle.
$ softnas-cmd snaprepcommand replicatenow -t
|
Example 9
Activate replication.
$ softnas-cmd snaprepcommand activate -t
|
Example 10
Deactivate Replication.
$ softnas-cmd snaprepcommand deactivate -t
|
Example 11
SnapReplicate - Change role to primary node.
$ softnas-cmd snaprepcommand takeover -t
|
Example 12
SnapReplicate - Change role to secondary node.
$ softnas-cmd snaprepcommand giveback -t
|
Example 13
SnapReplicate - Modify Replication Settings.
$ softnas-cmd snaprepcommand modifysettings loglevel=info transportcmd=ssh transportflags="-o ConnectTimeout=30" cipherspec="aes128-cbc,blowfish-cbc,3des-cbc,cast128-cbc,aes192-cbc,aes256-cbc" compressenabled=on throttleenabled=on throttlelimit=200 throttleunits=K throttleflags= -t
|