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

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.
    - 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).
      - entity info
        Displays information about an entity.
      - entity list
        Lists and displays information about entities.
      - entity modify
        Modifies a user or group quota or email address. Permissions required: fc or a.
    - 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.

entity list

Lists and displays information about entities.

Syntax

CLI

maprcli entity list
    [ -alarmedentities true|false ]
    [ -cluster <cluster> ]
    [ -columns <columns> ]
    [ -filter <filter> ]
    [ -limit <rows> ]
    [ -output terse|verbose ]
    [ -start <start> ]

REST

http[s]://<host>:<port>/rest/entity/list?<parameters>

Parameters

Parameter	Description
alarmedentities	Specifies whether to list only entities that have exceeded a quota or advisory quota.
cluster	The cluster on which to run the command.
columns	A comma-separated list of fields to return in the query. See the Fields table below.
filter	A filter specifying entities to display. See Filters for more information.
limit	The number of rows to return, beginning at start. Default: 0
output	Specifies whether output should be `terse` or `verbose`.
start	The offset from the starting row according to sort. Default: 0

Output

Information about the users and groups.

Table 1. Fields
Field	Short Name	Description
EntityType	t	Entity type `0` = User `1` = Group
EntityName	n	User or Group name
EntityId	id	User or Group id
EntityQuota	qta	Quota, in MB. `0` = no quota.
EntityAdvisoryquota	aqt	Advisory quota, in MB. `0` = no advisory quota.
VolumeCount	vct	The number of volumes this entity owns.
DiskUsage	dsu	Disk space used for all entity's volumes, in MB.

Sample Output

DiskUsage  EntityQuota  EntityType  EntityName  VolumeCount  EntityAdvisoryquota  EntityId  
5859220    0            0           root        209          0                    0

Examples

List all entities:

CLI

maprcli entity list

REST

https://10.10.82.23:8443/rest/entity/list

Filter entities by entity name:

CLI

maprcli entity list -filter "[EntityName==mapr]"

REST

https://10.10.82.23:8443/rest/entity/list?filter=[EntityName%3D%3Dmapr]