Introduction
Starting with version 7.0, vSEC:CMS administrators can receive notifications about critical system events. This allows them to address issues requiring attention, such as expiring Enrolment Agent (EA) certificates, before they cause problems.
Configure
Navigate to Options - Settings and in the System Health Status section click Enable notification checkbox and click the Configure button.
In the Available pane all available system status are listed. For the complete description of these statuses see here. Add the ones you wish to be notified about to the Selected pane.
Click the Configure button to configure how the notifications will be sent. Click Add to add a new template. Enter a template name and select either email or SMS (you will need to have already setup an SMTP or SMS connector from Options - Connections) for the method of delivery for the notification. In this guide we will use email as the method of delivery. Click the Edit email template button to configure the email body. Enter appropriate email addresses who the notification should be sent to.
Currently only one email address can be used in the To field when configuring your email template
In the Variables drop-down list are the available internal variables that provide more details as to the system health issue that is being triggered. It is recommended at minimum to use the following variables:
- ${SysStatusNotifyStatusId} - This is the ID of the system status that corresponds to the ID as described in the table in the guide here.
- ${SysStatusNotifyStatusTitle} - This is a high level description of the system status that is being reported.
- ${SysStatusNotifyStatusDescription} - This is a more detailed description of the system status that is being reported.
- ${SysStatusNotifyStatusStatusStr} - This is the level of the system status, either Warning or Critical (see here for more details).
- ${SysStatusNotifyStatusActionStr} - This will indicate if the current system status being notified about is been added or removed. If it is being removed then this indicates that the particular system status is no longer an issue needing deeper investigation.
- ${SysStatusNotifyActionTimeStr} - This is the time when the system status that is being reported was encountered.
Recommended System Status to Report
The below are recommended at minimum to be configured for notifications to be sent out.
001 - Backup failed
010 - User license low
011 - License problem (license counter 0)
016 - DB Disk Space Low
017 - DB Disk Space Out
032 - Issuance is not allowed because of short validity time
044 - Certificate request signing is not possible because of short validity time
071 - HSM Down
084 - Subscription License expire
085 - License invalid
088 - Configured server certificate is not functional
089 - Configured server certificate has a short validity time
141 - Failed to initialize Operator Service Key Store
For more details on what these notifications mean refer to this guide here.