Remote commands

Download

The list of remote commands

• backup — launch backup process for the account/group remotely.
• cancel — cancel backup process for the account/group remotely.
• recheck — force all files to be rechecked while the next backup for the account/group remotely.
• reset — BackupFP remote reinitialization for the account/group.
• set logging level — set non-standard logging level for the account/group.
• upload logs — upload logs from the account/group side.
• set backup filter — add, delete, clean filters for the account/group remotely.
• set scheduling — set scheduling for the account/group remotely.
• set selection — set selection for the account/group remotely.
• set settings — set settings for the account/group remotely.
• upload audit — update audit information for the account/group on the server side remotely.
• check consistency — check consistency for the account/group remotely.
• set sql authentication — set MSSQL (only through DMO) authentication option.
• force commit backup register — recheck and commit backup register.
• migrate to mssql vss — complete migration from using backup MSSQL through DMO to VSS.
• clear selection — remove selection from plugins.
• update — update Client to a newer version.

Remote command sending

Send remote command

to an account

Click right mouse button on an account/several selected accounts you would like to send a remote command to and select "Send remote command...";

to a group

1. Click right mouse button on a group in the "Groups" tab you would like to send a remote command to and select "Send remote command...";

2. Select a group in the "Groups" tab, click on the "Groups" menu and select "Send remote command...";

Remote commands

Select a remote command to send.

backup

This command launches backup process for the account/group you have selected remotely. It has no parameters. So just click "Ok" button to send it.

cancel

This command launches cancelling process for the account/group you have selected remotely. It has no parameters. So just click "Ok" button to send it.

recheck

This command forces all files from the selected plugins to be rechecked while the next backup for the account/group remotely.

To select the plugin(s) please fill in "Parameters" field with word "plugins" + space + the list of plugins separated by comma/word "all" to recheck all plugins. Click "Ok" button to send it.

The names of plugins:

• Fs for the File System plugin;
• SystemState for the System State plugin;
• MsSql for the MsSQL plugin;
• Exchange for the Exchange plugin;
• NetworkShares for the Network Shares plugin.

reset

This command reinitializes BackupFP for the account/group remotely. It has no parameters. So just click "Ok" button to start it.

set logging level

This command sets non-standard logging level for the account/group.

To select the level of logs please fill in "Parameters" field with word "level" + space + the number of log level. Click "Ok" button to send it.

Levels of logs:

• 0 — debug (include debug, warning, error and log levels);
• 1 — warning (include warning, error and log levels);
• 2 — error (include error and log levels);
• 3 — log (include only log level).

upload logs

This command uploads logs from the account/group side to the server.

To upload logs to the server where please specify following "Parameters":

• word "server" + space + server IP on the first line,

• word "user" + space + user name for the stat server login on the second line,

• word "password" + space + password for the entered user on the third line.

Click "Ok" button to send it. Just draw your attention to the following facts:

• If server, user and password are specified, all logs are uploaded to: server_IP\localuser\backup_admin\logs\server_IP\contract_name\
• If these parameters are not specified, all logs are uploaded to: server_IP\localuser\common_user\dumps\logs\contract_name\

set backup filter

This command sets backup filters (add, delete, clean) for the account/group remotely.

To add a new filter please fill in "Parameters" field with word "add" + space + a filter,

To delete an old filter please fill in "Parameters" field with word "del" + space + a filter,

To clean all filters please fill in "Parameters" field with word "clean".

Click "Ok" button to send it.

set scheduling

This command sets scheduling for the account/group remotely.

To set scheduling please fill in "Parameters" field with:

• word "clear" to clear scheduling;

or

• word "plugins" + space + plugins list to backup separated by comma or all on the first line:
  • Fs for the File System plugin;
  • SystemState for the System State plugin;
  • MsSql for the MsSQL plugin;
  • Exchange for the Exchange plugin;
  • NetworkShares for the Network Shares plugin.
• word "time" + space + time in format HH:MM on the second line.
• word "days" + space + comma separated list of short English days of week or all on the third line:
  • Mon for Monday;
  • Tue for Tuesday;
  • Wed for Wednesday;
  • Thu for Thursday;
  • Fri for Friday;
  • Sat for Saturday;
  • Sun for Sunday.

Click "Ok" button to send it.

set selection

This command sets selection for the account/group remotely.

To set selection please fill in "Parameters" field with following values:

• word "clear all" to remove all selections;
• word "plugin" + space + name of plugin to backup on the first line:
  • Fs for the File System plugin;
  • SystemState for the System State plugin;
  • MsSql for the MsSQL plugin;
  • Exchange for the Exchange plugin;
  • NetworkShares for the Network Shares plugin.
• word "include"/"+" + space + path of file or folder to include to backup on the second line.
• word "exclude"/"-" + space + path of file or folder to exclude from backup on the third line.

Click "Ok" button to send it.

set settings

This command sets settings for the account/group remotely.

To set settings please fill in "Parameters" field with followin values:

• word "User" + space + new username;
• word "Password" + space + new password;
• word "PasswordPolicy" + space + policy rules ("|" — separator of rules, "-" — diapason of rules, "," — enumeration of rules, ":" — separator of symbols and quantity in a rule; e.g. "A-Z,a-z:6|a-z:1|0-9:2|!,$,#,%:2" means that scrambled password has to contain 6 letters, one of them in a lower case, 2 numbers and 2 symbols from the set {!,$,#,%});
• word "EncryptionKey" + space + new encryption key;
• word "EncryptionMethod" + space + encryption method name from the following values:
  • Unencrypted;
  • AES-128;
  • AES-256;
  • Blowfish-448.
• word "ConnectionCheckInterval" + space + connection check interval in seconds;
• word "Protocol" + space + protocol name from the following values:
  • FS;
  • FTPS:443.
• word "Server" + space + server IP;
• word "PackageServer" + space + package server IP;
• word "StatsServer" + space + stats server IP;
• word "UseProxy" + space + one from the following values:
  • true;
  • false.
• word "ProxyType" + space + proxy type from the following values:
  • HTTP;
  • SOCKS4;
  • SOCKS5.
• word "ProxyAddress" + space + proxy address;
• word "ProxyPort" + space + proxy port;
• word "UseProxyAuthorization" + space + one from the following values:
  • true;
  • false.
• word "ProxyUsername" + space + proxy username;
• word "ProxyPassword" + space + proxy password;
• word "ReconnectProbability" + space + value from diapason (0..100);
• word "PathToLocalStorage" + space + path to local storage;
• word "LogPath" + space + path to log files;
• word "TempDir" + space + path to the temporary directory;
• word "MsSqlDeltaRestore" + space + one from the following values:
  • true;
  • false.
• word "SuppressCircularLoggingMessage" + space + one from the following values:
  • true;
  • false.
• word "MailAddress" + space + mail address for Dashboards;
• word "MailSendPeriodicity" + space + periodicity numeric from the following values:
  • 0 = Daily;
  • 1 = WednesdayAndSaturday;
  • 2 = Saturday;
  • 3 = Never.

Click "Ok" button to send it.

upload audit

This command updates audit information for the account/group on the server side. It has no parameters. So just click "Ok" button to start it.

check consistency

This command checks consistency for the account/group remotely.

To check missing slices please fill in "Parameters" field with sentence "level MissingSlices",

To check missing cabinets please fill in "Parameters" field with sentence "level MissingCabinets",

To check mishashed parents please fill in "Parameters" field with sentence "level MishashedParents",

To start check in repair mode please add line "repair true"

Click "Ok" button to send it.

set sql authentication

This command sets MSSQL (only through DMO) authentication option.

To set authentication please fill in "Parameters" field with following values:

• word "instance" + space + name of the MSSQL instance;
• word "username" + space + name of the user with administrator rights for the MSSQL instance;
• word "password" + space + password for the user;
• word "windowsauth" + space + one from the following values:
  • 1 — if windows authentication is used;
  • 0 — if windows authentication is not used.

force commit backup register

This command rechecks and commits backup register. To start it, just click on the "Ok" button without specifying any parameters.

migrate to mssql vss

This command completes migration process of MSSQL from backup through DMO to backup through VSS. This command does not require any parameters too therefore just click on the "Ok" button and the command will be started.

clear selection

This command removes selection from plugins.

To set plugins for deletion please fill in "Parameters" field with following values:

• word "plugin" + space + comma-separated names of plugins to clear selection:
  • Fs for the File System plugin;
  • SystemState for the System State plugin;
  • MsSql for the MsSQL plugin;
  • Exchange for the Exchange plugin;
  • NetworkShares for the Network Shares plugin;
  • VMWarefor the VMware plugin;
  • VssMsSql for the VssMsSql plugin.

update

This command updates Client to a newer version. This command does not require any parameters therefore just click on the "Ok" button to start it.

set bandwidth

This command sets bandwidth settings for the account/group remotely.

To set bandwidth please fill in "Parameters" field with following values:

• word "enable" + space + one from the following values:
  • true;
  • false.
• word "start" + space + start time in format HH:MM;
• word "stop" + space + stop time in format HH:MM;
• word "bandwidth" + space + maximum bandwidth during limited hours (kbit/s);
• word "weekends" + space + one from the following values:
  • true;
  • false.
• word "plugin" + space + name of plugin to cancel separated by comma or "all":
  • Fs for the File System plugin;
  • SystemState for the System State plugin;
  • MsSql for the MsSQL plugin;
  • Exchange for the Exchange plugin;
  • NetworkShares for the Network Shares plugin;
  • VMWare for the VMware plugin;
  • VssMsSql for the Vss MsSQL plugin;
  • VssSharePoint for the Vss SharePoint plugin;
  • Oracle for the Oracle plugin.

Click "Ok" button to send it.

uninstall

This command launches uninstall process for the account/group you have selected remotely. It has no parameters. So just click "Ok" button to send it.

Sent command

If "Parameters" field is correctly filled in, the message about successful command sending appears, otherwise an error message appears, in this case please send a command once more.

Download