Primary Remote Commands

The list of remote commands is divided into three sections; Primary commands, Secondary commands, and Advanced commands.

We do not recommend using advanced commands unless instructed by a support engineer.

  • Backup now – starts a backup for the selected device. Unless specified otherwise, all data sources included into the backup selection are backed up
  • Cancel backups in progress – cancels all backup sessions that are currently in progress on the selected device(s). No parameters are necessary

    All in progress restores will also be canceled.

  • Restart backup process - use this command to restart the internal process associated with Backup Manager. No parameters are necessary
  • Set Backup Manager password – use this command to limit access to Backup Manager. It will be necessary to enter the password you have assigned to open Backup Manager. All the preferences stay unchanged and backups continue running according to the schedule
  • Update Backup Manager – updates the backup software to the latest version. No parameters are necessary

Parameters

Backup now

Parameter Definition Required Supported values
datasources The data sources to back up. No
  • Fs – Files and Folders
  • SystemState – System State
  • MsSql – MS SQL
  • Exchange – MS Exchange
  • NetworkShares – Network Shares
  • VMWare – VMware
  • VssMsSql - VssMsSql
  • VssSharePoint – MS SharePoint
  • Oracle
  • VssHyperV – Hyper-V
  • MySql – MySQL
  • all (default value)

Here are some examples.

  • Run a backup for all data sources:
    • datasources all
  • Run a backup for Files and Folders and System State:
    • datasources Fs,SystemState

Set Backup Manager password

Parameter Definition Supported values
password Enter the password that will be required to start Backup Manager

Text.

  • To disable the feature, submit the parameter with no value.
  • To reset the current password, submit the command with a new password.
restore_only The parameter sets Backup Manager to the restore-only mode when the GUI password is enabled.
  • allow
  • disallow

Here are some examples.

  • Set new password and set the device to Restore-Only mode when the password is set:
    • password 213TestingS3curE
restore_only allow
  • Remove password and allow full mode if a new password is set:
    • password
restore_only disallow