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 information about volumes specified by name, path, or filter. For best results, use the -json option when running volume list from the command line.

See the Fields table on the volume page for the fields available to filter. See the maprcli and REST API Syntax page for information on filters.

Syntax

CLI

maprcli volume list
    [ -alarmedvolumes 1 ]
    [ -cluster <cluster> ]
    [ -columns <columns> ]
    [ -filter <filter> ]
    [ -limit <limit> ]
    [ -nodes <nodes> ]
    [ -output terse | verbose ]
    [ -start <offset> ]

REST

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

Parameters



Parameter

Description

alarmedvolumes

Specifies whether to list alarmed volumes only. Default: false

cluster

The cluster name on which to run the command.

columns

A comma-separated list of fields to return in the query. See the Fields table on the volume page. Note: When issuing maprcli volume info -columns and marcli volume list -columns commands, the column for the volume name is volumename.

filter

A filter specifying volumes to list. See API Reference for more information. Default: none

limit

The number of rows to return, beginning at start. Default: 2147483647

nodes

A list of nodes. If specified, volume list only lists volumes on the specified nodes.

output

Specifies whether the output should be terse or verbose. Default: verbose

start

The offset from the starting row according to sort. Default: 0

Fields

For definitions of the output fields, and short names for use with filters, see the Fields table on the volume command page.

Output

Information about the specified volumes.


Examples

List all volumes

CLI

maprcli volume list -json

REST

https://10.10.82.23:8443/rest/volume/list

 

List the first ten volumes

The start and limit parameters are useful for windowing the results. You can list the first ten volumes, then the next ten, and so on.

CLI

maprcli volume list -start 0 -limit 10

REST

https://r1n1.sj.us:8443/rest/node/list?start=0&limit=10

Filter by aename

CLImaprcli volume list -filter '[aename==mapr]' -columns volumeid
RESThttps://10.10.82.23:8443/rest/volume/list?filter=%5Baename%3D%3Dmapr%5D&columns=volumeid

 

 

  • No labels