Command
Type |
Description |
Argument |
Description |
Acknowledge Alert |
Specify the ID, or list
of IDs, for the alerts to acknowledge. Once
an alert is acknowledged, the AlertTable Acknowledged field
updates and if the reNotificationTime is greater than zero, it does not
re-execute. |
ID |
The ID of
the alert to acknowledge. This can either be a single ID or a semi-colon (;)
delimited list of IDs. |
Add Alert Definition File |
Adds an
Alert
Definition file to the data source. Alerts without names or with duplicate names are not added. |
Alert Definition File |
Name of
the
Alert
Definition file. |
Substitution |
Specify substitutions
for this Alert Definition File. Substitutions are optional and must use the following syntax:
$subname:subvalue $subname2:subvalue2
If a substitution value contains
a single quote, it must be escaped using a / :
$filter:Plant=/'Dallas/'
If a substitution value contains
a space, it must be enclosed in single quotes. Do not escape these single
quotes:
$subname:subvalue $subname2:'sub
value 2'
A substitution string cannot contain
the following:
:
|
|
|
.
|
tab
|
space
|
,
|
;
|
=
|
<
|
>
|
'
|
"
|
& |
/ |
\ |
{ |
} |
[ |
] |
( |
) |
|
Enable Alert Definition |
Enables/disables the
specified alert definition object.
NOTE: It is not recommended that you use
this command on an alert that has the enabledFlag property attached to
data. |
Alert Name |
The name of the alert
definition object. |
Enable
|
Enter True to enable
and False to disable. |
Enable Alerts |
Enables/disables
all alerts in the active Alert
Definition files. |
Enable
|
Enter True to enable
and False to disable. |
Remove Alert Definition |
Removes the
Alert
Definition file from the data source. |
Alert
Definition |
The name of
the Alert
Definition file. |
Substitution |
Specify substitutions
for this Alert Definition file. This must match the substitution used
when the Alert
Definition file was added.
|
Update
Self Service Alerts Table |
Modify
an alert setting. NOTE: This command is only
available if Self Service Alerts are
enabled and RTView has successfully connected to the Alert Settings Table. |
Alert
Name |
Name of the alert. |
Warning
Threshold Value |
Warning threshold value to store. If this value is
not a double, a null value will be stored. |
Alert
Threshold Value |
Alert threshold value to store. If this value is not
a double, a null value will be stored. |
Duration |
Duration value to store. If this value is not an
integer, a null value will be stored. |
Enabled
|
Enabled value to store. This can be a boolean
(true/false) or 0/1. Other values will be stored as false. |
User
|
User name to specify in the Audit Table for this
update. NOTE: To specify value of user name from RTView login, if enabled, use
$rtvuser substitution. |
Add Comment |
Adds a
time-stamped comment to the specified alert. NOTE: Existing comments on the
alert are not replaced, the new comment is added after previous comment(s). |
ID |
The ID of the alert on which to add a new comment. |
Comment |
Enter comment. |
Clear
Comments |
Clears all comments
from the specified alert. |
ID |
The ID of the alert on which to clear all comments. |