Configuring notification scripts

To configure notification scripts:

1. On the Notifications tab, click Tasks > New (or click the plus-sign icon) in the Notifications scripts section.

2. 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.

3. 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):

($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 Connection Broker, RAS Secure Gateway, etc.
($TRIGGER-ADDRESS)	IP address or FQDN of the Connection Broker 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):

CPU utilization	1	This notification is triggered when CPU utilization rises above or decreases below a certain value.
Memory utilization	2	This notification is triggered when memory utilization rises above or reaches below a certain value.
Number of active session	3	This notification is triggered when the number of active sessions rises above or decreases below a certain value.
Number of disconnected sessions	4	This notification is triggered when the number of disconnected sessions rises above or decreases below a certain value.
RAS Agent reconnect	5	Agent reconnected.
RAS Agent disconnect	6	Agent disconnected.
VDI template is missing	7	This notification is triggered when an a VDI event occurs (e.g. a template is not found).
Published application limit exceeded	8	This notification is triggered when a published item event occurs (e.g. an application's instance limit is exceeded).
Multi CB communication error	9	Multiple CB communication error.
Authentication provider not reachable	10	This notification is triggered when a connection issue occurs with an authentication server.
% of RDSH session out of the maximum specified value	11	This notification is triggered when the number of RDSH sessions rises above or decreases below the specified percentage of the maximum number of sessions.
Gateway is tunneling X number of sessions	12	This notification is triggered when the number of gateway tunnelled sessions rises above or decreases below a certain value.
% of RDSH disconnected session out of the maximum specified value	13	This notification is triggered when the number of RDSH disconnected sessions rises above or decreases below the specified percentage of the maximum number of sessions.
Connection Broker auto promotion	20	Connection Broker auto promotion
Connection Broker auto promotion failed	21	Connection Broker auto promotion failed.
Connection Broker auto promotion failback	22	Connection Broker auto promotion failback.
CA not available	30	This notification is triggered when a connection issue occurs Certificate Authority.
License site switched to failed over mode	50	Connection Broker failover mode.
License site is offline	51	Licensing site is offline.
License site reconnected	52	Licensing site is back online.
IP of Licensing CB changed	53	Licensing Connection Broker IP change.
Hostname of Licensing CB changed	54	Licensing Connection Broker Hostname change.
IP of secondary CB changed	55	Non Licensing Connection Broker IP change.
Hostname of secondary CB changed	56	Non Licensing Connection Broker Hostname change.
Templates max guests reached	60	Template max guest limit reached.
Template max servers reached	61	Template maximum server limit reached
Templates cloning failed	62	Template cloning failed.
License activated	100	This notification is triggered when a licensing event occurs (e.g. a farm has been successfully activated).
License deactivated	101	License was deactivated.
License max usage	102	The maximum license usage has reached x%.
License about to expire	103	If license is about to expire, notify every day saying how many days left.
License expired	104	License expired.
License trial expired	105	Trial period expired
License grace period start	106	Grace period started.
License grace period end	107	Grace period ended.
License disabled	108	License was disabled.
License information changed	109	License information changed
License failed to communicate with server	110	Failed to communicate with licensing server.
License no file	111	Failed to load license file.
License invalid version	112	Invalid license file version.
License invalid signature	113	Invalid license signature.
License invalid license	114	System errors.
License invalid MAC address	115	Invalid MAC address (hardware change).
Licensing unsigned grace period	116	Migration grace period started.
Tenant enrolled	200	This notification is triggered when an event related to any registered tenant occurs (e.g. a new tenant was added to Tenant Broker or tenant becomes unavailable).
Tenant status changed	201	Tenant status changed
Broker status change	202	Tenant Broker status changed
Tenant disenrolled	203	A Tenant has unjoined the broker.
Standard Farm tunnel session failed	220	Standard tunnel session failed.
Broker Farm tunnel session failed	221	Tenant Broker tunnel session failed.