MapR 5.1 is at End of Life (EOL) and no longer supported. Please see the latest documentation. This documentation is not being updated.

Home
5.1 Reference
This section provides information about development content including MapR-FS and MapReduce development topics and reference content.
Reference Guide
maprcli and REST API Syntax
alarm
Describes the alarm commands that perform functions related to system alarms.
alarm raise
Raises a specified alarm or alarms. Permissions required: fc or a.

MapR 5.1 Documentation

5.1 Reference
This section provides information about development content including MapR-FS and MapReduce development topics and reference content.
- Development Guide
- Reference Guide
  - MapR Control System
  - Hadoop Commands
  - HBase Shell for MapR-DB
    You can manage MapR-DB tables using HBase shell commands and additional HBase shell commands included in the MapR distribution of Hadoop.
  - YARN commands
  - maprcli and REST API Syntax
    - Overview
      Each command reference page includes the command syntax, a table that describes the parameters, and examples of command usage.
    - acl
      Describes the acl commands used to access control lists (ACLs).
    - alarm
      Describes the alarm commands that perform functions related to system alarms.
      - alarm clear
        Clears one or more alarms. Permissions required: fc or a.
      - alarm clearall
        Clears all alarms. Permissions required: fc or a.
      - alarm config load
        Displays the configuration of alarm notifications. Permission required: login
      - alarm config save
        Sets notification preferences for alarms. Permissions required: fc or a.
      - alarm list
        Lists alarms in the system. Permissions required: login.
      - alarm names
        Displays a list of alarm names. Permissions required: login
      - alarm raise
        Raises a specified alarm or alarms. Permissions required: fc or a.
    - audit
      Describes commands used to audit operations related to cluster management and data access.
    - blacklist
      Describes commands used to blacklist and to list blacklisted users.
    - cluster
      Manages cluster features, gateways, and cluster-wide settings.
    - config
      Manages configuration values for the MapR cluster.
    - dashboard info
      Displays a summary of information about the cluster.
    - dialhome
    - disk
      Describes command for working with disks.
    - dump
      Returns key information about volumes, containers, storage pools, and MapR cluster services for debugging and troubleshooting.
    - entity
      Manages entities (users and groups).
    - fid
      Displays information about MapR-DB or file-system components that are identified by a FID.
    - job
      Manages Hadoop jobs running on the cluster.
    - license
      Manages MapR licenses.
    - nagios generate
      Generates a Nagios Object Definition file that describes the cluster nodes and the services running on each.
    - nfsmgmt
      Refreshes NFS exports and server cache.
    - node
      Manages nodes in the cluster
    - rlimit
      Manages resource usage limits for the cluster.
    - schedule
      Manages schedules.
    - service list
      Lists all services on the specified node, the memory allocated for each service, the state of each service, and log path for each service.
    - setloglevel
      Sets log level on individual services.
    - stream
      Manages stream functionality.
    - table
      Performs functions related to MapR-DB tables.
    - task
      Manipulates information about the Hadoop jobs that are running on your cluster.
    - trace
      Lets you view and modify the trace buffer, and the trace levels for the system modules.
    - urls
      Displays the status page URL for the specified service.
    - virtualip
      Manages virtual IP addresses for NFS nodes.
    - volume
      Manages volumes, snapshots and mirrors.
  - Alarms Reference
  - Utilities
  - Default MapR Configurations
  - Configuration Files
  - MapR Environment
  - MapR Parameters
  - Best Practices
  - Language Support for MapR-DB Tables
  - Glossary
    This section contains defintions for commonly used terms in MapR Converged Data Platform environments.
  - Source Code for MapR Software
- Glossary
  This section contains defintions for commonly used terms in MapR Converged Data Platform environments.

alarm raise

Raises a specified alarm or alarms. Permissions required: fc or a.

Syntax

CLI

maprcli alarm raise
     -alarm <alarm>
    [ -cluster <cluster> ]
    [ -description <description> ] 
    [ -entity <cluster, entity, host, node, or volume> ]

REST

http[s]://<host>:<port>/rest/alarm/raise?<parameters>

Parameters

Parameter	Description
alarm	The alarm type to raise. See Alarm Types.
cluster	The cluster on which to run the command.
description	A brief description.
entity	The entity on which to raise alarms.

Examples

Raise a specific alarm:

CLI

maprcli alarm raise -alarm NODE_ALARM_DEBUG_LOGGING

REST

https://r1n1.sj.us:8443/rest/alarm/raise?alarm=NODE_ALARM_DEBUG_LOGGING