Introduction
This article provides details of the command line arguments that may be used with Cerberus. Command line arguments override their equivalent Configuration Options.
Accessing Console Help
You may view the complete list of command line arguments for Cerberus by accessing the console help page. Use the /help argument:
cerberus.exe /help
Common Use Cases
| Action |
Command Line |
| Create an immediate backup |
cerberus.exe /times now |
| Create an immediate backup and then exit |
cerberus.exe /times now /StopOnBackupCompletion |
| Clear the log |
cerberus.exe /clearlog |
Command Line Arguments
- Argument names may be used in any order and are case insensitive
- For boolean arguments:
- True = true or 1 or yes
- False = false or 0 or no
- If an argument is not used or any value is invalid, then value defined in the configuration file (see Configuration Options) is used.
| Argument |
Explanation |
|
/?
OR
/help
|
Shows the command line arguments help page.
Example:
cerberus.exe /help
|
| /Clear Log |
Clears all existing log values for the current day.
No value is required for this argument. Just including it will trigger the log clearing.
Example:
cerberus.exe /ClearLog
|
|
/Times
OR
/BackupTimes
|
The times at which backups are to be created. Enter multiple values in CSV format.
You may enter either specific times and or wildcard hours:minute values.
Example 1: /times 12:35,*:40
Backup will run at 12:35 and every hour at 40 minutes past.
Example 2: /times 06:30,21:30
Backup will run at 06:30(AM) and 21:30(PM)
Example 3: /times *:00,*:05,*:10,*:15,*:20,*:25,*:30,*:35; *:40,*:45,*:50,*:55
Backup will run every five minutes.
Example 4: /times now
Backup will start immediately (within the next minute or so).
|
| /CompressBackups |
Whether to compress backups. Using this will produce substantially smaller backup files.
Expected value: boolean
Example:
cerberus.exe /CompressBackups true
|
| /DaysToStore |
Number of days to store backups. Defaults to 14. Permissible range of 1 to 365.
Expected value: integer
Example:
cerberus.exe /DaysToStore 7
|
| /ExtendedInsert |
Whether to use extended insert in generated file.
Expected value: boolean
Example:
cerberus.exe /ExtendedInsert true
|
| /ExcludedSchemas |
Schemas (or database names) to exclude from backups.
Expected value: CSV string of database/schema names
Example:
cerberus.exe /ExcludedSchemas database1,database2,database3
|
| /MySqlDumpPath |
Path to MySqlDump.exe
Expected value: Complete filepath to the mysqldump.exe
Example:
cerberus.exe /mysqldumppath c:\mysql\mysqldump.exe
|
|
/RCET
or
/RemoveConditionalExecutionTokens
|
Remove MariaDB/MySql Conditional Execution Tokens from database dump file.
Expected value: boolean
Example:
cerberus.exe /rcet true
|
| /SkipComments |
Whether to skip comments in MySqlDump output.
Expected value: boolean
Example:
cerberus.exe /SkipComments true
|
| /StopOnBackupCompletion |
Stop the console application once the backup has been completed.
No value is required for this argument. Just including it triggers the stop action.
|
| /StoragePath |
Path to folder into which backup files are to be stored.
Expected value: filepath
Example:
cerberus.exe /storagePath C:\mybackups
|
| /TimeOut |
Number of seconds before the MySqlDump command times out. Range of 30 seconds to 10 minutes.
Expected value: integer
Example:
cerberus.exe /timeout 60
|
| /UseHexForBinary |
Whether to use HEX output for binary/blob data. Default and recommended is TRUE.
Expected value: boolean
Example:
cerberus.exe /UseHexForBinary true
|