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.



Fields

Field

Description

EntityType

Entity type

  • 0 = User
  • 1 = Group

EntityName

User or Group name

EntityId

User or Group id

EntityQuota

Quota, in MB. 0 = no quota.

EntityAdvisoryquota

Advisory quota, in MB. 0 = no advisory quota.

VolumeCount

The number of volumes this entity owns.

DiskUsage

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]