Tools

Command line options for FTP Voyager

This article gives an overview of the different command link options for FTP Voyager. Commands, parameters and other options including their syntax information are also included in this article.

First published date

10/26/2018 1:25 PM

Last published date

10/26/2018 1:25 PM

Overview

This article provides an overview of the different command line options with FTP Voyager.

Product section

Serv-U Managed File Transfer & Serv-U FTP Server

Resolution

FTP Voyager can be started and controlled via commands in the Windows Command Prompt, opened by clicking Start > Run > cmd.exe. A typical transfer will follow the basic formats listed below:

Transferring a file to a server	`"C:\Program Files\RhinoSoft\FTP Voyager\FTP Voyager.exe" profile="Personal Site.My Site" put=C:\file.txt`
Downloading a file from a server	`"C:\Program Files\RhinoSoft\FTP Voyager\FTP Voyager.exe" profile="My Site" get=file.txt local=C:`
Synchronize a remote directory to a local directory	`"C:\Program Files\RhinoSoft\FTP Voyager\FTP Voyager.exe" profile=YourProfileName autosync=1 syncoptions=1 local=C:\dat\ remote=/dat/ autoquit=1`
Synchronize a local directory to a remote directory	`"C:\Program Files\RhinoSoft\FTP Voyager\FTP Voyager.exe" profile=YourProfileName autosync=1 syncoptions=0 local=C:\dat\ remote=/dat/ autoquit=1`

Breaking down the commands

`profile`	This command specifies what predefined site profile will be used for the connection. The syntax is `profile=MySiteProfile` (or use `profile="My Site Profile"` if there are spaces in the name). For simpler configuration, it is recommended that you configure site profiles prior to executing transfers by command prompt, and place them in the root, or highest level, of your site profile hierarchy.
`put`	This command uploads files to the file server. The syntax is `put=file.txt` (or use `put="file name.txt"` if the file name includes spaces). Wildcards are not permitted as this command requires a specific filename be used.
`get`	This command retrieves files from the file server. The syntax is `get=file.txt` (or use `get="file name.txt"` if the file name includes spaces). Wildcards are not permitted as this command requires a specific filename be used.
`autosync`	This command enables synchronization.
`syncoptions`	This command or flag specifies how a synchronization will take place. To determine what value should be used, refer to the syncoptions list below. The value here must be a decimal representation of the sum of all applicable hex values. If no other options are specified, the synchronization process will upload or download missing files from the master, and delete files from the target that are missing from the master. The simplest `syncoptions` are the following: `syncoptions=0`: Synchronize a remote folder to a local folder. The master is the local folder, and the remote folder is getting synchronized to match it. `syncoptions=1`: synchronize a local folder to a remote folder. The master is the remote folder, and the local folder is getting synchronized to match it.
`remote`	This command specifies the remote directory and must be used during synchronization. The syntax is `remote=/dir/path/`.
`local`	This command specifies the local directory and must be used during synchronization. The syntax is `local=C:\dir\path\`.
`autoquit`	This command causes FTP Voyager to automatically exit after completing the scheduled transfers. Use the `autoquit=1` syntax to enable this option

When a site profile does not exist

When a site profile does not exist in FTP Voyager, the relevant parameters can be specified through the command line as well. They should be listed before all other parameters but after the FTPVoyager.exe file is called. The required values are:

`host`	This parameter specifies the host address being connected to, which can be either a fully qualified domain name (FQDN) or an IP address. The syntax is either `host=ftp.hostname.com` or `host=ip address`.
`user`	This parameter specifies the username for the connection. The syntax is `user=username` or `user="user name"`.
`pass`	This parameter specifies the password for the connection. The syntax is `pass=password` or `pass="pass word"`.
`port`	This parameter specifies which port to connect to. The syntax is `port=xx`, where `xx` is the port number to be used.

Other options

These options should be added at the end of all other options when necessary.

`saveprofile`	Setting this option to non-zero saves any changes for the profile specified on the command line. For example, if the command line changes the remote directory, use this option to save the changes to the disk for that profile. The syntax is `saveprofile=(boolean value)`.
`logfile`	Set this value to use a different log file name than the one assigned within FTP Voyager. The syntax is `logfile=(logfilename.log)`.
`maxthreads`	This parameter specifies the maximum number of threads to use when performing Synchronize Folders. If not specified, the default value of 3 is used. The number of threads you specify here is important in determining how much bandwidth FTP Voyager uses, and how many system resources via threads FTP Voyager uses. Syntax is `maxthreads=(int value)`.
`syncignorestartingwith`	This string tells FTP Voyager to ignore folders that start with any of the characters in the string. For example, ignore all folders that start with "`_`" that are created by some web creation tools in temporary directories. The syntax is `syncignorestartingwith=(string)`.

FTP Voyager also supports a standard URL format for FTP - ftp://[user ID:password@][:port]/[path name/][get file name]. If you need to specify a space in the FTP URL format, use "%20", which is the hexadecimal representation for a space (for example, ftp://myuserid:my%20password@ftp.mysite.com).

`-nostartupwizard`	Disables the initial Startup Wizard.
`-nosplash`	Disables the splash screen at startup.
`-noduration`	Prevents the connect duration of site profiles from being written to disk.

syncoptions list

`SyncRemote`	`0x0000`
`SyncLocal`	`0x0001`
`IgnoreCase`	`0x0002`
`CompareSize`	`0x0004`
`CompareTime`	`0x0008`
`IncludeDirs`	`0x0010`
`DontDelete`	`0x0020`
`OverwriteConfirmations`	`0x0040`
`DeleteConfirmations`	`0x0080`
`RemoteIgnoreNewer`	`0x0100`
`RemoteIgnoreOlder`	`0x0200`
`LocalIgnoreNewer`	`0x0400`
`LocalIgnoreOlder`	`0x0800`
`MinimizeStatusDialogs`	`0x1000`
`QueueErrorMessages`	`0x2000`
`IgnoreSymbolicLinks`	`0x4000`

Disclaimer: Please note, any content posted herein is provided as a suggestion or recommendation to you for your internal use. This is not part of the SolarWinds software or documentation that you purchased from SolarWinds, and the information set forth herein may come from third parties. Your organization should internally review and assess to what extent, if any, such custom scripts or recommendations will be incorporated into your environment. You elect to use third-party content at your own risk, and you will be solely responsible for the incorporation of the same if any.