Instructions about alerts via SMTP and Thresholds (apache#498)

Co-authored-by: Davi Torres <[email protected]>

Author: daviftorres

source/adminguide/management.rst

@@ -231,6 +231,48 @@ Emails will be sent to administrators under the following circumstances:
 
 -  The Host cluster runs low on CPU, memory, or storage resources
 
+The following global settings are available to configure Alerts via SMTP.
+
+.. list-table:: Management Alerts Global Settings
+   :header-rows: 1
+
+   * - Global setting
+     - Default
+     - Description
+   * - ``alert.smtp.host``
+     - `null`
+     - SMTP hostname used for sending out email alerts.
+   * - ``alert.smtp.port``
+     - `465`
+     - Port the SMTP server is listening on.
+   * - ``alert.smtp.useAuth``
+     - `false`
+     - If true, use SMTP authentication when sending emails.
+   * - ``alert.smtp.username``
+     - `null`
+     - Username for SMTP authentication (applies only if alert.smtp.useAuth is true).
+   * - ``alert.smtp.password``
+     - `null`
+     - Password for SMTP authentication (applies only if alert.smtp.useAuth is true).
+   * - ``alert.smtp.useStartTLS``
+     - `false`
+     - If set to true and if we enable security via alert.smtp.useAuth, this will enable StartTLS to secure the connection.
+   * - ``(alert.smtp.enabledSecurityProtocols``
+     - `null`
+     - White-space separated security protocols; ex: "TLSv1 TLSv1.1". Supported protocols: SSLv2Hello, SSLv3, TLSv1, TLSv1.1 and TLSv1.2
+   * - ``alert.smtp.connectiontimeout``
+     - `30000`
+     - Socket connection timeout value in milliseconds. -1 for infinite timeout.
+   * - ``alert.smtp.timeout``
+     - `30000`
+     - Socket I/O timeout value in milliseconds. -1 for infinite timeout.
+   * - ``alert.email.addresses``
+     - `null`
+     - Comma separated list of email addresses which are going to receive alert emails.
+   * - ``alert.email.sender``
+     - `null`
+     - Sender of alert email (will be in the From header of the email).
+
 
 Sending Alerts to External SNMP and Syslog Managers
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -246,116 +288,96 @@ The alerts which can be sent are:
 The following is the list of alert type numbers. The current alerts can
 be found by calling listAlerts.
 
-::
-
-   MEMORY = 0 // Available Memory below configured threshold
-
-::
-
-   CPU = 1 // Unallocated CPU below configured threshold
-
-::
-
-   STORAGE =2 // Available Storage below configured threshold
-
-::
-
-   STORAGE_ALLOCATED = 3 // Remaining unallocated Storage is below configured threshold
-
-::
-
-   PUBLIC_IP = 4 // Number of unallocated virtual Network public IPs is below configured threshold
-
-::
-
-   PRIVATE_IP = 5 // Number of unallocated private IPs is below configured threshold
-
-::
-
-   SECONDARY_STORAGE = 6 //  Available Secondary Storage in availability zone is below configured threshold
-
-::
-
-   HOST = 7 // Host related alerts like host disconnected
-
-::
-
-   USERVM = 8 // User Instance stopped unexpectedly
-
-::
-
-   DOMAIN_ROUTER = 9 // Domain Router VM stopped unexpectedly
-
-::
-
-   CONSOLE_PROXY = 10 // Console Proxy VM stopped unexpectedly
-
-::
-
-   ROUTING = 11 // Lost connection to default route (to the gateway)
-
-::
-
-   STORAGE_MISC = 12 // Storage issue in system VMs
-
-::
-
-   USAGE_SERVER = 13 // No usage server process running
-
-::
-
-   MANAGMENT_NODE = 14 // Management Network CIDR is not configured originally
-
-::
-
-   DOMAIN_ROUTER_MIGRATE = 15 // Domain Router VM Migration was unsuccessful
-
-::
-
-   CONSOLE_PROXY_MIGRATE = 16 // Console Proxy VM Migration was unsuccessful
-
-::
-
-   USERVM_MIGRATE = 17 // User Instance Migration was unsuccessful
-
-::
-
-   VLAN = 18 // Number of unallocated VLANs is below configured threshold in availability zone
-
-::
-
-   SSVM = 19 // SSVM stopped unexpectedly
-
-::
-
-   USAGE_SERVER_RESULT = 20 // Usage job failed
-
-::
-
-   STORAGE_DELETE = 21 // Failed to delete storage pool
-
-::
-
-   UPDATE_RESOURCE_COUNT = 22 // Failed to update the resource count
-
-::
-
-   USAGE_SANITY_RESULT = 23 // Usage Sanity Check failed
-
-::
-
-   DIRECT_ATTACHED_PUBLIC_IP = 24 // Number of unallocated shared Network IPs is low in availability zone
-
-::
-
-   LOCAL_STORAGE = 25 // Remaining unallocated Local Storage is below configured threshold
-
-::
-
-   RESOURCE_LIMIT_EXCEEDED = 26 //Generated when the resource limit exceeds the limit. Currently used for recurring Snapshots only
-
-
-You can also display the most up to date list by calling the API command ``listAlerts``.
+.. list-table:: List of Alerts
+   :header-rows: 1
+
+   * - Type Number
+     - Name
+     - Description
+   * - `0`
+     - ``MEMORY``
+     - Available Memory below configured threshold
+   * - `1`
+     - ``CPU``
+     - Unallocated CPU below configured threshold
+   * - `2`
+     - ``STORAGE``
+     - Available Storage below configured threshold
+   * - `3`
+     - ``STORAGE_ALLOCATED``
+     - Remaining unallocated Storage is below configured threshold
+   * - `4`
+     - ``PUBLIC_IP``
+     - Number of unallocated virtual Network public IPs is below configured threshold
+   * - `5`
+     - ``PRIVATE_IP``
+     - Number of unallocated private IPs is below configured threshold
+   * - `6`
+     - ``SECONDARY_STORAGE``
+     - Available Secondary Storage in availability zone is below configured threshold
+   * - `7`
+     - ``HOST``
+     - Host related alerts like host disconnected
+   * - `8`
+     - ``USERVM``
+     - User Instance stopped unexpectedly
+   * - `9`
+     - ``DOMAIN_ROUTER``
+     - Domain Router VM stopped unexpectedly
+   * - `10`
+     - ``CONSOLE_PROXY``
+     - Console Proxy VM stopped unexpectedly
+   * - `11`
+     - ``ROUTING``
+     - Lost connection to default route (to the gateway)
+   * - `12`
+     - ``STORAGE_MISC``
+     - Storage issue in system VMs
+   * - `13`
+     - ``USAGE_SERVER``
+     - No usage server process running
+   * - `14`
+     - ``MANAGEMENT_NODE``
+     - Management Network CIDR is not configured originally
+   * - `15`
+     - ``DOMAIN_ROUTER_MIGRATE``
+     - Domain Router VM Migration was unsuccessful
+   * - `16`
+     - ``CONSOLE_PROXY_MIGRATE``
+     - Console Proxy VM Migration was unsuccessful
+   * - `17`
+     - ``USERVM_MIGRATE``
+     - User Instance Migration was unsuccessful
+   * - `18`
+     - ``VLAN``
+     - Number of unallocated VLANs is below configured threshold in availability zone
+   * - `19`
+     - ``SSVM``
+     - SSVM stopped unexpectedly
+   * - `20`
+     - ``USAGE_SERVER_RESULT``
+     - Usage job failed
+   * - `21`
+     - ``STORAGE_DELETE``
+     - Failed to delete storage pool
+   * - `22`
+     - ``UPDATE_RESOURCE_COUNT``
+     - Failed to update the resource count
+   * - `23`
+     - ``USAGE_SANITY_RESULT``
+     - Usage Sanity Check failed
+   * - `24`
+     - ``DIRECT_ATTACHED_PUBLIC_IP``
+     - Number of unallocated shared Network IPs is low in availability zone
+   * - `25`
+     - ``LOCAL_STORAGE``
+     - Remaining unallocated Local Storage is below configured threshold
+   * - `26`
+     - ``RESOURCE_LIMIT_EXCEEDED``
+     - Generated when the resource limit exceeds the limit. Currently used for recurring Snapshots only
+
+
+You can also display the most up to date list by calling the API command ``listAlerts`` or unsing CLoudMonkey ``cmk list alerts``.
 
 
 SNMP Alert Details