|
|
|
|
Configuring Notification Scripts
To configure notification scripts:
- On the Administration / Notifications tab, click Tasks > New (or click the plus-sign icon) in the Notifications scripts section.
- In the dialog that open, specify the following options:
- Script name: Enter a friendly name for the script.
- Command: The command to execute.
- Arguments: Command line arguments to pass to the command. An argument can be one of the predefined variables, which Parallels RAS will automatically replace with an actual value. See the Command Line Variables table below (the ID column contains the values that can be used here).
- Initial directory: The full path to the current directory for the process. The string can also specify a UNC path.
- User name, Password: These are optional fields that you can specify if you would like to execute the command under a specific user account.
- When done, click OK to save the notification script item.
To modify a notification script, right-click it and choose Properties.
To delete a script, right-click and choose Delete. Please note that if a script is used by a notification handler, you will see a warning message. If you choose to delete it anyway, the script association will be removed from all notification handlers where it is used and all affected handlers will be automatically configured to send an email alert.
Command Line Variables
The following table lists command line variables that you can use as arguments when executing a script (see the Arguments option description above):
Variable |
Description |
($FARM-NAME) |
Name of the RAS Farm which has raised the notification. |
($SITE-NAME) |
Name of the RAS Site which has raised the notification. |
($SERVER-ADDRESS) |
IP address or FQDN of the server which has raised the notification. It could be an RDSH server, the server hosting a RAS Publishing Agent, RAS Secure Client Gateway, etc. |
($TRIGGER-ADDRESS) |
IP address or FQDN of the Publishing Agent that has raised the notification. |
($THRESHOLD-VALUE) |
The threshold value that is assigned to the notification handler. If a notification type doesn't support thresholds, the argument should be replaced with an empty string. |
($NOTIFICATION-TIME) |
GMT time and date of when the event has occurred. String format shall use the "R" or "r" format specifier. Please see the following article from Microsoft for details: https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings Note: The time should represent the time when the notification has occurred, and not when the notification handler has been executed. The notification handler may be executed with a delay if a grace period is enabled. |
($NOTIFICATION-TYPE) |
A numeric value that is assigned to each particular notification type. Notification type values are listed in the Notification Types table below. |
Notification Types
The following table lists supported notification types (the ID column represents values that are passed to the ($NOTIFICATION-TYPE) command line variable):
Type |
Priority |
ID |
Notes |
CPU utilization |
L |
1 |
|
Memory utilization |
L |
2 |
|
Number of active session |
M |
3 |
|
Number of disconnected sessions |
M |
4 |
|
RAS Agent connect |
H |
5 |
|
RAS Agent disconnect |
H |
6 |
|
VDI template is missing |
H |
7 |
|
Published application limit exceeded |
M |
8 |
|
Multi PA communication error |
H |
9 |
|
Authentication provider not reachable |
H |
10 |
|
% of RDSH session out of the maximum specified value |
H |
11 |
|
Gateway is tunneling X number of sessions |
H |
12 |
|
Reserved |
|
13 |
Used internally. |
Licensing events |
M |
14 |
All licensing notifications are controlled through this item. |
Session degradation |
H |
18 |
Parallels Client determines abnormal round trip time. |
Application startup time |
M |
19 |
Time to start an application. The measurement is done on the client side. |
Publishing Agent auto promotion |
|
20 |
|
Publishing Agent auto promotion failed |
|
21 |
|
Publishing Agent auto promotion failback |
|
22 |
|
License activated |
|
100 |
Controlled through "Licensing events" |
License deactivated |
|
101 |
Controlled through "Licensing events" |
License max usage |
|
102 |
Controlled through "Licensing events" |
License about to expire |
|
103 |
Controlled through "Licensing events" |
License expired |
|
104 |
Controlled through "Licensing events" |
License trial expired |
|
105 |
Controlled through "Licensing events" |
License grace period start |
|
106 |
Controlled through "Licensing events" |
License grace period end |
|
107 |
Controlled through "Licensing events" |
License disabled |
|
108 |
Controlled through "Licensing events" |
License information changed |
|
109 |
Controlled through "Licensing events" |
License failed to communicate with server |
|
110 |
Controlled through "Licensing events" |
License no file |
|
111 |
Controlled through "Licensing events" |
License invalid version |
|
112 |
Controlled through "Licensing events" |
License invalid signature |
|
113 |
Controlled through "Licensing events" |
License invalid license |
|
114 |
Controlled through "Licensing events" |
License invalid MAC address |
|
115 |
Controlled through "Licensing events" |
 Top of page |
 Feedback |