alarm list

Lists alarms in the system. Permissions required: login.

You can list all alarms, alarms by type (Cluster, Node or Volume), or alarms on a particular node or volume. To retrieve a count of all alarm types, pass 1 in the summary parameter. You can specify the alarms to return by filtering on type and entity. Use start and limit to retrieve only a specified window of data.

Syntax

CLI
maprcli alarm list
    [ -alarm <alarm name> ]
    [ -cluster <cluster name> ]
    [ -entity <host name|volume name|Ae name> ]
    [ -limit <limit> ] Default: 2147483647
    [ -output (terse|verbose) ]
    [ -start <offset> ] 
    [ -summary (0 or false|1 or true) ]
    [ -type (cluster|node|volume|AE) ] 
REST
http[s]://<host>:<port>/rest/alarm/list?<parameters> 

Parameters

Parameter

Description

alarm

The alarm name for which to return information.

cluster

The cluster on which to list alarms.

entity

The name of the cluster, node, volume, user, or group to check for alarms.

limit

The number of records to retrieve. Default: 2147483647

output

Whether the output should be terse or verbose. Default: 0

start

The list offset at which to start. Default: 0.

summary

Specifies the type of data to return:
  • 1 = count by alarm type
  • 0 = List of alarms
Default: 0

type

The entity type:

  • cluster
  • node
  • volume
  • ae

Output

Information about one or more named alarms on the cluster, or for a specified node, volume, user, or group.

Output Fields

Field

Description

alarm state

State of the alarm:

  • 0 = Clear
  • 1 = Raised

description

A description of the condition that raised the alarm

entity

The name of the volume, node, user, or group.

alarm name

The name of the alarm.

alarm statechange time

The date and time the alarm was most recently raised.

Sample Output

alarm state  description                                                              entity                               alarm name                          alarm statechange time
1            Volume desired replication is 1, current replication is 0                mapr.qa-node173.qa.prv.local.logs    VOLUME_ALARM_DATA_UNDER_REPLICATED  1296707707872
1            Volume data unavailable                                                  mapr.qa-node173.qa.prv.local.logs    VOLUME_ALARM_DATA_UNAVAILABLE       1296707707871
1            Volume desired replication is 1, current replication is 0                mapr.qa-node235.qa.prv.local.mapred  VOLUME_ALARM_DATA_UNDER_REPLICATED  1296708283355
1            Volume data unavailable                                                  mapr.qa-node235.qa.prv.local.mapred  VOLUME_ALARM_DATA_UNAVAILABLE       1296708283099
1            Volume desired replication is 1, current replication is 0                mapr.qa-node175.qa.prv.local.logs    VOLUME_ALARM_DATA_UNDER_REPLICATED  1296706343256

Examples

List a summary of all alarms

CLI
maprcli alarm list -summary 1
REST
https://r1n1.sj.us:8443/rest/alarm/list?summary=1

List cluster alarms

CLI
maprcli alarm list -type cluster 
REST
https://r1n1.sj.us:8443/rest/alarm/list?type=cluster