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 ]
    [ -all list all raised alarms including the ones which are muted Parameter takes no value  ]
    [ -cluster cluster_name ]
    [ -entity entity (hostname OR volume name OR Ae name) ]
   [ -entitylimit entitylimit ]
    [ -filter none. default: none ]
   [ -from alarms raised after time(in millis) ]
   [ -getcount Send count of currently raised alarms Parameter takes no value  ] 
    [ -history list cleared up alarms only Parameter takes no value  ]
    [ -limit limit. default: 2147483647 ]
    [ -muted list alarms configured to be mute Parameter takes no value  ]
    [ -output output. default: verbose ]
    [ -sortby <alarmname|alarmdescription|alarmtype|alarmstate|alarmraised|alarmcleared|alarmentity|alarmmutetime|alarmmuteupto|alarmmuteduration|alarmgroups> ]
   [ -sortorder <asc|desc> ]
    [ -start start. default: 0 ]
    [ -summary summary ]
   [ -till alarms raised before time(in millis) ]   
    [ -type type (CLUSTER OR NODE OR VOLUME OR AE) ]
REST
Request Type GET
Request URL
http[s]://<host>:<port>/rest/alarm/list?<parameters> 

Parameters

Parameter

Description

alarm The alarm name for which to return information.
all The list of all raised and muted alarms.
cluster The cluster on which to list alarms.
entity The name of the cluster, node, volume, user, or group to check for alarms.
entitylimit The number of alarm occurrences to return per alarm type. For example, if there are 10 alarms of type VOLUME_ALARM_COMPACTION_FAILURE and the entity limit is set to 4, then only the four latest alarm occurrences of type VOLUME_ALARM_COMPACTION_FAILURE are listed.
filter A filter specifying alarms to list. See Filters for more information. Default: none
from The list of alarms raised after a moment in time (specified in ms). Use from in conjunction with till to list alarms that have been raised within the specified period.
getcount The count of all alarms raised at the moment in time when you invoke this command.
history The list of all alarms cleared in the last 30 days. Muted alarms are not displayed in the output.
limit The number of records to retrieve. Default: 2147483647
muted The list of alarms that are muted.
output Indicates whether the output should be terse or verbose. Default: verbose
sortby Specifies one of the following attributes by which to sort the list of alarms: alarmname, alarmdescripton, alarmtype, alarmstate, alarmraised, alarmcleared, alarmentity, alarmmutetime, alarmmuteupto, alarmmuteduration, alarmgroups. By default, the list of alarms is sorted by alarmtype.
sortorder Sorts the output in either ascending or descending order.
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: false (0)
till The list of alarms raised before a moment in time (specified in ms). Use till in conjunction with from to list alarms that have been raised within the specified period.
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 when 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

List all muted alarms

CLI
# maprcli alarm list -muted
mute duration muted time    mute upto     entity  alarm name
15 mins       1495702964190 1495703864190 CLUSTER CLUSTER_ALARM_LICENSE_NEAR_EXPIRATION
15 mins       1495702964192 1495703864192 vol3    VOLUME_ALARM_DATA_UNDER_REPLICATED
10 mins       1495702899201 1495703499201 vol2    VOLUME_ALARM_DATA_UNDER_REPLICATED
15 mins       1495702964188 1495703864188 vol1    VOLUME_ALARM_DATA_UNDER_REPLICATED
REST API
https://r1n1.sj.us:8443/rest/alarm/list?muted