12.04 - alertutil - Server Management

Teradata Server Management Web Services User Guide

prodname
Server Management
vrm_release
12.04
created_date
January 2017
category
User Guide
featnum
B035-5350-017K

Purpose

The alertutil command displays alert records retrieved from Server Management.

Syntax

alertutil [components] [TimeParameters] [DisplayParameters] [FilterParameters]

alertutil -guids {alertGUID[,...]} [DisplayParameters]

alertutil -detail -timeStamp mm/dd/yyyy hh:mm:ss -sequence sequenceNumber

alertutil -monitor [MonitorParameters] [DisplayParameters] [FilterParameters]

alertutil -clear -start mm/dd/yyyy hh:mm:ss -end mm/dd/yyyy hh:mm:ss

alertutil -clear -guids {alertGUID[,...]}

alertutil -clear -timeStamp mm/dd/yyyy hh:mm:ss -sequence sequenceNumber

alertutil -summary [components] [TimeParameters] [DisplayParameters] [FilterParameters] [SummaryParameters]

alertutil -summary -guids {summaryalertGUID[,...]} [DisplayParameters]

alertutil -summary -monitor [MonitorParameters][DisplayParameters] [FilterParameters] [SummaryParameters]

alertutil -summary -clear -guids {summaryalertGUID[,...]}

Parameters

-clear
Clears all alert and summary alert records between the specified times. When combined with -summary and -guids {alertGUID}, clears the summary alert for the specified {alertGUID} and all alerts associated with the summary. You can also clear multiple alerts or summary alerts with the matching IDs.
alertutil -clear -start 8/19/2013 04:32:22 -end 8/20/2013 04:32:22 clears all alerts and summary alerts between the start and end times.
alertutil -clear -guids {175CC646-8CC3-11d3-84FD-00E029103BC7,a10f68a4-5b3d-4860-a310-e6f8800b972e} clears the specified alerts with the matching GUID.
alertutil -clear -timestamp 08/19/2013 04:32:22 -sequence 293849 clears the alert with the matching time stamp and sequence.
alertutil -clear -guids {eb7d1252-60a1-4c8c-aea4-1ee284d9ecfe},{eb7d1252-60a1-4c8c-aea4-1ee284d9ecfe} -summary clears the summary alerts with the matching GUIDs. If the specified GUID corresponds to a Root Cause or Situational Cause summary alert, then alertutil also clears all associated UpdateXXX alerts.
components
Unique ID of the components whose alerts you want to display. The unique ID can be a Component ID, default alias, or user-defined alias. If no Component IDs or aliases are specified, alerts for the first system display.
-detail
Displays details for the specified alert.
-guids {alertGUID[,...]}
Displays alerts for specified GUIDs.
alertutil -guids {175CC646-8CC3-11d3-84FD-00E029103BC7} displays alerts for the specified alert IDs.
-monitor
Monitors and displays new alert records coming from Server Management.
Tip: Press CTRL + C to quit.
alertutil -monitor -sys=1 -cab=300 -chas=203,204 listens for new alerts where systemID=1, cabinetID=300, and chassisID=203 or chassisID=204.
-summary
Displays summary alert information.
alertutil -summary -max 100 displays alert summary information for the most recent 100 summary alerts.
alertutil -summary -guids {eb7d1252-60a1-4c8c-aea4-1ee284d9ecfe},{eb7d1252-60a1-4c8c-aea4-1ee284d9ecfe} displays alert summary information for specified alert IDs.

Time Parameters

-all
Displays all alerts in the system. If -all or -max is not specified, the default is 1000 records.
Operation could be lengthy depending on the size of the system.
alertutil -all lists all alerts in a system.
-desc | asc
Specifies sort order based on create time.
  • Descending displays newest record first (default)
  • Ascending displays oldest record first
-end [mm/dd/yyyy ] [hh:mm:ss]
Selects the end date or time. Default is current date or time 23:59:59.
-max x
Specifies the maximum number of alerts to retrieve. If -all or -max is not specified, the default is 1000 records.
-sec | -min | -hrs | -days x
Selects alerts by the specified seconds, minutes, hours, or days since the start time or before the end time; if -start or -end is not specified, the default is since current time.
alertutil -start 10/02/2013 -days 2 displays 2 days of alerts, starting October 2, 2013 00:00:00 and ending 2 days later, on October 3, 2013 23:59:59.
alertutil -end 10/15/2013 -days 4 displays 4 days of alerts, starting on October 11, 2013 00:00:00 and ending on October 15, 2013 23:59:59.
alertutil -days 4 displays alerts starting 4 days earlier up to current time.
-sequence sequenceNumber
Adds the time sequence to speed up alert retrieval.
alertutil -detail -timeStamp 2013-02-20 08:03:26 -sequence 293849 show details of the alert with the matching time stamp and sequence.
-start [mm/dd/yyyy ] [hh:mm:ss]
Selects the start date and time. Default is current date and time 0.

Display Parameters

-byalias
Displays output using the component alias instead of the ObjectPath. If a user-defined alias has been configured, it displays.
-bycollective
Displays alert information grouped by one collective at a time. You cannot use -bycollective if you designate specific components.
alertutil -all -bycollective lists all alerts in the system, one collective at a time.
alertutil -all -sys=1 -coll=3-5 -bycollective lists all alerts from system 1, collectives 3 through 5, one collective at a time.
-csv
Displays the information in CSV (comma-separated value) format on the screen. To redirect the command output to a .csv or .txt file, type one of the following:
  • -csv > myfilename.csv
  • -csv > myfilename.txt
-format filename
Displays alert information according to the format file filename. alertutil recognizes the following macros in the format file:
{TimeStamp}, {Sequence}, {Severity}, {Status}, {ManagedElementAlias}, {Description}, {SystemName}, {SystemID}, {CollectiveID}, {CabinetID}, {ChassisID}, {ManagedElement}, {ObjectClass}, {ID}, {TimeReceived}, {Domain}, {MessageID}, {ReporterType}, {SubType}, {Details}, {RequestID}, {Data}, {RepeatCount}, {RepeatStartTime}, {SubSystem}, {Autosolvable}, {KnowledgeID}, {TrackingID}, {TVI_Disposition}, {Synopsis}, {Maintenance}, {Notify}, {Impact}, {Scope}
Surround brackets with single quotes; represent a true single quote with two single quotes.
{‘This is a sample’} is represented as ‘{‘‘‘This is a sample.’’’}’ in the format file.
-formNameValue
Displays in AttributeName=Value format.
-nohdr
Suppresses display of format header.
-perform
Displays statistics such as elapsed time and number of records.
-raw
Displays alert information retrieved from Server Management without translation to a more readable format.
-verbose
Displays all alert data.
alertutil -start 8/29/2013 -days 1 -verbose shows all alert information for all alerts logged on 8/29/2013.
-xml
Displays alert information in xml format.

Filter Parameters

-cabinetID=cabinetIDNumber[,...]
Selects alerts associated with the cabinet ID numbers. If you identify multiple cabinet ID numbers, you cannot specify chassis IDs.
-chassisID=chassisIDNumber[,...]
Selects alerts associated with the chassis ID numbers.
-collectiveID=collectiveIDNumber[,...]
Selects alerts associated with the collective ID numbers. If you identify multiple collective ID numbers, you cannot specify cabinet IDs or chassis IDs.
-domain=domainName[,...]
Selects alerts with the specified domain names.
alertutil -dom=bynet -sev=W,D lists any alerts for domain BYNET with a severity of Warning or Degraded.
-msgID=msgID[,...]
Selects alerts with matching MessageIDs.
-objectClass=objectClassName[,...]
Selects alerts associated with object class names. To determine the class name, see the first part of the component ID.
If the component ID is CMIC_5500J.SystemID=1,CollectiveID=400,CabinetID=1,ID=6 , the class name is CMIC_5500J.
-severity=severity[,...]
Selects the first letter of one or more severity names or a range x-y, between 0 and 6.
  • Unknown or 0
  • OK or 1
  • Info or 2
  • Warning or 3
  • Degraded or 4
  • Critical or 5
  • Fatal or 6
-sName=systemName[,...]
Selects alerts associated with system names.
-status=Status[,...]
Selects alerts with associated statuses.
  • Active
  • Autosolved
  • Cleared
  • Expired
alertutil -status=Active -subsystem=Storage lists all the active alerts from the Storage subsystem.
-subSystem=subSystem[,...]
Selects alerts with associated subsystems.
  • Storage
  • Power
  • Node
  • OS
  • Database
  • Network
  • ServerMgmt
  • Client
  • Other
alertutil -subSystem=Database -TVI=Escalated -sev=3-6 lists all database related alerts with the TVI disposition of Escalated and a severity between 3 and 6.
-subType=subTypeName[,...]
Selects alerts with the specified subType names.
  • ProbableCause
  • AlertGroup
  • Null
  • UNASSIGNED
-systemID=systemIDNumber[,...]
Selects alerts associated with the system ID numbers. If you identify multiple system ID numbers, you cannot specify collective IDs, cabinet IDs, or chassis IDs.
alertutil -sys=1 -cab=300 -chas=203,204 lists alerts where systemID=1, cabinetID=300, and chassisID=203 or chassisID=204.
-TVI_Disposition=disposition[,...]
Selects alerts associated with TVI dispositions.
  • Abeyed
  • Escalate_Requested
  • Escalated
  • Ignore_Maintenance
  • Ignore_Heartbeat
  • Ignored
  • None
alertutil -subSystem=Database -TVI=Escalated lists all database related alerts with the TVI disposition of Escalated.

Monitor Parameters

-modification
Displays alert modifications in addition to new alerts. Use this with -monitor parameter to view status and TVI disposition changes.
The following parameters are not supported: -start, -end, -sec, -min, -hrs, -days, -active, -desc, -asc, -seq, -detail, -perform, -nohdr, -csv, and -guids.

Summary Parameters

-impact=impact[,...]
Displays summary alerts with matching impacts.
-maintenance=settingType
Displays summary alerts with specified maintenance settings.
  • On
  • Off
-notify=settingType
Displays summary alerts with specified notify settings.
  • On
  • Off
-scope=scope[,...]
Displays summary alerts with matching scopes.
-synopsis=synopsis[,...]
Displays summary alerts with matching synopsis.