User Tools

Site Tools


CLI commands

The octoBackup Server has a easy to use command line interface.

Connect to the CLI

You can connect to the interface with the normal telnet client.

Just type from any machine on the LAN

  • telnet <Name or IP-Address of server>

If you are on the server you can just type

  • telnet localhost


  • Some newer windows systems does not install the telnet command by default.
  • The telnet port of the server can be adjusted with the agent gui. If the port is not default (21) you must type
    • telnet <Name or IP-Address of server> <Port number>

Logon the the CLI

If you have entered a password on the server_settings page, you must first enter a valid password to logon.

CLI special functions

Auto completion

The CLI has a auto completion function. To use auto completion function just type the first (unique) letters of a word and type the TAB key.

>sh >TAB<


With the “?” you can get help on almost all commands.

>?     Help for 1st level commands
>sh ?  Help for show commands

Multi page output

On multi page output, a “more” prompt will be shown at the end of the page. You can quit the output by typing “q” or continue one line with “space” or a whole page with “enter”.


CLI commands

show job list

Command: show job list

Description: shows all jobs

cmd> show job list
     ID JobName                   Type            CronString          Task
      3 Server1_user              SyncJob         30;0;*;*;*;*;*         0
      4 Server2_user              SyncJob         45;0;*;*;*;*;*      3212
      5 Server1_files             SyncJob         0;1;*;*;*;*;*          0
     10 Server2_files             SyncJob         45;1;*;*;*;*;*         0
     11 server3_databasedump      SyncJob         0;2;*;*;*;*;*          0
     13 MailReport                ReportEMailJob  0;7;*;*;*;*;*          0
  • ID Job number
  • JobName Name of job
  • Type Type of job
  • CronString
  • Task Number of task if active

show job id

Command: show job id <id>

Description: shows the jobs with the job id <id>

cmd> sh jo id 3
  JobType             : SyncJob
  JobID               : 3
  JobName             : Server1_user
  CronString          : 30;0;*;*;*;*;*
  AgentMachineName    : Server1
  AgentPath           : e:\user
  ServerPath          : d:\mirror003\Server1\user
  ActiveTask          : 0

show task list

Command: show task list

Description: shows all task

cmd> show task list
Found 1866 tasks
    TaskID TaskStart            A AgentMachineName     AgentPath
      1866 03.08.2010 02:15:01  0 Server01             d:\file_user\
      1865 03.08.2010 02:00:09  0 Server01             d:\file_share\
      1864 03.08.2010 01:30:03  0 Server02             c:\backup\
      1863 03.08.2010 01:00:08  0 Server03             d:\file_share\
      1862 03.08.2010 00:45:06  0 Server03             d:\file_user\
  • ID TaskID
  • TaskStart Start time & date of task in UTC
  • A 1 if job is active
  • AgentMachineName Name of the agent machine
  • AgentPath Backuop pacht on the agent

show task id

Command: show task id <id>

Description: shows the task with the id <id>

cmd> sh ta id 1864
  TaskID              : 1864
  TaskStart           : 03.08.2010 01:30:03
  TaskEnd             : 03.08.2010 01:32:44
  AgentMachineName    : Server01
  AgentPath           : c:\backup\
  ServerPath          : d:\mirror002\Server02\backup\
  Active              : False
  Status              : n/a
  FileCount           : 3
  FileCreateCount     : 0
  FileCopyCount       : 3
  FileCopyOKCount     : 3
  FileCopyErrorCount  : 0
  FileDeleteCount     : 0
  FileDeleteOKCount   : 0
  FileDeleteErrorCount: 0
  DirCount            : 0
  DirCreateCount      : 0
  DirCreateOKCount    : 0
  DirCreateErrorCount : 0
  DirDeleteCount      : 0
  DirDeleteOKCount    : 0
  DirDeleteErrorCount : 0
  ByteCopyCount       : 917330079
  ByteCopyOKCount     : 246095210
  ErrorCount          : 0

show task log

Command: show task log <taskid> <error|warning>

Description: shows the log entries of <taskid>. if “error” or “warning” is added to the end of the command string, only errors or warnings will be shown.

show agent list

Command: show agent list

Description: shows all agent

cmd> show agent list
    ID AgentName                      LastContact          LastIP          A/L
     1 Server1                        03.08.2010 18:25:11     X/X
     2 Server2                        03.08.2010 18:25:29     X/X
     3 Server3                        30.06.2010 12:56:53     -/-
     4 Server4                        03.08.2010 18:25:08     X/X
     5 Server5                        03.08.2010 18:25:21     X/X
     6 Server6                        03.08.2010 18:25:23      X/X
     7 Server6                        19.04.2010 09:05:50     -/-
  • ID ID of agent
  • AgentName Name of the agent
  • LastContact Last communication to agent
  • LastIP Last IP-Address of agent
  • A X if agent is currently connected / active
  • L X if agent is correctly licensed

show agent id

Command: show agent id <id>

Description: shows details on agent with <id>

cmd> sh ag id 1
  AgentID             : 1
  AgentName           : Server01
  LastContact         : 03.08.2010 18:25:11
  LastIP              :
  LastVersion         : 1
  LastVersionString   : (
  LastSerialNumber    : 0
  SerialStatus        : valid
  Active              : True
  FileTRXBufferSize   : 0
  FileTRXTimeout      : 0
  FileCrypt           : False
  FileCompress        : False
  Bandwith            : 0

show version

Command: show version

Description: shows server version information

cmd> sh version
ocBackup - octobase.Net Server V0.1.32.0 (

show smtp

Command: show smtp

Description: shows smtp settings

cmd> sh smtp
  ServerName                    : smtp.myserver.con
  ServerPort                    : 25
  Sender e-mail address         :
  Sender name                   : octoBackup
  Receipient e-mail address     :;
  SMTP-Auth username            :
  SMTP-Auth password            :

add syncagentjob

Command: add syncagentjob <JobName> <AgentMachine> <AgentPath> <ServerPath> <CronString>

Description: adds a new syncjob using a octoBackup agent

  • JobName Name of the job
  • AgentMachine Name of the agent as shown in agent list
  • AgentPath Native path to backup data on the agent machine. (Use path like D:\Data, not \\Server1\Data)
  • ServerPath Native path to location on server. (Use path like D:\Backups\Server1, not \\ServerBackup\Backup\Data)
  • CronString Information on when to backup

add syncsmbjob

Command: add syncsmbjob <JobName> <SourcePath> <DestinationPath> <CronString>

Description: adds a new syncjob for smb (windows)

  • JobName Name of the job
  • SourcePath UNC path to backup data on the agent machine. (Use path \\Server2\Data)
  • ServerPath Native path to location on server. (Use path like D:\Backups\Server1, not \\ServerBackup\Backup\Data)
  • CronString Information on when to backup

add reportmailjob

Command: add reportmailjob <JobName> <ReportJobIDs / *> <CronString>

Description: adds a new report job

  • JobName Name of the job
  • ReportJobIDs IDs of the jobs to report seperated by ',' or just '*' for all
  • CronString Information on when to backup

delete job

Command: delete job <id>

Description: deletes the job with <id>

set smtp

Command: set smtp <option> <value>

Description: sets the options for the smtp reportmailjobs

cmd> set smtp ?
  servername              Name or IP address of smtp server
  serverport              Port of SMTP server
  senderemailaddress      e-mail address of the sender
  sendername              name of the sender
  receipientemailaddress  e-mail address of the receiver(s) (devided by ';')
  authuser                Username if authentication is needed
  authpassword            Password if authentication is needed

set agent

Command: set agent <option> <value>

Description: sets a agent option

do smtptest

Command: do smtp test

Description: sends a e-mail to test smtp settings


Command: quit

Description: does quit the CLI

octobackup/server_cli_commands.txt · Last modified: 2018/06/01 15:26 (external edit)