eG Administration
 

MANAGER SETTINGS - ITSM/Collaboration Integration using CLI

The eG manager can be configured so that whenever it detects a new alarm, a change in an existing alarm, or a closure of an existing alarm, it executes a command with the appropriate parameters indicating the current status of the alarm. Note that this capability is available for stand-alone Windows managers, and Windows managers operating in redundant clusters only. Prior to configuring this capability on such managers, the following pre-requisites need to be fulfilled:

To configure the command to be executed, do the following:

  • Slide the Enable CLI slider to the right to enable this capability.

  • In the Command text box, echo is displayed by default, indicating that the eG manager will execute an echo command by default to communicate with the TT system.

  • The Command arguments text box displays the default input parameters that the echo command takes during execution. These default parameters are as follows:

    AlarmId $AlarmId -DATE $DATE -TIME $TIME -Priority $Priority -ComponentType $ComponentType -ComponentName $ComponentName -Layer $Layer -Desc $Desc -Service $Service

    As you can see, each parameter is represented by a qualifier and a variable name. While the qualifier is typically prefixed by a hyphen (-), the variable name is prefixed by a $ symbol. These variables will be substituted by actual values during runtime. Using the qualifiers, you will be able to tell what value follows. For instance, at runtime, the parameter -Priority $Priority could appear as -Priority Critical. This implies that the Priority of the problem is Critical.

    For more details about the TT Manager CLI, refer to the eG Integration with Trouble Ticketing Systems document.

  • From the Date format to be used list box, select the format in which the date/time of the problem should be reported in the command output.

  • Specify the maximum permissible length of the command in the Command length (chars) text box. By default, the command line can have a maximum of 8191 characters. You can alter this default setting by specifying a length of your choice in the Command length text box. If the actual command length exceeds the specified limit, then the output will not return the list of affected services and the detailed diagnosis information; instead, an empty string will appear next to the –Services qualifier. If the command length continues to exceed the specified limit even after truncating the services list and the DD, the command execution will return an error.

  • Specify the length of the problem description in the Problem description length (chars) text box. If the actual problem description exceeds the specified length, the characters that fall beyond the specified limit will be truncated.

  • Finally, click the Update button to save the changes.