> Expert > CommCell Management > Operating and Monitoring the Backup Environment > Alerts and Notifications > Alert Tokens

Available Alert Tokens

The following table describes all the available alert tokens.

Token

Description

<ADDITIONAL VM INFO>

The virtual machine used space in gigabytes. To display the used space in the alert notification, you must do the following:

  • On the Threshold and Notification Criteria Selection page of the alert wizard, select the Send individual notification for each backed up discovered machine check box.

  • To the CommServe computer, add the NotificationVMPropvmUsedSpace additional setting as shown in the following table.

    For instructions on adding additional settings from the CommCell Console, see Adding or Modifying Additional Settings from the CommCell Console.

    Property

    Value

    Name

    NotificationVMPropvmUsedSpace

    Category

    CommServDB.GxGlobalParam

    Type

    INTEGER

    Value

    1

<AGENT TYPE NAME>

The name of the agent.

<ALERT CATEGORY - ALERT TYPE>

The alert category and type.

<ALERT NAME>

The alert display name.

<ALL CLIENT LIST>

A list of all the clients for which updates are selected to be installed.

<AUDIT INFO>

Information regarding the detected condition.

<BACKUPSET NAME>

The name of the backup set.

<CLIENT DESCRIPTION>

The description of the client.

<CLIENT DISPLAY NAME>

The display name of the client.

The token in the alert with Email, Console Alerts and Save to notification types contains a link to the entity page in the Command Center.

<CLIENT GROUP LIST>

The client computer groups the client belongs to.

You can add the <client group list> token for the Data Protection and the Data Recovery alert types in the Job Management category and the Clients alert type in the Configuration category.

By default, the token displays all the client computer groups that the client is a member of.

To display only the client computer groups that the client computer is a member of and that are selected in the alert, enable the nShowOnlySelectedgroups additional setting.

<CLIENT GROUP NAME>

The name of the client computer group.

The token in the alert with Email, Console Alerts and Save to notification types contains a link to the entity page in the Command Center.

<CLIENT HOST NAME>

The name of the client host.

<CLIENT LIST>

The name of the clients included in the operation.

<CLIENT NAME>

The name of the client.

The token in the alert with Email, Console Alerts and Save to notification types contains a link to the entity page in the Command Center.

<CLIENT_OS_NAME>

The name of the client operating system, for example, Windows Server 2012 R2 Datacenter.

<CLIENT_OS_TYPE>

The type of the client operating system, for example, Windows.

<CLIENT_OS_SUBTYPE>

The subtype of the client operating system, for example, Server.

<CLIENT_OS_VERSION>

The version of the client operating system, for example, New.

<CLIENT_OS_PLATFORM>

The platform of the client operating system, for example, WinX64.

<CLIENT RELEASE LIST>

A list of client names and releases.

<CLIENT STATUS LIST>

A list of client names and the status of the update installation operation on each client.

<CLIENT VERSION>

The version of the client, for example, V11 SP25.

<COMMCELL NAME>

The name of the CommCell.

The token in the alert with Email, Console Alerts and Save to notification types contains a link to the entity page in the Command Center.

<COMMENT>

Information regarding the detected condition.

<CONDITION CLEARED Y/N>

Informs a user if the detected condition has cleared.

<CONTENTS>

The list of updates available for download.

<CONTENTS DOWNLOADED>

The list of updates downloaded.

<COPIED DATA SIZE>

The size of data that was copied. The sizes are displayed in bytes, MB, GB or TB.

<COPIED MEDIA LIST>

The list of media that was copied.

<COPY NAME>

The copy name.

<CS UPGR TIME>

The last time the CommServe was upgraded.

<CURRENT BACKUP SIZE>

The current size of the backup data. The sizes are displayed in bytes, MB, GB or TB.

<DATA WRITTEN>

The size of the data written in a backup job. File sizes are displayed in bytes, MB, GB or TB.

<DESCRIPTION>

Information regarding the condition detected.

<DESTINATION CLIENT>

The client to which data will be restored.

<DESTINATION LOCATION>

Media destination location.

<DETECTED CRITERIA>

Alert criteria that was detected.

<DIRECTORY WITH LOW SPACE>

The path to the directory that triggered the low space alert.

<DISK SPACE INFO>

Disk space information: volume name, volume size, free space. The volume sizes are displayed in bytes, MB, GB or TB.

<DISK SPACE LOW Y/N>

Informs user if the disk space for the software installation directory, CommCell database, QSnap, or ContinuousDataReplicator is low.

<DOWNLOAD SIZE (MB)>

The size of the files that have been downloaded.

<DRIVE NAME>

The name of the drive.

<DRIVEPOOL NAME>

The name of the drive pool.

<ELAPSED TIME>

The amount of time used for the operation.

<END TIME>

The time the operation ended.

<ERR CODE>

The error code for the job pending or job failure reason.

<EVENT DATE>

The date when the event happened.

<EVENT ID>

The event ID number.

<EVENT PROGRAM>

The CommCell service involved in the event execution.

<EVENT SEVERITY>

The severity level of the event.

<EXCLUDED FROM SLA>

Indicates whether the entity is excluded from SLA metrics.

<EXPORT LOCATION>

The name of the media export location.

<ENTENDED RET.CANDIDATE Y/N>

Indicates whether the job qualifies for extended retention.

<FAILED ATTEMPT TIME LIST>

The time at which failed login occurred.

<FAILED ATTEMPTS COUNT>

The number of failed login attempts.

<FAILED CLIENT LIST>

A list of clients that failed to install updates.

<FAILED COUNT>

The number of failed objects.

<FAILED JOBS COUNT>

The number of failed jobs.

<FAILED JOBS THRESHOLD>

The system threshold for failed jobs.

<FAILED OBJECTS>

A list of failed objects in an attachment. This token is not available if you are using the "save to cloud" alert notification type. For information on saving to cloud, see Setting up Save to Cloud Alert Notifications

<FAILURE REASON>

A reason why there was a failure.

<FILES DOWNLOADED>

A list of the downloaded files.

<FORCE DECONFIG Y/N>

Informs a user if a CommCell object was de-configured.

<FREE SPACE>

Free space on related volume.

<GUI CLIENT NAME>

Name of the client displayed in the user interface.

<INITIATER>

Vault Tracker policy name that initiated the Vault Tracker action.

<INSTANCE NAME>

The name of the instance.

<JOB DESCRIPTION>

The description on the Startup tab in the Advanced Backup Options dialog box. To update the description, do the following:

  1. Go to Policies > Schedule Policies, right-click a schedule policy, and click Edit.

  2. On the General tab under Tasks, double-click a schedule.

  3. In the Backup Task Options dialog box, click Advanced.

  4. In the Advanced Backup Options dialog, on the Startup tab, make your changes in the Description box.

<JOB ID>

The Job ID assigned by the Job Manager for the job.

The token in the alert with Email, Console Alerts and Save to notification types contains a link to the entity page in the Command Center.

<JOB OPERATION>

The type of job, for example, Data Aging.

<JOBS RUNNING CLIENT LIST>

A list of client names that have jobs running at the time of update installation.

<JOB STARTED FROM>

The user (interactive) or scheduler that started the job.

<JOBS TOBE COPIED>

The number of jobs to be copied.

<LEVEL>

The backup level. Note: For a File Archiver iDataAgent the status of the Index will be displayed for this token.

<LIBRARY NAME>

The name of the library.

<LICENSE EXPIRED>

The name of the license that will expire.

<LINES ABOVE MATCHED LINE>

The number of lines in a log that come before the line that matches the criteria specified in a monitoring policy.

<LINES BELOW MATCHED LINE>

The number of lines in a log that come after the line matching that matches the criteria specified in a monitoring policy.

<LOW CACHE CLIENT LIST>

A list of client names that have low cache at the time of update installation.

<MAILBOX NAME>

The name of the mailbox.

<MATCHED LINE NUMBER>

The number of the line in the log which matches the criteria specified in a monitoring policy.

<MATCHED LINE>

An output of the line in the log which matches the criteria specified in a monitoring policy.

<MATCHED LOG FILE>

The name of the log file where a log event occurred matching the criteria specified in a monitoring policy.

<MESSAGE COUNT>

The number of messages in the mailbox.

<MEDIA LABEL>

The label/barcode of the media.

<MEDIA FAILED>

The media that failed to be erased.

<MEDIA LIST>

A list of media used during the operation.

<MEDIA LOCATION LIST>

A list of media and their locations.

<MEDIA REQUIRE LIST>

The media required for a data recovery operation.

<MEDIA SPACE LEFT>

For disk media, the space remaining on a disk. For tape media, the remaining spare media in a scratch pool.

This token can be used for comparative integer values. The values are displayed in GB.

<MEDIA SUCCEEDED>

The media that was successfully erased.

<MEDIA TO BE COPIED COUNT>

The number of media to be copied.

<MEDIAAGENT NAME>

The name of the MediaAgent.

The token in the alert with Email, Console Alerts and Save to notification types contains a link to the entity page in the Command Center.

<MONITORING CRITERIA STRING>

The filtering criteria to monitor certain operations, such as events, logs, and so on.

<MONITORING POLICY NAME>

The name of the monitoring policy.

<MORE MEDIA Y/N>

A yes/no token, which specifies whether more media is to be exported.

<MOUNTPATH NAME>

The name of the mount path.

<NEED REBOOT CLIENT LIST>

A list of clients that must be rebooted before installing updates.

<NO. OF DAYS LEFT FOR LICENSE EXPIRY>

The number of days remaining until license expires.

<NUMBER OF ITEMS>

For data protection alerts, when the increase in object count by n% option is selected, it is the number of items backed up during the operation.

For data recovery alerts, when the increase in object count by n% option is selected, it is the number of items restored or recovered during the operation.

<OLDEST JOB ENDDATE>

The end date of the oldest job to be copied.

<OPERATION PERFORMED BY USER>

The CommCell user who initiated the operation on a user or user group. Use this token with the Configuration - Users and Configuration - User Group alerts.

<OPERATION TYPE>

The name of the operation.

<ORGANIZATION NAME>

The name of the organization (company) the client belongs to.

<OTHER LIBRARY>

The library to which the media belongs.

<OWNER EMAIL>

The email address of the user who created the alert.

<OWNER NAME>

The user who created the alert.

<PENDING JOBS COUNT>

The number of pending jobs.

<PENDING JOBS THRESHOLD>

The system threshold for pending jobs.

<PERCENTAGE CHANGE>

The percentage change of data size from previous job to current job.

<PERCENTAGE INCREASE IN OBJECT COUNT>

The percentage increase in the number of backed up files from the previous job to the current job of the same job types. This token is available for data protection alerts when the increase in object count by n% option is selected.

<PREVIOUS JOB ID>

The previous job identification number.

<PREVIOUS JOB OBJECT COUNT>

The number of backed up files in the previous job of the same job type. This token is available for data protection alerts when the increase in object count by n% option is selected.

<PREVIOUS BACKUP SIZE>

The previous backup job data size. The sizes are displayed in bytes, MB, GB or TB.

<PROPERTY MODIFIED Y/N>

A yes/no token, which specifies whether a property has been modified.

<PROTECTED COUNT>

The number of protected objects.

<PROTECTED OBJECTS>

A list of protected objects and file sizes in an attachment. File sizes are displayed in bytes. This token is not available if you are using the "save to cloud" alert notification type. For information on saving to cloud, see Setting up Save to Cloud Alert Notifications

<PRUNED JOB COUNT>

The number of jobs that have aged.

<PRUNED MEDIA BARCODE LIST>

The barcode list of aged media.

<RETAIN UNTIL>

The predicted ending retention date of the job.

<RECOVERED COUNT>

The number of objects recovered.

<RECOVERED OBJECTS>

A list of recovered objects and file sizes in an attachment. File sizes are displayed in bytes. This token is not available if you are using the "save to cloud" alert notification type. For information on saving to cloud, see Setting up Save to Cloud Alert Notifications

<REPSET NAME>

The name of the replication set.

<RESOURCE WAIT TIME>

Time elapsed while a job is waiting for a resource.

<RESTORE USER NAME>

The user that initiated the restore operation from the Search Console.

<SHARE ENTITY INFO>

The shared file or folder information about whether the file or folder was modified along with link to view the file or folder from Webconsole.

<SCHEDULE NAME>

The name of the schedule.

<SCHEDULE TIME>

The time the operation was scheduled.

<SERVER RELEASE>

CommCell release number.

<SEVERITY>

The severity of the alert. The severity can be defined directly on the alert in the Severity box. For event viewer events, the event severity is used. The Valid values are:

  • Critical

  • Major

  • Minor

<SEVERITY INT>

The code for the alert severity. Valid values are:

  • 0, automatically picked

  • 1, critical

  • 2, warning (major)

  • 3, information (minor)

<SIZE>

The size of the files restored during the operation. The sizes are displayed in bytes, MB, GB or TB.

<SIZE OF DATA TOBE COPIED>

The size of the data to be copied. The sizes are displayed in bytes, MB, GB or TB.

<SKIPPED COUNT>

The number of objects that were skipped during a data recovery operation.

<SKIPPED OBJECTS>

A list of skipped objects in an attachment. This token is not available if you are using the "save to cloud" alert notification type. For information on saving to cloud, see Setting up Save to Cloud Alert Notifications

<SNAPSHOT VOLUME UNIT>

The name of the snapshot volume unit.

<SOURCE CLIENT>

The client from which data will be recovered.

<SOURCE LOCATION>

The name of the source location.

<SP LIST>

A list of the storage policies used in the operation.

<SP NAME>

The name of the storage policy.

<SPAREPOOL/MOUNTPATH NAME>

The spare media pool or mount path name.

<START TIME>

The time the operation started.

<STATUS>

The status of the operation.

<STORAGE POLICIES USED>

The name of the storage policies associated with the data protection operation.

<SUBCLIENT DESCRIPTION>

The description of the subclient.

<SUBCLIENT NAME>

The name of the subclient.

<SUBJECT BEGIN>

The beginning of the notification.

<SUBJECT END>

The end of the notification.

<SUCCEEDED JOBS COUNT>

The number of successful jobs.

<SUCCESSFUL CLIENT LIST>

A list of clients that were updated successfully.

<THRESHOLD>

The threshold value for the library, drive and media.

<THRESHOLD FOR LOW SPACE>

The low space threshold value.

<TIME>

The time (as per the time zone of the CommServe) the condition was detected.

<TRANSIT LOCATION>

The name of the transient location.

<UNKNOWN CLIENT LIST>

A list of clients whose status was unable to be determined after the installation of updates.

<UNREACHABLE CLIENT LIST>

A list of clients that are unreachable.

<UP-TO-DATE CLIENT LIST>

A list of clients that already have all of the updates required.

<USER GROUP NAME>

The CommCell user group who the alert was trigger for (for example, the user group whose properties were modified).

The token in the alert with Email, Console Alerts and Save to notification types contains a link to the entity page in the Command Center.

<USER ID>

The user ID assigned by the system.

<USER NAME>

The CommCell user who initiated the operation.

The token in the alert with Email, Console Alerts and Save to notification types contains a link to the entity page in the Command Center.

For the Configuration - Users and Configuration - User Group alerts, this is the CommCell user who the alert was trigger for (for example, the user whose properties were modified). To see the user who initiated the operation, use the <OPERATION PERFORMED BY USER> token.

<USER NAME LIST>

A list of user names entered for the failed login attempts.

<USER LOGIN NAME>

The login name of the user.

<UTC_TIME>

The time the condition was detected as displayed in UTC time.

<VOLUME NAME>

The name of the volume.

<VIRTUAL MACHINE HOST NAME>

The name of the virtual machine host.

<VIRTUAL MACHINE NAME>

The name of the virtual machine.

<VIRTUAL MACHINE INSTANCE UUID>

The instance UUID of the virtual machine.

<VM FAILURE REASON>

The reason for the virtual machine failure.

<VM STATUS>

The status of the virtual machine.

<PARTIALSUCCESS VMS>

If the status for a specific virtual machine is Partial Success, some information for the VM was successfully backed up, but other information was not.

<FAILED VMS>

The virtual machine backup that is marked as failed.

<WORKFLOW>

The name of the Recovery Director workflow.

<XFER BYTES>

Data transferred in bytes.

<XFER GB PER HOUR>

Data transferred in gigabytes per hour.

<XFER SECS>

Number of seconds for the data transfer to occur.

<XFER SIZE>

Amount of data transferred automatically displayed in the size unit respective of the size amount. Refer to the following:

Amount of data transferred

Amount automatically displayed

Less than 1 MB

Bytes

Greater than 1 MB, Less than 1 GB

Megabytes

Greater than 1 GB

Gigabytes

<AUTOMATED CONTENT CLASSIFICATION_POLICY_NAME>

The name of the Automated Content Classification Policy.

<LEGAL HOLD PHASE SELECTED Y/N>

A yes/no token, which specifies whether Legal Hold phase is selected.

<NO.OF ITEMS FAILED IN LEGAL HOLD PHASE>

Number of items failed in Legal Hold phase.

<NO.OF ITEMS FAILED IN RESTORE TO REVIEW SET PHASE>

Number of items failed in Restore to Review Set phase.

<NO.OF ITEMS FAILED TO RESTORE>

Number of items failed to restore.

<NO.OF ITEMS SELECTED FOR LEGAL HOLD>

Number of items selected for Legal Hold.

<NO.OF ITEMS SELECTED TO RESTORE TO REVIEW SET>

Number of items selected for restoring to review set.

<NO.OF ITEMS SELECTED TO RESTORE>

Number of items selected for restore.

<NO.OF ITEMS SELECTED TO SEARCH>

Number of items selected for search.

<NO.OF ITEMS SUCCEEDED IN LEGAL HOLD PHASE>

Number of items succeeded in Legal Hold phase.

<NO.OF ITEMS SUCCEEDED IN RESTORE TO REVIEW SET PHASE>

Number of items succeeded in restore to review set phase.

<PHASES_IN_JOB>

List of phases for the job.

<RESTORE PHASE SELECTED Y/N>

A yes/no token, which specifies whether restore phase is selected.

<RESTORE TO REVIEW SET PHASE SELECTED Y/N>

A yes/no token, which specifies whether restore to review set phase is selected.

<STATUS OF LEGAL HOLD PHASE>

Status of the Legal Hold phase.

<STATUS OF RESTORE PHASE>

Status of the restore phase.

<STATUS OF RESTORE TO REVIEW SET PHASE>

Status of the restore to review set phase.

Loading...