Notifications

The S1 system incorporates an advanced notification mechanism that dispatches real-time monitoring messages based on its configurations. Various notification levels are available, including Verbose, Debug, Information, Warning, and Error.

1. Verbose: This level offers comprehensive and detailed information about the system’s operations, including low-level debugging data valuable for developers and system administrators during issue troubleshooting.
2. Debug: Providing insights into system events and conditions, Debug notifications assist in debugging and troubleshooting. This includes details about system configurations, performance statistics, and error messages.
3. Information: Offering specifics about system events and conditions, Information notifications are non-critical but pertinent to system administrators, covering areas such as software updates, configuration changes, and overall system status.
4. Warning: Alerting about events or conditions needing attention but not reaching critical levels, Warning notifications may concern issues like a failed disk or a degraded RAID array.
5. Error: This level focuses on critical events or conditions that demand immediate attention to prevent data loss or system downtime, such as a failed power supply or a critical system error.

Notification levels can be configured either specifically or hierarchically. With hierarchical notification, each level includes the notifications of the previous levels. For example, selecting the “Information” level will result in receiving notifications for “Information,” “Warning,” and “Error” events and conditions. In contrast, specific notification allows users to receive notifications only related to a selective type of notification.

Ultimately, it’s important to configure the notification levels based on the criticality of the event or condition and the level of urgency required for resolution, to ensure that users receive notifications that require their immediate attention.

Querying the system

To query the system for notification settings, use the notifications query command

Usage:

notifications query [--nodes=<name…>] [--minLevel=<name> | --levels=<name…>]
                                     [--modules=<name…>]
                                     [--startTimestamp=<date>] [--endTimestamp=<date>] [--utcTime]
                                     [--messageOnly] [--hideTimestamp] [--hideLevel] [--hideModule]
                                     [--search=<free_text>] [--top=<int>] [--descendingOrder]

Options:

Examples:

1. To query the system and filtering the results by hierarchical Error notification level, run

   notifications query --minLevel Error
   

2. To display system notifications from January 1, 2023, to March 2, 2023, with a minimum hierarchy level of ‘Verbose,’ and outputting the results in UTC time while filtering the results by searching for the exact phrase ‘giveover transition,’ run:

   notifications query --minLevel Verbose --startTimestamp 2023-01-01 --endTimestamp 2023-03-02 --search "giveover transition"
   

3. To display system notifications from January 1 2023 to March 2 2023 and to display the results in UTC time while filtering the results for just the Information notification type and by searching for the exact phrase “upper threshold”, run

   notifications query --level Verbose --startTimestamp 2023-01-01 --endTimestamp 2023-03-02 --search "upper threshold"
   

View Emails settings

To view settings for emails notifications, use the command notifications settings email show.

Usage:

notifications settings email show

Options:

The notifications settings email show has no options.

Examples:

To display settings for emails notification, run

notifications settings email show

View notifications recipients settings

To view settings for all notifications recipients, use the command notifications settings show.

Usage:

notifications settings show

Options:

The notifications settings show has no options.

Examples:

To display settings for all notification recipients, run

run notifications settings email show

Setting the email server

By default the email server is set with the following parameters:

• Mail Server Address: smtp.gmail.com
• Mail Server Port: 587
• Mail Server Username: notifications@storone.com
• Sending Email Address
• Secure Socket Option: Auto
• Validate Certificate: True

To modify the emails server settings, use the notifications settings email edit command.

Usage:

	notifications settings email edit [--server=<text>] [--port=<numbers>] 
                                  [--username=<text>] [--password=<password_general>] [--sendFromAddress=<text>] [--removeUsernameAndPassword | --removeSendFromAddress]
                                  [--secureSocketOption=<name>]
                                  [--disableCertificateValidation | --enableCertificateValidation]

Options:

| Options and arguments | Description | | --server=<text> | To select the mail server address, replace <text> with a mail server address, e.g., “smtp.gmail.com”. | | --port=<numbers> | To select the mail server port, replace <numbers> with the mail server port number, e.g., 587. | | --username=<text> | To select a user name for the mail server, replace <text> with the actual username. | | --password=<password_general> | To select a mail server password, replace <password_general> with the actual password. | | --sendFromAddress=<text> | To select an email address for the outgoing notifications. | | --removeUsernameAndPassword | To remove the username and password. No authentication will be used (anonymous). | | --removeSendFromAddress | To remove the send-from address. Instead, use the username for the outgoing email. | | --secureSocketOption=<name> | To configure mail server encryption, options are: None: No SSL/TLS encryption. Auto: This is the default configuration; the S1 system sets the encryption automatically either to SSL, TLS, or None. SslOnConnect: The S1 will attempt SSL or TLS encryption and connect through the first encryption that is supported by the server. StartTls: Use TLS encryption. StartTlsWhenAvailable: Provided that the server supports the STARTTLS protocol, use TLS encryption. | | --disableCertificateValidation | To allow self-signed certification, when this option is used, the S1 system will not validate the certificate of the server. The S1 accepts the server certificate even if it is broken! Use this option only if the server is 100% trusted! |

Examples

To set email server smtp.yoyo.com on port 977with outgoing mail set to joe@yoyo.com and secure socket option None, run

notifications settings email edit --server smtp.yoyo.com --port 977 --sendFromAddress joe@yoyo.com 

To verify you settings, run

``` S1-CLI
notifications settings email show
```

Reset the email server

To reset the email server to the S1 default values, use the command notifications settings email reset.

Usage:

	notifications settings email reset

Options

The notifications settings email reset has no options.

Example

To reset the email server to default values

• Mail Server Address: smtp.gmail.com
• Mail Server Port: 587
• Mail Server Username: notifications@storone.com
• Sending Email Address
• Secure Socket Option: Auto
• Validate Certificate: True

run:

	notifications settings email reset

Adding a notification recipient email

To add an email as notification recipient, use the command notifications targets email add.

Usage:

	notifications targets email add <email> [--minLevel=<name>] [--modules=<name…>]
                                        [--batchPostingLimit=<numbers>] [--batchPostingPeriod=<numbers>]
                                        [--name=<name>]

Options:

Examples:

1. To add recipient notification email john2.test2@gmail.com that listen to all modules with hierarchical notification level set to Information, run

   notifications targets email add john2.test2@gmail.com
   

2. To add recipient notification email john.test@gmail.com with the following parameters:

   • Minimum error level set to Error
   • Maximum number of event batches that can be sent in one email is set to two
   • Time interval for event batches checking is set to 60 seconds
   • The modules from which the recipient will get notified are: Snapshots and ThinProvisioning
   • The unique S1 identifier name for this notification name is js

   run,

   notifications targets email add john.test@gmail.com --minLevel Error --batchPostingLimit 2 --batchPostingPeriod 60 --modules Snapshots ThinProvisioning --name jt
   

Editing a notification recipient email

To edit notification recipient email, use the command notifications targets email edit.

Usage:

	notifications targets email edit <name> [--address=<email>] [--minLevel=<name>] [--modules=<name…>]
                                        [--batchPostingLimit=<numbers>] [--batchPostingPeriod=<numbers>]
                                        [--newName=<name>] [--disable | --enable]

Options:

Examples:

1. To edit recipient notification jt with the following parameters:
   • Change the email address to george-t@gmail.com
   • Change the S1 recipient ID name to George
     run:

   notifications targets email edit jt --address george-t@gmail.com --newName George

Adding an Seq recipient

To add an Seq recipients, use the command notifications targets seq add.

Usage:

 notifications targets seq add --serverUrl=<text> [--minLevel=<name>] [--modules=<name…>]
                                                 [--batchPostingLimit=<numbers>] [--batchPostingPeriod=<numbers>]
                                                 [--name=<name>]

Options:

Examples:

To configure Seq target https://seq.yoyo.com with S1 recipient ID name Joe and to set the batch post limit to one and the minimum hierarchical notification level to Warning, run

``` S1-CLI
	notifications targets seq add --serverUrl https://seq.yoyo.com --batchPostingLimit 1 --name joe
```

Editing SEQ recipient

To edit an Seq recipients, use the command notifications targets seq edit.

Usage:

	notifications targets seq edit <name> [--serverUrl=<text>] [--minLevel=<name>] [--modules=<name…>]
                                      [--batchPostingLimit=<numbers>] [--batchPostingPeriod=<numbers>]
                                      [--newName=<name>] [--disable | --enable]

Options:

Examples:

To configure Seq recipient ID name Joe, renaming it to George and replace the seq server URL from https://seq.yoyo.com to https://seq.george.com and modify the minimum hierarchical notification level from Warning to Verbose, run

``` S1-CLI
	notifications targets seq edit joe --serverUrl https://seq.george.com --newname George
```

Adding a Slack recipient

To add an Slack recipients, use the command notifications targets slack add.

Usage:

notifications targets slack add --webhookUrl=<text> [--minLevel=<name>] [--modules=<name…>]
                                                   [--batchPostingLimit=<numbers>] [--batchPostingPeriod=<numbers>]
                                                   [--name=<name>]

Options:

Examples:

1. To add a Slack recipient with Slack Webhook URL https://hooks.slack.com/services/T1A2B3C4D/B5E6F7G8H/abCdEfGhIjKlMnOpQrStUvWxY with S1 recipient ID name slackUSluck while setting the batch posting limit to one and the minimum hierarchical level to Warnint, run

notifications targets slack add –webhookUrl https://hooks.slack.com/services/T1A2B3C4D/B5E6F7G8H/abCdEfGhIjKlMnOpQrStUvWxY –minLevel Warning –batchPostingPeriod 1 –name slackUSluck

## Editing a Slack recipient 
To edit a [Slack](/overview/terminology#slack) recipients, use the command `notifications targets slack edit`.

### Usage:

``` S1-CLI
 notifications targets slack edit <name> [--webhookUrl=<text>] [--minLevel=<name>] [--modules=<name...>]
                                     [--batchPostingLimit=<numbers>] [--batchPostingPeriod=<numbers>]
                                     [--newName=<name>] [--disable | --enable]

Options:

Examples:

1. To disable S1 recipient slackUSluck, run

       notifications targets slack edit slackUSluck --disable
   

2. To enable S1 recipient slackUSluck, run

   notifications targets slack edit slackUSluck --enable
   

3. To rename recipient slackUSluck to slack-s1-notifier and to change the minimum hierarchical notification to Verbose, run

   notifications targets slack edit slackUSluck --newName slack-s1-notifier --minLevel Verbose
   

Adding an SNMP recipient

To add an SNMP recipients, use the command notifications targets snmp add.

Usage:

	notifications targets snmp add <ip> [--managerPort=<numbers>] [--minLevel=<name>] [--modules=<name…>]
                  [--communityString=<text>] [--trapVersion=<trapVersion>]
                  [(--v3Context=<text> --v3Username=<name> --v3AuthPhrase=<text> --v3PrivacyPhrase=<text>)]
                  [--name=<name>]

Options:

Examples:

1. To configure SNMP notifications mySNMP over IP address 192.168.50.29 on port 5555 with minimum hierarchical notification level set to Error, run

   notifications targets snmp add 192.168.50.29 --managerPort 5555 --minLevel Error --name mySNMP
   

2. This example demonstrates a command to add an SNMP notifications SNMPnotifier with the same parameters as in the previous example (apart from the name) and with the following v3 authentication settings:

   • The v3 context is set to urgent
   • The v3 user name is set to jeff
   • The v3 authentication phrase is set to not4me
   • The v3 privacy phrase is set to pass2act

   To create this type of SNMP notifications, run:

   notifications targets snmp add 192.168.50.29 --managerPort 5555 --minLevel Error --name SNMPnotifier --v3Context urgent --v3Username jeff --v3AuthPhrase not4me --v3PrivacyPhrase pass2act
   

Editing an SNMP recipient

To edit an SNMP recipients, use the command notifications targets snmp edit.

Usage:

notifications targets snmp edit <name> [--managerAddress=<ip>] [--managerPort=<numbers>] [--minLevel=<name>] [--modules=<name...>]
                                       [--communityString=<text>] [--trapVersion=<trapVersion>]
                                       ([--v3Context=<text>] [--v3Username=<name>] [--v3AuthPhrase=<text>] [--v3PrivacyPhrase=<text>])
                                       [--newName=<name>] [--disable | --enable]

Options:

Examples:

1. To rename the internal S1 recipient name from mySMP to pinPoint-SNMP, run

   notifications targets snmp edit mySNMP --newName pinPoint-SNMP
   

2. To modify the v3 user name in SNMP notification SNMPnotifier from jeff to Jean and to change the hierarchical notification level to Verbose, run

   notifications targets snmp edit SNMPnotifier --v3Username Jean --minLevel Verbose 
   

Adding StorOne Support recipient

Adding StorOne support recipient allow StorOne to get real time notifications about the status of your S1 system. This can help StorOne in providing you with the exact support that you need. To add StorOne support recipient, use the notifications targets storone_support add command. This command will add a recipient name storone_support to your system.

Usage:

notifications targets storone_support add

Options:

The command notifications targets storone_support add has no options.

Examples:

To add StorOne support to your system, run

notifications targets storone_support add

Deleting a recipient target

To delete a recipient target from the S1 system, use the command notifications targets delete <name…>

Usage:

 notifications targets delete <name…> [--force]

Options:

Examples:

To delete S1 recipient names ggSNMP and SNMPnotifier, run

notifications targets delete SNMPnotifier ggSNMP --force

Testing the notification settings

To generate a test notification on the S1 system, use the notifications test command.

Usage:

notifications test --node=<name> --level=<name> --module=<name> --message=<text>

Options:

Examples:

To generate a test notification from node server s1-6021 with hierarchical level Verbose on module FileSystem that contains the message "This is just a test message", run

notifications test --node s1-6021 --level Verbose --module FileSystem  --message "This is just a test message"