SolarWinds Backup Help

Sending remote commands to backup devices

You can manage the devices belonging to your company and your customers through remote commands. Here are some of the typical actions you may want to perform remotely: start or cancel a backup, edit a backup schedule or update the backup software.

The Backup Documents solution does not support remote commands. So if you select such a device, the Remote Commands option will be disabled.

Instructions

  1. Select one or more devices and click Remote commands on the toolbar.
  1. Select the command you want to submit.
  2. Configure parameters for the command (if applicable).
  3. Click Send.

Syntax for parameters:

  • Enter parameters one per line.
  • After the name of a parameter, enter a space and then a value, for example datasources Fs.
  • Use a comma (,) without spaces to separate the names of data sources, days, weeks and months, for example unlimitedDays Thursday,Saturday.
  • Use a vertical bar (|) without spaces to separate backup filters, for example add *.doc|*.txt|*.xlsx

Primary commands

  • Backup – starts a backup for the selected device. Unless specified otherwise, all data sources included into the backup selection are backed up.
  • Cancel – cancels all backup sessions that are currently in progress. No parameters are necessary.
  • Clear selection – removes backup selections from data sources.
  • Restore – initiates data recovery.
  • Set archiving – enables the archiving of selected backup sessions (archived sessions will not be deleted from the cloud after their retention period expires).
  • Set backup filter – applies filters to the backup selection.
  • Set bandwidth – enables bandwidth limitation during backup and restore sessions.
  • Set GUI 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.
  • Set logging level – sets a custom logging level.
  • Set scheduling – sets a backup schedule for the selected device.
  • Set selection – lets you configure the backup selection for the selected device.
  • Set settings – lets you configure different settings for the selected device.
  • Shutdown – use this command to restart the internal process associated with Backup Manager. No parameters are necessary.
  • Update – updates the backup software to the latest version. No parameters are necessary.

Advanced commands

There is a group of advanced commands reserved for some special cases. We do not recommend using them unless instructed by a support engineer.

  • Recheck – enables Backup Manager to perform a full scanning of the backup selection during the next backup session.
  • Upload audit – updates audit information for the selected device on a remote server. No parameters are necessary.
  • Upload logs – Service providers and system administrators who have access to the storage can upload application logs from the selected device there.

Parameters for remote commands

Backup

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

Clear selection

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

Recheck

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

Restore

Parameter Definition Required Supported values
datasource The data sources you want to recover data from (one at a time). Yes
  • Fs – Files and Folders
  • SystemState – System State
  • VssMsSql – MS SQL
  • Exchange – MS Exchange
  • NetworkShares – Network Shares
  • VMWare – VMware
  • VssSharePoint – MS SharePoint
  • Oracle
  • VssHyperV – Hyper-V
  • MySql – MySQL
restore_to The directory you want to recover the data to. If the parameter is skipped or if no value is submitted, the recovery will be performed to the original location (in-place restore). No A path, for example C:\Users\Admin\Documents\Reports
selection The file or directory to restore. If the parameter is skipped or if no value is submitted, all data from the selected session is restored. No A path, for example C:\Users\Admin\Desktop
time The session to restore (identified by the date and time). Yes A time and date in the following format: YYYY-MM-DD HH:MM:SS.

Set archiving

Parameter Definition Required Supported values
clear Removes all matching archived sessions (or all archived sessions if no filters are set up). The sessions are removed from the cloud and become unavailable for recovery. The action is irreversible. No N/A
datasources The data sources to archive Yes
  • Fs – Files and Folders
  • SystemState – System State
  • VssMsSql – MS SQL
  • Exchange – MS Exchange
  • NetworkShares – Network Shares
  • VMWare – VMware
  • VssSharePoint – MS SharePoint
  • Oracle
  • VssHyperV – Hyper-V
  • MySql – MySQL
  • all (default value)
name The name to assign to the new archiving rule. Yes Text.
time The time when to enable archiving. The archiving rule will be applied to the nearest backup session that starts after this time. Yes Time in the following format: HH:MM.
months The months during which to enable archiving. Yes Any of the following:
  • Jan
  • Feb
  • Mar
  • Apr
  • May
  • Jun
  • Jul
  • Aug
  • Sep
  • Oct
  • Nov
  • Dec
  • all
weekday

The days of the week on which archiving must be performed.

This parameter requires the monthweeks parameter and cannot be used together with the monthdays parameter in the same remote command.

Yes
  • Mon
  • Tue
  • Wed
  • Thu
  • Fri
  • Sat
  • Sun
monthdays

The days of the month on which archiving must be performed.

This parameter cannot be used together with weekday and monthweeks in the same remote command.

Yes The numbers of days separated by a comma (e.g. 1,3,5) or a slash for periods (e.g. 5-15).
monthweeks

The weeks during which archiving must be performed.

This parameter requires the weekday parameter and cannot be used together with the monthdays parameter in the same remote command.

Yes (unless the monthdays parameter is used) Any of the following:
  • first
  • second
  • third
  • fourth
  • last
  • all

Multiple values can be submitted.

Here are some examples.

  • A one-time archiving rule:
name Feb-2018 archive
datasources Fs,VssSharePoint
months Feb
monthdays last
time 07:00
  • A recurring archiving rule:
datasources Fs,VssSharePoint
name Weekly archive (recurring)
time 07:00
weekday Sat
monthweeks all
months all

Set backup filter

At least 1 parameter is required.

Parameter Definition Supported values
add Adds a new filter One or more filters separated by a vertical bar (|). Sample filters are provided below.
del Deletes existing filters One or more filters separated by a vertical bar (|).
clean Deletes all filters that are currently applied to the backup selection N/A

Filter formatting tips:

  • The asterisk (*) represents zero, any or all characters.
  • The question mark wildcard (?) represents any single character.

Here are some sample filters:

  • a* – Excludes all files starting with the letter a.
  • *.mp3 – Excludes all files with the .mp3 extension.
  • C:\data\*.* – Excludes all files from C:\data\ path.
  • C:\data\*.mp3 – Excludes all .mp3 files from C:\data\.
  • C:\data\*.m?? – Excludes all files from C:\data\ with a three character extension starting with .m and ending with any two other characters, such as (.mob, .mov, .mpa, .mpg, .mp3, etc).

Set bandwidth

Parameter Definition Supported values
enable The current state of the bandwidth limitation feature
  • true – enabled
  • false – disabled
start Start time of the bandwidth limitation (24-hour time format) Time (HH:MM)
stop End time of the bandwidth limitation (24-hour time format) Time (HH:MM)
upload Maximum upload bandwidth during the specified time interval (kbit/s). Applies to backup sessions. Number or unlimited for unlimited bandwidth
download Maximum download bandwidth during the specified time interval (kbit/s). Applies to recovery sessions. Number or unlimited for unlimited bandwidth
unlimitedDays The days of the week on which bandwidth limitation must be disabled The full names of days, for example "Thursday,Saturday"
datasources

The names of data sources that must not be backed up during the bandwidth limitation period (active backup sessions for them will be aborted when the limitation period starts).

  • Fs – Files and Folders
  • SystemState – System State
  • VssMsSql – MS SQL
  • Exchange – MS Exchange
  • NetworkShares – Network Shares
  • VMWare – VMware
  • VssSharePoint – MS SharePoint
  • Oracle
  • VssHyperV – Hyper-V
  • MySql – MySQL
  • all

In the following example, bandwidth limitation is enabled and applied between 08:30 and 18:30 Monday to Friday. The maximum upload (backup) bandwidth is capped at 5000 kbit/s (5 mbit/s), download (restore) bandwidth is not restricted. During the bandwidth limitation period, System State, MS SQL, VMware, MS SharePoint, Oracle, Hyper-V and MySQL backups will not run.

enable true
start 08:30
stop 18:30
upload 5000
download unlimited
unlimitedDays Saturday,Sunday
datasources SystemState,VssMsSql,VMWare,VssSharePoint,Oracle,VssHyperV,MySql

Set GUI 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

Set logging level

Parameter Definition Required Supported values
level The new logging level to apply. Yes
  • 0 - debug (includes debug, warning, error and log levels)
  • 1 - warning (includes warning, error and log levels)
  • 2 - error (include error and log levels)
  • 3 - log

Set scheduling

Parameter Definition Supported values
clear Remove all backup schedules from the device N/A
name The name to assign to the schedule (for your own reference) Text.
days The days on which backup must be performed
  • Mon
  • Tue
  • Wed
  • Thu
  • Fri
  • Sat
  • Sun
  • all
time Indicates when to start backup according to the schedule Time in the following format: "HH:MM"
datasources The names of data sources to include into the backup schedule
  • Fs – Files and Folders
  • SystemState – System State
  • VssMsSql – MS SQL
  • Exchange – MS Exchange
  • NetworkShares – Network Shares
  • VMWare – VMware
  • VssSharePoint – MS SharePoint
  • Oracle
  • VssHyperV – Hyper-V
  • MySql – MySQL
  • all

Here is a sample backup schedule you can set remotely:

datasources Fs,SystemState,MsSql,Exchange
name Daily backup
time 20:00
days Mon,Tue,Wed,Thu,Fri

Set selection

Parameter Definition Supported values
datasources The names of data sources to include into the backup selection
  • Fs – Files and Folders
  • SystemState – System State
  • VssMsSql – MS SQL
  • Exchange – MS Exchange
  • NetworkShares – Network Shares
  • VMWare – VMware
  • VssSharePoint – MS SharePoint
  • Oracle
  • VssHyperV – Hyper-V
  • MySql – MySQL
include or + The files and directories to include into the backup selection Path
exclude or - The files and directories to exclude from the backup selection Path

Set settings

Parameter Definition Supported values
EncryptionMethod Use the setting to change the encryption method.
  • AES-128
  • AES-256 (default)
  • Blowfish-448
SynchronizationThreadCount The number of simultaneous connections during backup (determines data transfer speed). A whole number from 1 to 10
MailAddress The email address for dashboards Email address
SuppressCircularLoggingMessage Use this setting to hide a message prompting users to disable circular logging before backing up MS Exchange.
  • true
  • false (default)
MailSendPeriodicity The days on which backup reports are sent out
  • 0 – daily
  • 1 – on Wednesdays and Saturdays
  • 2 – on Saturdays
  • 3 – never
TempDir The location of the temporary files created by Backup Manager. A path (set to the system Temp directory by default)
PathToLocalStorage Indicates where the local copy of the Backup Register is stored.

A path. Default values:

  • Windows Vista and greater: C:\ProgramData\MXB\Backup Manager\storage\
  • Windows XP and Windows Server 2000: C:\Documents and Settings\All Users\MXB\Backup Manager\storage\
  • Linux: /opt/MXB/var/storage/
  • macOS: /Library/Application Support/MXB/Backup Manager/storage/
LogsLocation The location of the application log on the hard drive.

A path. Default values:

  • Windows XP and Windows Server 2003: C:\Documents and Settings\All Users\Application Data\MXB\Backup Manager\logs\BackupFP
  • All Windows versions starting from Windows Vista (for client versions) and Windows Server 2008 (for server versions): C:\ProgramData\MXB\Backup Manager\logs\BackupFP
  • macOS: /Library/Logs/MXB/Backup Manager/BackupFP
  • GNU/Linux: /opt/MXB/var/log/BackupFP

Proxy parameters for the Set settings command

Parameter Definition Supported values
UseProxy Enables a connection to the Internet through a proxy server
  • true
  • false
ProxyType The type of the proxy server to use
  • HTTP
  • SOCKS4
  • SOCKS5
ProxyAddress The host name or IP address of the proxy server "192.188.33.55" or "some.server.com"
ProxyPort The port number of the proxy server Number (0 by default)
UseProxyAuthorization Prompts the backup client that the proxy requires authorization by username.
  • true – authorization required
  • false – no authorization required
ProxyUsername A username for access to the proxy server Text, for example "domain\username" or "username"
ProxyPassword The password associated with the username for access to the proxy server Text

Here are sample proxy settings for your reference:

UseProxy true
ProxyType HTTP
ProxyAddress 192.188.33.55
ProxyPort 25
UseProxyAuthorization true
ProxyUsername kowalsky
ProxyPassword 123456

Advanced commands

Upload logs

By default, the path to the log on the storage node is as follows:

  • Windows: c:\storage\<device_name>\dumps\logs\<device_name>
  • Linux: /storage/<device_name>/dumps/logs/<device_name>

<device_name> is the name of the device the log was created for.

Parameter Definition Required Supported values
server The address of the server to upload logs to. No scheme://address:port
user A username for access to the remote server. No Text
password A password associated with the user name (for access to the remote server). No Text