Home
6.0 Administration
This section describes how to manage the nodes and services that make up a cluster.
Administrator's Reference
This section contains in-depth reference information for the administrator.
maprcli and REST API Syntax
This section provides information about the MapR command API. Most commands can be run on the command-line interface (CLI), or by making REST requests programmatically or in a browser.
table
Performs functions related to MapR-DB tables.
table index
Manages indexes for MapR-DB JSON tables.

6.0 Administration
This section describes how to manage the nodes and services that make up a cluster.
- Administering Users and Clusters
- Administering Nodes
- Administering Volumes
  This section provide information about how to organize and manage data using volumes, a unique feature of MapR clusters.
- Administering Files and Directories
- Administering Tables
  Administration of the MapR-DB is done primarily via the command line (maprcli) or with the MapR Control System (MCS). Regardless of whether the MapR-DB table is used for binary files or JSON documents, the same types of commands are used with slightly different parameter options. MapR-DB administration is associated with tables, columns and column families, and table regions.
- Administering Streams
- Administering MapR Gateways
  A MapR gateway mediates one-way communication between a source MapR cluster and a destination cluster. You can replicate MapR-DB tables (binary and JSON) and MapR-ES streams. MapR gateways also apply updates from JSON tables to their secondary indexes and propagate Change Data Capture (CDC) logs.
- Administering Services
- Monitoring the Cluster
  This section describes how to monitor the health and performance of a MapR cluster.
- Configuring Security
  Describes how to configure MapR security and manage secure clusters.
- Managing Secure Clusters
  Provides procedures that will enable you to use MapR clusters securely.
- Administering the MapR Data Access Gateway
  The MapR Data Access Gateway is a service that acts as a proxy and gateway for translating requests between lightweight client applications and the MapR cluster. This section describes considerations when upgrading the service, how to modify configuration settings, and how to administer and manage the service.
- Planning for High Availability
- Administrator's Reference
  This section contains in-depth reference information for the administrator.
  - maprcli and REST API Syntax
    This section provides information about the MapR command API. Most commands can be run on the command-line interface (CLI), or by making REST requests programmatically or in a browser.
    - Overview
      Each command reference page includes the command syntax, a table that describes the parameters, and examples of command usage.
    - acerole validate
      Verifies given user roles for ACEs exists in the /opt/mapr/conf/m7_permissions_roles_refimpl.conf file.
    - acl
      Describes the acl commands used to access control lists (ACLs).
    - alarm
      Describes the alarm commands that perform functions related to system alarms.
    - 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.
    - 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.
      - table create
        Creates a new MapR-DB binary or JSON table.
      - table cf
        Manages column families for MapR-DB tables.
      - table changelog
        These maprcli commands are used to create and manage Change Data Capture (CDC) changelogs. A changelog is used to establish a relationship between a MapR-DB source table (JSON or binary) and a MapR-ES stream topic and to manage the propagation process.
      - table delete
        Deletes a MapR-DB binary or JSON table.
      - table edit
        Edits the attributes of a MapR-DB binary or JSON table.
      - table index
        Manages indexes for MapR-DB JSON tables.
        table index add
        This topic describes how to add secondary indexes on MapR-DB JSON tables.
        table index list
        This topic describes how to list information about the secondary indexes created on MapR-DB JSON tables.
        table index remove
        This topic describe how to remove secondary indexes that are no longer needed.
      - table info
        Displays information about a MapR-DB binary or JSON table, or an index on a JSON table.
      - table region
        Manages table regions for MapR-DB binary and JSON tables.
      - table replica
        Performs functions related to replication of MapR-DB binary and JSON tables. Replication occurs for binary-to-binary tables and JSON-to-JSON tables.
      - table upstream
        Performs functions related to upstream sources for table replication.
    - 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.
  - Utilities
    This section contains information about various scripts and utilities.
  - Configuration Files
    This section contains reference information about various configuration files.
  - Alarms Reference
    The pages in this section provide details about all of the types of alarms.
  - MapR Environment
    This section provides information associated with the MapR environment.
- Troubleshooting Cluster Administration
- Best Practices for Backing Up MapR Information

table index

Manages indexes for MapR-DB JSON tables.

Permissions Required

To run this command, your user ID must have the following permissions:

readAce on the volume
lookupdir on directories in the table path

NOTE: The mapr user is not treated as a superuser. MapR-DB does not allow the mapr user to run this command unless that user is given the relevant permission or permissions with access-control expressions.