Command Line Parameters

 Content Previous Next

Topic Content

General

Task Commands

Miscellaneous Commands

 

 

This sections explains how to manage AnyFileBackup from command line.

 

 

General

Managing AnyFileBackup from command line requires two things:

 

-the Task Processor, a module responsible for all operations, must be running; and

 

-a proper command is sent to the Task Processor with sendcmd.exe utility located in AnyFileBackup installation folder.
▪Task Processor

AnyFileBackup Task Processor can be launched from command line as an ordinary Windows-based application only (not as a Windows system service). To launch the Task Processor please type the following:

 

"C:Program Files (x86)AnyFileBackupProafbtppro.exe" /EXE

▪Commands

The list of commands with description can be found below. The simple rules for using the commands are:

 

▪sendcmd.exe utility is used to send commands to the Task Processor

 

▪commands can be used in any order

 

▪it is possible to use several commands contemporaneously

 

▪any new command must start with the solidus symbol ('/') or the hyphen-minus symbol ('-')

 

▪all commands are case-sensitive and it is essential that you type them with CAPITAL LETTERS
▪Command line template example

The typical command line looks like this:

 

sendcmd.exe /[COMMAND1] [COMMAND1 PARAMETER(S)] /[COMMAND2] [COMMAND2 PARAMETER(S)]

 

where:

 

▪[COMMAND] is a key word from the list below;

 

▪[COMMAND PARAMETER(S)] is one or more options depending on the preceding command.

 

 

Task Commands

▪Activate task

Command: ACTIVATETASK

 

Parameter: TASK-ID is a Task ID which can be found in task's Advance Options located in the Activation section of the Task Scenario.

▪Activate all tasks

Command: ACTIVATEALL

 

Parameter: none

▪Deactivate task

Command: DEACTIVATETASK

 

Parameter: TASK-ID is a Task ID which can be found in task's Advance Options located in the Activation section of the Task Scenario.

▪Deactivate all tasks

Command: DEACTIVATEALL

 

Parameter: none

▪Start task manually

Command: STARTTASK

 

Parameter: TASK-ID is a Task ID which can be found in task's Advance Options located in the Activation section of the Task Scenario.

▪Examples
▪Single task example:

 

sendcmd.exe /ACTIVATETASK 1ACE909E /STARTTASK 1ACE909E

 

▪Multiple tasks example:

 

sendcmd.exe /ACTIVATETASK 1ACE909E /ACTIVATETASK 1112835C /STARTTASK 1ACE909E /STARTTASK 1112835C

 

▪BAT-file example:

 

start /D"C:Program Files (x86)AnyFileBackup Pro" afbtppro.exe /EXE

"C:Program Files (x86)AnyFileBackup Prosendcmd.exe" /VERBOSE /PAUSE 10 /ACTIVATETASK 1ACE909E /STARTTASK 1ACE909E

pause

 

In this third example the PAUSE command is recommended because it gives the Task Processor time to start.

 

 

Miscellaneous Commands

▪Communication port

Command: PORT

 

Parameter: a port number that the Task Processor is using to communicate with AnyFileBackup GUI, a graphic user interface window. By default the value is 18410.

▪Detailed log in command line

Command: VERBOSE

 

Parameter: none

▪No logo when AnyFileBackup GUI is loading

Command: NOLOGO

 

Parameter: none

 

This command must be used with afbackuppro.exe.

 

Example: "C:Program Files (x86)AnyFileBackupProafbackuppro.exe" /NOLOGO

▪Pause

Command: PAUSE

 

Parameter: a pause length in seconds

▪Stop Task Processor

Command: STOPTP

 

Parameter: none

 Content Previous Next