SolarWinds Backup Help

Variables related to devices in Cloud Management Console

Most of the variables can be applied to backup and restore sessions so you can use them in notification rules of both types (backup and restore).

General statistics

This group of variables displays basic device characteristics (their names, the names of customers they belong to, etc.) as well as creation dates for the notifications.

Variable Description Output
<%computer%> The name of the computer that the device is installed on. If there are several installations, the system will display the computer that the most recent backup/restore activity was detected on. Text
<%countPlugins%> The number of data sources that have been active during the last backup/restore session (depending on the type of the rule). Number
<%date%> Shows when the notification was created. Day, date and time. Example: Wed, 20 Jan 2015 08:49:37 GMT
<%device%> The name of the device a notification has been created for Text, for example "sales-lenovo"
<%partner%> The name of the customer the device belongs to Text
<%product%> The product assigned to the backup device (determines access to features and storage options) Text
<%timestamp%> Shows when the most recent backup/restore activity on the device took place. Time for today's activities (for example "6:13:09 PM"), month and date for activities that took place this year ("Mar 16") or month and year for older activities ("Dec 2014").
<%localSpeedVaultEnabled%> Shows if the LocalSpeedVault feature is enabled on the device.
  • true
  • false
<%backupServerSynchronizationStatus%> Shows if the local data on the client machine is synchronized with the Cloud (or with remote storage for software-only customers)
  • Failed
  • Disabled
  • Synchronizing
  • Synchronized
  • <None> (undefined)
<%localSpeedVaultSynchronizationStatus%> Shows if the LocalSpeedVault is synchronized with the Cloud (or with remote storage for software-only customers)
  • Failed
  • Disabled
  • Synchronizing
  • Synchronized
  • <None> (undefined)

Statistics for each data source

The following variables display statistics for each data source protected on a device: its name, the duration of sessions related to it, the amount of storage its data occupies and more.

Variable Description Applies to sessions Output
<%plugin.backupStatus%> The status of the last session Backup only
  • In progress
  • Completed
  • Completed with errors
  • Failed
<%plugin.duration%> The duration of the last session Backup & restore HH:MM:SS. For example, 00:25:08
<%plugin.errorsCount%> The number of errors in the last session Number
<%plugin.name%> The name of a data source One of the following:
  • Files and folders
  • Network shares
  • System state
  • Linux System State
  • Oracle
  • MySQL
  • MS SQL
  • VMware
  • Hyper-V
  • MS Exchange
  • MS SharePoint
  • SIMS
  • Virtual disaster recovery (for restore sessions only)
  • Bare-metal recovery (for restore sessions only)
<%plugin.processedCount%> The number of files processed during the last session Number
<%plugin.processedSize%> The amount of data processed during the last session Number with unit of measurement, for example "44.3 MB"
<%plugin.protectedSize%> The amount of data protected on the current backup device. All files in the backup selection and their older versions from previous backup sessions are taken into account. Backup only Number with unit of measurement, for example "44.3 MB"
<%plugin.restoreStatus%> The status of the last restore session Restore only
  • In progress
  • Completed
  • Completed with errors
  • Failed
<%plugin.selectedCount%> The number of files in the selection Backup & restore Number
<%plugin.selectedSize%> The amount of data selected for backup or recovery Number with unit of measurement, for example "44.3 MB"
<%plugin.sentSize%> The amount of data submitted to the storage (or from the storage) during the last session Number with unit of measurement, for example "44.3 MB"
<%plugin.sessionStatus%> The status of the last backup or restore session (depending on the type of the rule).
  • In progress
  • Completed
  • Completed with errors
  • Failed

Predefined text

The default email templates for failed backup and restore alerts may contain variables displaying predefined text. This text changes automatically depending on a user's locale (if a translation into that language is available). To use your own text, remove the corresponding variable from the notification template. If necessary, update the translated versions as well.

Variable Text displayed
<%computerCaption%> Computer name:
<%helloMessage%> Dear customer,
<%infoMessage%> We are writing to let you know that something has gone wrong with one of your recent backups. We hope the details provided below help you resolve the issue.
<%restoreInfoMessage%> We are writing to let you know that something has gone wrong with one of your recent restores. We hope the details provided below help you resolve the issue.
<%detailsMessage%> Details:
<%datasourceCaption%> Data source:
<%deviceCaption%> Device name:
<%partnerCaption%> Partner name:
<%productCaption%> Product:
<%sessionStatusCaption%> Status:
<%signMessage%>

Please don't hesitate to contact us if you need help.

Best regards,

your backup team