> #### Other alert commands

> Fathom supports the following alert commands:

> - `-firealert`
> - `-alertlist`

> ##### Using the -firealert command

> Use the following syntax to fire an alert:

>     fathom -firealert [alertmessage]

> Fathom also supports generation of application-specific alerts. In your application, you can send alerts to Fathom using the following `-firealert` options shown in Figure 2–17.

> Figure 2–17: `-`firealert command options

> ##### Example

> You want to fire an alert regarding the CPU. Enter the following on the command line:

>     fathom -firealert JOBFAILED -resource CPU -msg 'JOB XYZ FAILED'

> You can then look at the alert details for the CPU and find that particular alert, as shown in Figure 2–18.

> Figure 2–18: `-`firealert command example

> ##### Using the -alertlist command with group selection options

> You can display an alert list by specifying one of the`-alertlist` command group selection options on the command line. Table 2–6 identifies and describes each group selection option.

> Table 2–6: Alert list command group selection options
> Option syntax | Purpose | How to use
> --- | --- | ---
> `-alert` | Use to view a list of all instances of a particular alert. | Provide the name of the alert you want to see.
> `-resource` | Use to view a list of alerts for a particular resource. | Provide the name of the resource whose alerts you want to see listed.
> `-container` | Use to view alerts associated with a specific container. | Provide the name of the container whose alerts you want to see listed.
> `-restype` | Use to view a list of alerts for a particular resource type. | Provide the resource type whose alerts you want to see listed; the resource type is limited to one of the following: database, file, network, system, or openedge.
> `-severity` | Use to view a list of alerts of a particular severity. | Provide the severity level of alerts you want to see listed: severe, error, warning, or informational.

> Use the following syntax to display an alert list:

>     fathom -httpport 8080 -alertlist [group selection option] [keyword value]

> Note: You specify `-httpport` only if Fathom is running on a port other than the default of 9090.

> You can also use two additional options, the `-detail` and -`verbose` options, presented in Table 2–7, with the group selection options highlighted in Table 2–6.

> Although the command line does not limit the number of options you can type into the command line, only the last group selection option identified on the command line is processed.

> Figure 2–19 identifies a command line that generates a group selection based on the `-restype` option where the resource type is identified as system. Note that the resource name, listed in the Resource column, specifies the container name and associated resource name. Although this level of detail provides more information about a resource, it does not completely eliminate the possibility of confusion among resources with similar or identical names.

> Figure 2–19: `-`restype group selection option results

> ##### Using the alertlist command with additional options

> Table 2–7 identifies and describes the additional options, `-detail` and `-verbose`.

> Note: Unlike the group selection options highlighted in Table 2–6, the `-detail` and `-verbose` options will be processed regardless of the position in which they are entered on the command line.

> Table 2–7: Alert list command options to display additional details
> Option syntax | Purpose | How to use
> --- | --- | ---
> `-detail` | Use to format the display to show a block of information about the alert, shown in the command line. The block of information matches what you see when you display the alert in the console. See Table 2–8 for a summary of the alert list details. | Provide the `-detail` option along with the option whose alert information you want to see listed.
> `-verbose` | Use to change the resource column of the displayed alerts from the somewhat ambiguous format container:resource name to the fully qualified resource key. See Figure 2–20 for an example use of the `-verbose` option. | Provide the `-verbose` option along with the option whose alert information you want to see listed.

> For example, Figure 2–20 identifies a command line that generates a group selection based on the -restype option that also includes the -verbose option. Note that the resource name, listed in the Resource column, specifies the fully qualified resource key. A fully qualified resource key is the most complete reference to a resource. The default format for a fully qualified resource key identifies each resource by its container name, the resource category to which the resource belongs, and the specific resource type and associated resource name.

> In Figure 2–20, the fully qualified resource key information identifies localhost as the container, the resource category as system, and the specific cpu resource name as CPU.

> Figure 2–20: `-`restype group option with verbose option results

> Note: The container name localhost is logically the same as the container name for the system where Fathom is installed and running.

> Use the fully qualified resource key to:

> - Help ensure that you are not confusing one resource name with another one that is either identical or similar. For example, there exists the possibility to confuse a wsbroker1 on one container with another wsbroker1 on a different container. Referencing a resource by its explicit fully qualified resource key helps remove any confusion as to what resource you are working with.
> - Provide easy access to the complete resource information; you can cut and paste the fully qualified resource key can be cut and pasted into the command line when you use the -resource group option.
> Note: Due to the use of the colon in the fully qualified resource key between the container name and the resource category information, this format might need to be quoted on UNIX systems.

> Table 2–8 lists the details that can appear in the alert list.

> Table 2–8: Alert list details
> Name | Description
> --- | ---
> `Alert ID` | The number given to the alert.
> `Alert name` | The name of the alert.
> `Alert severity` | Whether the alert is considered an error, a warning, or informational, or severe in nature.
> `Alert message` | The content of the alert message; for example, notification that the Database Resource known as the FathomTrendDatabase has been enabled.
> `Alert count` | The number of times the alert has occurred.
> Container | The name of the container to which the resource belongs.
> `Resource` | The name of the resource; for example, FathomTrendDatabase.
> `Last fire date` | The time and date when the alert was last fired.
> `First fire date` | The time and date when the alert was first fired.
> `Has been seen?` | Whether the alert has been seen yet (either `true` if it has been seen or `false` if it has not been seen).
> `Seen by` | If the alert has been seen, the name of the user who saw it. (If the alert has not been seen, the `Seen by` field does not appear.)

> ##### Examples

> You want to see a list of existing Fathom alerts from the command line. Enter the following command:

>     fathom -alertlist

> Information about the current alerts appears, as shown in Figure 2–21.

> Figure 2–21: -alertlist in the command line

> In this example, there are three alerts. One alert exists for a CPU resource named CPU, one for a disk resource named Disk-0_C:, and one for a memory resource named Memory. As identified in the Resource column, all of these resources are on the localhost container. The alert ID numbers (ID) and severity (Severity) are also provided.

> You want a list of alerts for all OpenEdge server resources. Enter the following command:

>     fathom -alertlist -restype openedge

> You see listed any alerts that exist for any OpenEdge server resources (openedge). If there are no existing alerts, you receive the message shown in Figure 2–22.

> Figure 2–22: -alertlist for openedge resource type

> You want to see specific details about the alerts that exist for system resources. You can use either the`-detail` option or the `-verbose` option.

> Enter the following command to examine the results of using the `-detail` option:

>     fathom -alertlist -restype system -detail

> The details appear, as shown in Figure 2–23.

> Figure 2–23: -alertlist command used with -detail option

> Enter the following command to examine the results of using the `-verbose` option:

>     fathom -alertlist -restype system -verbose

> The details appear, as shown in Figure 2–24.

> Figure 2–24: -alertlist command used with -verbose option

Copyright © 2004 Progress Software Corporation www.progress.com Voice: (781) 280-4000 Fax: (781) 280-4095