volume list
Lists information about volumes specified by name, path, or filter.
See the Fields table on the volume page for the fields available to filter. See the Filters for more information.
Syntax
- CLI
-
/opt/mapr/bin/maprcli volume list [ -cluster cluster_name ] [ -output verbose. default: verbose ] [ -start start. default: 0 ] [ -limit limit. default: 2147483647 ] [ -filter none. default: none ] [ -nodes nodes ] [ -columns comma separated list of column names. default: all ] [ -alarmedvolumes alarmsonly. default: false ] [ -sortby <volumeowner|volumenumreplicas|volumeminreplicas|volumerackpath|volumemountdir|volumename|volumequota|volumeused|volumequotaadvisory|volumeaename|volumeaetype|volumeschedule|volumetype|volumemirrortype|volumemirrorpercentcomplete|volumesnapshotcount|volumeid|volumenamecontainersize|volumelocalpath|volumesnapshotused|volumetotalused|volumelogicalused|volumecontainercount|volumemirrorschedule|volumeaccesstime|volumenamespacecontainernumreplicas|volumenamespacecontainerminreplicas|volumerereplicationtimeoutsec|volumecriticalrereplicationtimeoutsec|volumecreatetime|volumedareenabled|volumeallowreadforexecute|volumedatacntrlabel|volumenamecntrlabel>, column names of supported fields. ] [ -sortorder <asc|desc> ] [ -honoraces honoraces. default: false ]
NOTEFor JSON formatted output, use the-json
option when runningvolume list
from the command line. - REST
Request Type GET Request URL http[s]://<host>:<port>/rest/volume/list[?<parameters>]
Parameters
Parameter | Description |
---|---|
cluster |
The cluster name on which to run the command. |
output |
Specifies whether the output should be terse or
verbose . Default: verbose |
start |
The offset from the starting row according to sort. Default: 0 |
limit |
The number of rows to return, beginning at start. Default: 2147483647 |
filter |
A filter specifying volumes to list. See Filters for more information. Default: none |
nodes |
A list of nodes. If specified, volume list only lists
volumes on the specified nodes. |
columns |
A comma-separated list of fields to return in the query. See the volume table on the volume page. When issuing the
|
alarmedvolumes |
Specifies whether (1) or not (0) to list alarmed volumes only. Default: 0 |
sortby |
Specifies one of the following attributes to sort the list of volumes
by: volumeowner , volumenumreplicas ,
volumeminreplicas , volumerackpath ,
volumemountdir , volumename ,
volumequota , volumeused ,
volumequotaadvisory , volumeaename ,
volumeaetype , volumeschedule ,
volumetype ,
volumemirrorpercentcomplete ,
volumesnapshotcount , volumeid ,
volumenamecontainersize ,
volumelocalpath , volumesnapshotused ,
volumetotalused , volumelogicalused ,
volumecontainercount ,
volumemirrorschedule , volumeaccesstime ,
volumenamespacecontainernumreplicas ,
volumenamespacecontainerminreplicas ,
volumerereplicationtimeoutsec ,
volumecriticalrereplicationtimeoutsec ,
volumecreatetime ,
volumedareenabled |
sortorder |
Specifies whether the list of volumes is sorted in an ascending or a
descending order. Sorting of records is based on the value specified for the
sortby parameter. |
honoraces |
The parameter facilitates the filtering of volumes for listing purpose,
based on the volume-level permissions of the currently logged in user. When
you set the values as true, volume information for the volumes on which the
current user has read/write permissions, is displayed. The default value for
the honoraces parameter is false. |
Output
Information about the specified volumes.
For standard and mirror volumes (not enabled for tiering), the output looks similar to the following:
{
"timestamp":1435363624712,
"timeofday":"2015-06-26 05:07:04.712 GMT-0700",
"status":"OK",
"total":14,
"data":[
{
"creator":"mapr",
"aename":"mapr",
"aetype":0,
"atimeUpdateInterval":"2",(Applicable only for Standard volumes)
"numreplicas":"3",
"minreplicas":"2",
"nsNumReplicas":"3",
"nsMinReplicas":"2",
"enforceMinReplicationForIO":"false",
"containerAllocationFactor":"0",
"allowGrant":"true",
"reReplTimeOutSec":"0",
"criticalReReplTimeOutSec":"0",
"replicationtype":"high_throughput",
"rackpath":"/data",
"mirrorthrottle":"1",
"accesstime":"June 25, 2018",
"readonly":"0",
"mountdir":"",
"volumename":"sampleVol",
"mounted":0,
"quota":"0",
"advisoryquota":"0",
"snapshotcount":"0",
"logicalUsed":"1",
"replicatedlogicalused":"1",
"used":"1",
"snapshotused":"0",
"totalused":"1",
"replicatedtotalused":"0",
"scheduleid":2,
"schedulename":"Important data",
"mirrorscheduleid":0,
"volumetype":0,
"mirrortype":3,
"creatorcontainerid":0,
"creatorvolumeuuid":"",
"volumeid":172948486,
"actualreplication":[
0,
100,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"nameContainerSizeMB":0,
"nameContainerDataThresholdMB":524288,
"needsGfsck":false,
"maxinodesalarmthreshold":"0",
"maxnssizembalarmthreshold":"0",
"dbrepllagsecalarmthresh":"0",
"dbindexlagsecalarmthresh":"0",
"limitspread":"true",
"partlyOutOfTopology":0,
"wireSecurity":0,
"auditVolume":0,
"audited":0,
"forceAudit":0,
"coalesceInterval":60,
"enableddataauditoperations":"setattr,chown,chperm,chgrp,getxattr,listxattr,setxattr,removexattr,read,write,create,delete,mkdir,readdir,rmdir,createsym,lookup,rename,createdev,truncate,tablecfcreate,tablecfdelete,tablecfmodify,tablecfScan,tableget,tableput,tablescan,tablecreate,tableinfo,tablemodify,getperm,getpathforfid,hardlinkfilescan,fileoffload,filerecall,filetierjobstatus,filetierjobabort",
"disableddataauditoperations":"getattr,filetieroffloadevent,filetierrecallevent",
"mirrorSrcVolume":"",
"mirrorSrcVolumeId":0,
"mirrorSrcCluster":"",
"mirrorDataSrcVolume":"",
"mirrorDataSrcVolumeId":0,
"mirrorDataSrcCluster":"",
"lastSuccessfulMirrorTime":0,
"mirror-percent-complete":0,
"mirrorId":0,
"nextMirrorId":0,
"mirrorstatus":1,
"numcontainers":"0",
"fixCreatorId":"false",
"ReplTypeConversionInProgress":0,
"creationTime":1524064440329,
"metricsEnabled":0,
"dareEnabled":1,
"tierenable":"false",
"SnapshotFailureAlarm":0,
"MirrorFailureAlarm":0,
"DataUnderReplicatedAlarm":1435351165700,
"DataUnavailableAlarm":0,
"AdvisoryQuotaExceededAlarm":0,
"QuotaExceededAlarm":0,
"NoNodesInTopologyAlarm":0,
"AlmostFullTopologyAlarm":0,
"FullTopologyAlarm":0,
"InodesExceededAlarm":0,
"BecomePrimaryStuckAlarm":0,
"ContainersNonLocalAlarm":0,
"CannotMirrorAlarm":0,
"TableIndexLagHighAlarm":0,
"LargeRowWarning":0,
"TableIndexEncodingErrorAlarm":0,
"TableReplicationErrorAlarm":0,
"TableReplicationLagHighAlarm":0,
"TableReplicationAsyncAlarm":0,
"TableIndexErrorAlarm":0
}
]
}
For standard and mirror volumes enabled for warm-tier, the output looks similar to the following:
{
"creator":"mapr",
"aename":"mapr",
"aetype":"0",
"atimeUpdateInterval":"2",(Applicable only for Standard volumes)
"numreplicas":"3",
"minreplicas":"2",
"nsNumReplicas":"3",
"nsMinReplicas":"2",
"enforceMinReplicationForIO":"false",
"containerAllocationFactor":"0",
"allowGrant":"false",
"reReplTimeOutSec":"0",
"criticalReReplTimeOutSec":"0",
"replicationtype":"high_throughput",
"rackpath":"/data",
"mirrorthrottle":"1",
"accesstime":"June 18, 2018",
"readonly":"0",
"mountdir":"/volt_warm",
"volumename":"volt_warm",
"mounted":1,
"quota":"0",
"advisoryquota":"0",
"snapshotcount":0,
"logicalUsed":"0",
"replicatedlogicalused":"0",
"used":"0",
"snapshotused":"0",
"totalused":"0",
"replicatedtotalused":"0",
"scheduleid":"0",
"schedulename":"",
"mirrorscheduleid":"0",
"volumetype":"0",
"mirrortype":3,
"creatorcontainerid":0,
"creatorvolumeuuid":"",
"volumeid":236703387,
"actualreplication":[
0,
100,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"nameContainerSizeMB":0,
"nameContainerDataThresholdMB":524288,
"needsGfsck":"false",
"maxinodesalarmthreshold":"0",
"maxnssizembalarmthreshold":"0",
"dbrepllagsecalarmthresh":"0",
"dbindexlagsecalarmthresh":"0",
"limitspread":"true",
"partlyOutOfTopology":0,
"wireSecurity":1,
"auditVolume":0,
"audited":0,
"forceAudit":0,
"coalesceInterval":60,
"enableddataauditoperations":"setattr,chown,chperm,chgrp,getxattr,listxattr,setxattr,removexattr,read,write,create,delete,mkdir,readdir,rmdir,createsym,lookup,rename,createdev,truncate,tablecfcreate,tablecfdelete,tablecfmodify,tablecfScan,tableget,tableput,tablescan,tablecreate,tableinfo,tablemodify,getperm,getpathforfid,hardlink,filescan,fileoffload,filerecall,filetierjobstatus,filetierjobabort",
"disableddataauditoperations":"getattr,filetieroffloadevent,filetierrecallevent",
"mirrorSrcVolume":"",
"mirrorSrcVolumeId":0,
"mirrorSrcCluster":"",
"mirrorDataSrcVolume":"",
"mirrorDataSrcVolumeId":0,
"mirrorDataSrcCluster":"",
"lastSuccessfulMirrorTime":0,
"mirror-percent-complete":0,
"mirrorId":0,
"nextMirrorId":0,
"mirrorstatus":1,
"numcontainers":"1",
"fixCreatorId":"false",
"ReplTypeConversionInProgress":0,
"creationTime":1529342213327,
"metricsEnabled":0,
"dareEnabled":0,
"tierlocal":"0",
"tierpurged":"0",
"tierrecall":"0",
"tierenable":"true",
"tierid":"136140692",
"tierruleid":"1",
"tieroffloadscheduleid":"4",
"tierrecallexpirytime":"0",
"tiercompactionscheduleid":"0",
"tiercompactionoverheadthresh":"None",
"tierjobtype":"offload",
"tierjobstate":"FailureFatal",
"tierjobstarttime":"2018-06-20 10:18:10.285 GMT-0700",
"tierjobendtime":"2018-06-20 10:18:18.805 GMT-0700",
"tierjobprogress":"0",
"tierjobtotaloffloadsize":"0",
"tierjoboffloadavgthroughputmbps":"0",
"tierjobrecallavgthroughputmbps":"0",
"gateway":"Currently down",
"tiername":"autoec.volt_warm.1529342212",
"tiertype":"ectier",
"ecscheme":"4+2",
"ecstripedepthmb":"4",
"ecstorevolume":"mapr.internal.ec.volt_warm.236703387",
"ectopology":"/data",
"ectotalused":0,
"SnapshotFailureAlarm":0,
"MirrorFailureAlarm":0,
"DataUnderReplicatedAlarm":1529384390911,
"DataUnavailableAlarm":0,
"AdvisoryQuotaExceededAlarm":0,
"QuotaExceededAlarm":0,
"NoNodesInTopologyAlarm":0,
"AlmostFullTopologyAlarm":0,
"FullTopologyAlarm":0,
"InodesExceededAlarm":0,
"BecomePrimaryStuckAlarm":0,
"ContainersNonLocalAlarm":0,
"CannotMirrorAlarm":0,
"TableIndexLagHighAlarm":0,
"LargeRowWarning":0,
"TableIndexEncodingErrorAlarm":0,
"TableReplicationErrorAlarm":0,
"TableReplicationLagHighAlarm":0,
"TableReplicationAsyncAlarm":0,
"TableIndexErrorAlarm":0
}
For standard and mirror volumes enabled for cold-tier, the output looks similar to the following:
{
"creator":"mapr",
"aename":"mapr",
"aetype":"0",
"atimeUpdateInterval":"2",(Applicable only for Standard volumes)
"numreplicas":"3",
"minreplicas":"2",
"nsNumReplicas":"3",
"nsMinReplicas":"2",
"enforceMinReplicationForIO":"false",
"containerAllocationFactor":"0",
"allowGrant":"false",
"reReplTimeOutSec":"0",
"criticalReReplTimeOutSec":"0",
"replicationtype":"high_throughput",
"rackpath":"/data",
"mirrorthrottle":"1",
"accesstime":"June 18, 2018",
"readonly":"0",
"mountdir":"/volt_only",
"volumename":"volt_only",
"mounted":1,
"quota":"0",
"advisoryquota":"0",
"snapshotcount":0,
"logicalUsed":"0",
"replicatedlogicalused":"0",
"used":"0",
"snapshotused":"0",
"totalused":"0",
"replicatedtotalused":"0",
"scheduleid":"0",
"schedulename":"",
"mirrorscheduleid":"0",
"volumetype":"0",
"mirrortype":3,
"creatorcontainerid":0,
"creatorvolumeuuid":"",
"volumeid":162353415,
"actualreplication":[
0,
100,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"nameContainerSizeMB":0,
"nameContainerDataThresholdMB":524288,
"needsGfsck":"false",
"maxinodesalarmthreshold":"0",
"maxnssizembalarmthreshold":"0",
"dbrepllagsecalarmthresh":"0",
"dbindexlagsecalarmthresh":"0",
"limitspread":"true",
"partlyOutOfTopology":0,
"wireSecurity":1,
"auditVolume":0,
"audited":0,
"forceAudit":0,
"coalesceInterval":60,
"enableddataauditoperations":"setattr,chown,chperm,chgrp,getxattr,listxattr,setxattr,removexattr,read,write,create,delete,mkdir,readdir,rmdir,createsym,lookup,rename,createdev,truncate,tablecfcreate,tablecfdelete,tablecfmodify,tablecfScan,tableget,tableput,tablescan,tablecreate,tableinfo,tablemodify,getperm,getpathforfid,hardlink,filescan,fileoffload,filerecall,filetierjobstatus,filetierjobabort",
"disableddataauditoperations":"getattr,filetieroffloadevent,filetierrecallevent",
"mirrorSrcVolume":"",
"mirrorSrcVolumeId":0,
"mirrorSrcCluster":"",
"mirrorDataSrcVolume":"",
"mirrorDataSrcVolumeId":0,
"mirrorDataSrcCluster":"",
"lastSuccessfulMirrorTime":0,
"mirror-percent-complete":0,
"mirrorId":0,
"nextMirrorId":0,
"mirrorstatus":1,
"numcontainers":"1",
"fixCreatorId":"false",
"ReplTypeConversionInProgress":0,
"creationTime":1529342295570,
"metricsEnabled":0,
"dareEnabled":0,
"tierlocal":"0",
"tierpurged":"0",
"tierrecall":"0",
"tierenable":"true",
"tieroffloadscheduleid":"0",
"tierrecallexpirytime":"0",
"tiercompactionscheduleid":"0",
"tiercompactionoverheadthresh":"None",
"gateway":"Currently down",
"SnapshotFailureAlarm":0,
"MirrorFailureAlarm":0,
"DataUnderReplicatedAlarm":1529384390923,
"DataUnavailableAlarm":0,
"AdvisoryQuotaExceededAlarm":0,
"QuotaExceededAlarm":0,
"NoNodesInTopologyAlarm":0,
"AlmostFullTopologyAlarm":0,
"FullTopologyAlarm":0,
"InodesExceededAlarm":0,
"BecomePrimaryStuckAlarm":0,
"ContainersNonLocalAlarm":0,
"CannotMirrorAlarm":0,
"TableIndexLagHighAlarm":0,
"LargeRowWarning":0,
"TableIndexEncodingErrorAlarm":0,
"TableReplicationErrorAlarm":0,
"TableReplicationLagHighAlarm":0,
"TableReplicationAsyncAlarm":0,
"TableIndexErrorAlarm":0
}
Fields
For definitions of the output fields, and short names for use with filters, see the Fields table on the volume command page.
Examples
List all volumes
- CLI
-
/opt/mapr/bin/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.
/opt/mapr/bin/maprcli volume list -start 0 -limit 10 -json
curl -X GET 'https://server.sj.us:8443/rest/node/list?start=0&limit=10' --user <username>:<password>
Filter by aename
maprcli volume list -filter '[aename==mapr]' -columns volumeid
volumeid
243256560
139026416
192452723
1
237238261
185847104
83335307
97256251
248672744
206179696
59269298
23746740
155195506
204064014
243050615
175781739
109532950
86259431
161806152
111826621
161383512
42835142
91977453
40523868
246476194
26484100
157091944
184799162
141342643
29373265
153950841
193510550
17691624
curl -X GET 'https://server.sj.us:8443/rest/volume/list?filter=%5Baename%3D%3Dmapr%5D&columns=volumeid' --user mapr:mapr
{"timestamp":1528315774026,"timeofday":"2018-06-06 01:09:34.026 GMT-0700 PM","status":"OK","total":33,"data":[{"volumeid":243256560},{"volumeid":139026416},{"volumeid":192452723},{"volumeid":1},{"volumeid":237238261},{"volumeid":185847104},{"volumeid":83335307},{"volumeid":97256251},{"volumeid":248672744},{"volumeid":206179696},{"volumeid":59269298},{"volumeid":23746740},{"volumeid":155195506},{"volumeid":204064014},{"volumeid":243050615},{"volumeid":175781739},{"volumeid":109532950},{"volumeid":86259431},{"volumeid":161806152},{"volumeid":111826621},{"volumeid":161383512},{"volumeid":42835142},{"volumeid":91977453},{"volumeid":40523868},{"volumeid":246476194},{"volumeid":26484100},{"volumeid":157091944},{"volumeid":184799162},{"volumeid":141342643},{"volumeid":29373265},{"volumeid":153950841},{"volumeid":193510550},{"volumeid":17691624}]}
Filter by tiertype
/opt/mapr/bin/maprcli volume list -filter '[tiertype==ectier]' -columns volumename
volumename
egWarmVol
sampleECmirrorVol
sampleECvol
sampleVol
sampleVol3
sampleVol3Mirror
warmTierMirroVol
curl -X GET 'https://server.sj.us:8443/rest/volume/list?filter=%5Btiertype%3D%3Dectier%5D&columns=volumename' --user mapr:mapr
{"timestamp":1528315936495,"timeofday":"2018-06-06 01:12:16.495 GMT-0700 PM","status":"OK","total":7,"data":[{"volumename":"egWarmVol"},{"volumename":"sampleECmirrorVol"},{"volumename":"sampleECvol"},{"volumename":"sampleVol"},{"volumename":"sampleVol3"},{"volumename":"sampleVol3Mirror"},{"volumename":"warmTierMirroVol"}]}
View the names of all tagged volumes and the tags
/opt/mapr/bin/maprcli volume list -columns volumename,securitypolicy -filter [securitypolicy==".*"] -json
{
"timestamp":1536015078199,
"timeofday":"2018-09-03 03:51:18.199 GMT-0700 PM",
"status":"OK",
"total":1,
"data":[
{
"volumename":"securevol",
"securityPolicyTags":"[hipaa, hipaa2]"
}
{
"volumename":"taggedvolume",
"securitypolicy":"hipaa"
}
]
}
curl -X GET 'https://abc.sj.us:8443/rest/volume/list?filter=%5Bsecuritypolicy%3D%3D.*%5D&columns=volumename,securitypolicy' --user mapr:mapr
{"timestamp":1536015078199,"timeofday":"2018-09-03 03:51:18.199 GMT-0700 PM","status":"OK","total":1,"data":[{"volumename":"securevol","securityPolicyTags":"[hipaa, hipaa2]"},{"volumename":"taggedvolume","securityPolicyTags":"[hipaa]"}]}
View the security policy settings filtered by all volumes tagged with the hipaa2 security policy
/opt/mapr/bin/maprcli volume list -columns volumename,securityPolicyTags,enforcementMode -filter [securitypolicy=="*hipaa2*"] -json
{
"timestamp":1536709231057,
"timeofday":"2018-09-11 04:40:31.057 GMT-0700 PM",
"status":"OK",
"total":2,
"data":[
{
"volumename":"securevol",
"securitypolicy":"hipaa,hipaa2",
"enforcementMode":"PolicyAceAndDataAce"
}
]
}
curl -X GET 'https://server.sj.us:8443/rest/volume/list?filter=%5Bsecuritypolicy%3D%3D*hippa2*%5D&columns=volumename,securityPolicyTags,enforcementMode' --user mapr:mapr
{"timestamp":1536709231057,"timeofday":"2018-09-03 04:40:31.057 GMT-0700 PM","status":"OK","total":2,"data":[{"volumename":"securevol","securitypolicy":"hipaa, hipaa2","enforcementMode":"PolicyAceAndDataAce"}]}
View the list of names of all volumes that are not tagged with security policies:
/opt/mapr/bin/maprcli volume list -columns volumename -filter [securityPolicyTags==""] -json
{
"timestamp":1536018146446,
"timeofday":"2018-09-03 04:42:26.446 GMT-0700 PM",
"status":"OK",
"total":21,
"data":[
…
{
"volumename":"mapr.cldb.internal"
},
{
"volumename":"mapr.cluster.root"
},
{
"volumename":"mapr.configuration"
},
{
"volumename":"mapr.hbase"
},
{
"volumename":"mapr.metrics"
},
…
{
"volumename":"myvolume"
},
{
"volumename":"users"
}
]
}
curl -X GET 'https://server.sj.us:8443/rest/volume/list?filter=%5BsecurityPolicyTags%3D%3D""%5D&columns=volumename' --user <adminuser>:<password>
{"timestamp":1536018146446,"timeofday":"2018-09-03 04:42:26.446 GMT-0700 PM","status":"OK","total":3,"data":[{"volumename":"mapr.cldb.internal"},{"volumename":"mapr.cluster.root"},{"volumename":"mapr.configuration"}]}
Filter the list of volumes that the logged in user has permissions on
# maprcli volume list -honoraces true -json
curl -X GET 'https://server.sj.us:8443/rest/volume/list?honoraces=true --user <username>:<password>