dssalertconfig

Usage

• <b>dssalertconfig</b> [<b>-R</b><em>url</em>] <em>hub</em> List all the alerts configured on the hub.
• <b>dssalertconfig</b> [<b>-R</b><em>url</em>] <em>hub alert</em> List the properties of the alert configured on the hub.
• <b>dssalertconfig</b> [<b>-R</b><em>url</em>] [<b>-o</b><em>jsonfile</em>] <em>hub alert</em> [<em>property</em>]... Print the specified alert properties (property...) configured on the hub, or all if none are specified.
• <b>dssalertconfig</b> [<b>-R</b><em>url</em>] [<b>-i</b><em>jsonfile</em>] <em>hub alert</em> [<em>property</em>=[<em>value</em>]]... Set or unset the specific alert properties supplied in the jsonfile and/or directly on the command line.
• <b>dssalertconfig</b> [<b>-R</b><em>url</em>] <b>-a</b> [<b>-i</b><em>jsonfile</em>] <em>hub alert</em> [<em>property</em>=<em>value</em>]... Replace all the existing properties of the alert configured on the hub with a new set of properties supplied in the jsonfile and/or directly set on the command line (property=value...).
• <b>dssalertconfig</b> [<b>-R</b><em>url</em>] <b>-c</b> <em>hub alert</em> <em>property</em>=<em>value</em>... Create an alert on the hub with specified properties and set values for the properties (property=value...).
• <b>dssalertconfig</b> [<b>-R</b><em>url</em>] <b>-d</b> <em>hub alert</em> Delete the alert configured on the hub.
• <b>dssalertconfig</b> [<b>-R</b><em>url</em>] <b>-D</b> <em>hub alert</em> Disable the alert configured on the hub.
• <b>dssalertconfig</b> [<b>-R</b><em>url</em>] <b>-C</b> <em>hub alert</em> Clear the alert configured on the hub.
• <b>dssalertconfig</b> [<b>-R</b><em>url</em>] <b>-t</b><em> hub alert</em> Test the alert configured on the hub.
• <b>dssalertconfig</b> [<b>-R</b><em>url</em>] <b>-e</b><em> hub alert</em> Execute the alert configured on the hub.

Description

The dssalertconfig command allows you to create an alert and manage the existing alerts. DSS alerts scan the hub server log files and, according to their configuration properties, send notifications about any issues encountered (errors, warnings, latency threshold exceeded).

Argument <em>hub</em> specifies the name of a hub on which an alert(s) are configured. Argument <em>alert</em> specifies the name of an alert.

When you create an alert (using option <b>-c</b>), an alert configuration file (alert_name.conf) is created in the DSS_CONFIG/hubs/hub/alerts directory. The file contains the alert configuration properties specified when the alert was created, i.e. every alert has a certain set of alert properties. For an alert, you always must specify the type of notification: Email, SNS, Slack, or SNMP. If you want to receive alert notifications of different types, e.g. via email and Slack, separate alerts need to be configured.

The dssalertmanager command is responsible for executing all the alerts configured on the hub server.

For the alert properties that can be configured using this command, see section Alert Properties.

Options

This section describes the options available for the dssalertconfig command.

Parameter	Description
-a	Replace the existing alert properties with a new set of alert properties. The new set of alert properties may be supplied directly in the command line or from a JSON file using option -i. The following syntaxes are applicable: The following command replaces the current alert properties with the properties supplied in jsonfile. dssalertconfig -a -i jsonfile hub alert The following command replaces the current alert properties with the properties supplied on the command line. dssalertconfig -a hub alert property1=value1 property2=value2 property3=value3 The following command replaces the current alert properties with the properties supplied in jsonfile and on the command line. dssalertconfig -a -i jsonfile hub alert property1=value1 property2=value2 property3=value3 The properties supplied directly on the command line will override the relevant properties in jsonfile. For specific examples, see Replace alert properties.
-c	Create an alert. This option requires alert property Notification_Type to be specified, and other properties depending on the notification type you specify. For specific examples, see Create Email alert, Create SNS alert, Create SNMP alert. In the User Interface, this option corresponds to the New Alert dialog.
-C	Clear and enable an alert. This option enables an alert (if disabled) and disregards any pending errors, so that only new errors will be reported the next time the alert is run. If an alert is already enabled, it just disregards pending errors. There can be multiple alerts configured on a hub (for example for different notification types: Email, Slack. etc), but some of them could be disabled. When dssalertmanager runs, it will not execute the disabled alerts. For example, the following command enables alert myalert. dssalertconfig -C myhub myalert
-d	Delete an alert. For example, the following command deletes alert myalert: dssalertconfig -d myhub myalert In the User Interface, this option corresponds to the Delete Alert(s) option in the More options menus
-D	Disable an alert. It will not be executed until it is enabled again. For example, the following command disables alert myalert: dssalertconfig -D myhub myalert In the User Interface, this option corresponds to the Disable/Enable Alerts option in the More options menus
-e	Execute an alert. For example, the following command executes alert myalert: dssalertconfig -e myhub myalert
-Ex	Override automatic encoding/decoding of string properties when reading a property from file using property=@file_name or when writing a property to file using property>@file_name. This option may be required only while setting the property whose argument is base64. When this option is not used, the default encoding is base64. Valid values of x are: none: no encoding/decoding will be applied. base64: encode a property in the base64 format.
-ijsonfile	Read property values from a JSON file jsonfile. For example, the following command creates alert myalert using the alert properties file alert_props.json: dssalertconfig -i alert_props.json -c myhub myalert
-ojsonfile	Write the specified properties to a JSON file jsonfile. For example, the following command writes the listed properties into the alert_props.json file (this should be a single line without wrapping). dssalertconfig -o alert_props.json myhub myalert Notification_Type=EMAIL Email_SMTP_Server=smtp.mycorp.com Email_SMTP_Starttls=true If no properties are specified on the command line, then all properties are fetched from the alert configuration file (alert_name.conf). For example, the following command writes the properties of alert myalert from the myalert.conf file to the myalert_props.json file: dssalertconfig -o myalert_props.json myhub myalert
-Rurl	Remote hub server. Access the hub server running on a remote machine, via the REST interface. This option is required for remote CLI access. When using this option, command dsslogin should be run first, for authentication. For example, the following command deletes alert myalert on a remote hub server: dssalertconfig -R http://node:port -d myhub myalert
-t	Test an alert to verify if notification settings (Slack, email, etc) are properly configured. For example, the following command sends a test notification defined in alert myalert: dssalertconfig -t myhub myalert In the User Interface, this option corresponds to the Send Test Notification option in the More options menus
-Vaccessmeth	Handle classified data. redact: Redact classified data. storage default: Save classified data as they are stored in the hub system. @outputfile: Apply transport encryption, save key to file outputfile. @print: Apply transport encryption using the transport encryption key and display the key in command terminal. @inputfile: Read transport encryption key stored in a inputfile. This can also be a path (relative or absolute) to this file. @prompt: Prompt a user to enter the transport key via keyboard.

Examples

This section provides examples of using the dssalertconfig command.

Example 1. Get alert properties

The following command prints the value of property Repeat_Interval of alert myalert.

dssalertconfig myhub myalert Repeat_Interval

Example 2. Set alert properties

• The following command sets property Repeat_Interval to value 500 for alert myalert.

  dssalertconfig myhub myalert Repeat_Interval=500
  

• The following command sets the properties specified in the alert_props.json file for alert myalert.

  dssalertconfig -i alert_props.json myhub myalert
  

• The following command sets properties specified in the alert_props.json file and property Repeat_Interval for alert myalert.

  dssalertconfig -i alert_props.json myhub myalert Repeat_Interval=500
  

If the agent_props.json file contains properties that are already set for alert, option <b>-i</b> will override these properties.

For example, the following properties are currently set: **Notification_Type**, **SNS_Destination**, **SNS_Access_Key_Id**, **SNS_Secret_Access_Key**, and **Repeat_Interval**. The **agent_props.json** file contains property **Repeat_Interval**. Option `<b>-i</b>` will override the current value of property **Repeat_Interval** only.