This is documentation for MapR Version 5.0. You can also refer to MapR documentation for the latest release.

Skip to end of metadata
Go to start of metadata


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 or volume name or Ae name> ]
    [ -limit <limit> ] Default: 2147483647
    [ -output (terse|verbose) ] Default: verbose
    [ -start <offset> ] Default: 0
    [ -summary (0 or false|1 or true) ] Default: false (0)
    [ -type <cluster or node or volume or 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.

start

The list offset at which to start.

summary

Specifies the type of data to return:

  • 1 = count by alarm type
  • 0 = List of alarms

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

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

  • No labels