|Subject:||Using Syncrify client from command line|
|Creation date:||6/30/10 1:50 PM|
|Last modified on:||10/2/18 11:17 AM|
$INTSTALL_DIR/jre/bin/javato ensure a file exists. Otherwise, download java from http://java.com
java -jar SyncrifyClient.jar ...TO
java -jar Loader.jar ...
java -jar SyncrifyClient.jar -console ProfileName.syncrify Preferred methodThe above command will run a backup.
java -jar SyncrifyClient.jar -console -createProfile
|Profile name:||Name of the profile. We recommend you use a one word name without spaces. Assume you use MyBackup for this value, you can issue the following command to run a backup
|Server URL:||Refers to the URL where your server is running. For example:
|Login email:||Email address used for user's login|
|Path:||Refers to the path that you want to backup. For example:
|Filter||Specify a filter string. Refer to this document for more information|
|Additional path:||Specify additional folders/files to backup. You can specify as many paths as you like. Hit ENTER without typing any path when done.|
|Excluded path:||Enter the path that you want to exclude from the list|
|Compress data:||Type Y for yes and N for no. When set to Y, client will compress data before sending it to the server|
|Delete files:||Type Y for yes and N for no. When set to Y, server will delete files if they are deleted from the client.|
|Backup locked files||Type Y for yes and N for no. When set to Y, VSS services are used on Windows. This parameter is only meaningful on Windows. It has no effect on other operating systems.|
|Enable versioning||Versioning is enabled if set to Y|
|Send email:||An email is sent with a backup log|
|Email recipient||Address that gets the email. If blank, login email is used for the recipient's address|
|Encryption key||Password used for encryption|
|-console||This option makes Syncrify client run in console mode. If this is missing every other option will be ignore and Syncrify client will run in its default GUI or web mode|
|-sF||Selected Folder. Specifies one folder location that you want to backup or restore. This parameter must be accompanied by -tF|
|-tF||Top Level Folder. Specifies the top-level folder where the selected folder is located. This parameter must be accompanied by -sF.
The -sF and -tF parameters are only valid if you are running backup/restore on an existing profile and just want to run a backup on a specific folder. This is
equivalent of backing up a selected folder specified here using console.
Refer to example 2 below.
|-oD||Backup Direction. This specifies the direction for backup and will overwrite the values specified in the profile. Possible values are:
|-itools||Runs in interactive mode, allowing users to:
|-skipRedir||By default, messages sent to STDOUT and STDERR are sent to files in the $DATA_FOLDER\logs directory. Use -skipRedir to send console messages to screen instead of redirecting them to files.|
java -jar SyncrifyClient.jar -console myProfile.syncrifyThe above example assume you have a pre-created profile called myProfile and want to run it through command line.
java -jar SyncrifyClient.jar -console myProfile.syncrify -tF /user/home/jack/Desktop -sF /user/home/jack/Desktop/Pictures/NewYorkThis example runs a profile called myProfile and will only backup files in /user/home/jack/Desktop/Pictures/NewYork folder.
java -Djava.io.tmpdir=/opt/ATempFolder -jar SyncrifyClient.jar -console myProfile.syncrifyThe above example a backup is run against myProfile and the client will use /opt/ATempFolder to store temporary files.
java -jar SyncrifyClient.jar -console -itools
java -jar SyncrifyClient.jar -console myProfile.syncrify -oD s2c -tF /user/home/jack/Desktop -sF /user/home/jack/Desktop/Pictures/NewYorkThis example runs a profile called myProfile and will only restore files in /user/home/jack/Desktop/Pictures/NewYork folder.
A service constantly runs in the background on machines where Syncrify Client is installed. Staring v5.2 of Syncrify, you can communicate with that service using command line.
Following table lists the commands available to communicate with the server
java -jar SyncrifyClient.jar -talkToService
|Connects to the service interactively as if you're connecting from a
telnet client. Once connected, type
java -jar SyncrifyClient -findPermissionIssues ProfileName.syncrify
|Connects to the service, which traverses every top-level folder for the given profile to see if
there are any permission problems in the profile. By default, this method only checks folder access.
On Windows use