Description

Clears an alert from OpenEdge Management.

Syntax

fathom -clear option [-comment '<comment text>']

The following table lists options to use with the fathom -clear command.

Table 1. Clear alert command options
Option syntax Purpose How to use 
-httpport <port-number>
 Identifies the port number if it is not the default port of 9090 Provide the -httpport option followed by the port number. 
-comment '<comment-text>'
 Provides a comment when clearing an alert Provide the -comment option followed by the comment text. The text must be enclosed in single quotation marks. 
-alert <alert-name>
[-AdminServer <AdminServer>]|
[-resource <resource>]|
[-restype <resource type>]
 Clears all instances of a particular alert for one specific resource, or for all resources within a specific AdminServer Provide the -alert command followed by the alert name. Then provide either the resource name or the resource type.

Options are defined as follows:

  • -AdminServer— The name of a AdminServer as defined in OpenEdge Management.
  • -alert— The name of the alert as defined in OpenEdge Management.
  • -resource—The name or the reference key of the resource as defined in OpenEdge Management. See Additional options for details about the reference key.
  • -restype—The resource type. The type of resource is limited to one of the following: database, file, network, openedge, or system.
 
-alertid <alert id number>
 Clears an alert by its number (regardless of the resource or its type) Provide the -alertid option followed by its number. 
-all[-restype <resource type>]|
[-resource <resource>]|
[-alert <alert name>]|
[-AdminServer <AdminServer>]|
[-severity <severity>]
 Clears:
  • All alerts
  • All alerts for a particular resource type
  • All alerts for a particular resource
  • All instances of a particular alert for all resources
  • All alerts for a specific AdminServer
  • All alerts for a specific severity
 Provide the -all command without an option to clear all alerts, or with one of these options to clear particular alerts:
  • -restype—The resource type. The type of resource is limited to one of the following: database, file, network, openedge, or system.
  • -resource—The name or the reference key of the resource as defined in OpenEdge Management. See Additional options for details about the reference key.
  • -alert—The name of the alert as defined in OpenEdge Management.
  • -AdminServer—The name of a AdminServer as defined in OpenEdge Management.
  • -severity—The alert severity: Severe, Error, Warning, or Informational.

Example

OpenEdge Management polls your Sports2020 database and sends an alert for Record Waits High (the alert sent when waits for records are above a defined threshold). To clear this alert from the command line, enter the following:
fathom -httpport 8080 -clear -alert RecordWaitsHigh -comment 'Cleared by Admin'