volume info

Displays information about the specified volume. For JSON formatted output, use the -json option when running the command.

Syntax

CLI
maprcli volume info
    [ -cluster <cluster name> ]
    [ -output verbose. default: verbose ]
    [ -path <mount directory> ]
    [ -name <volume name> ]
    [ -columns comma separated list of column names. default: all ]
REST
Request Type GET
Request URL
http[s]://<host>:<port>/rest/volume/info?<parameters>

Parameters

You must specify either name or path, but not both.

Parameter

Description

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 on the volume command page. Default: all

name

The volume name for which to retrieve information. When issuing the maprcli volume info -columns and marcli volume list -columns commands, the column for the volume name is volumename.

output

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

path

The mount path of the volume for which to retrieve information.

Output

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

Examples

Return information on standard volume named test_vol:

/opt/mapr/bin/maprcli volume info -name test_vol -json
{
	"timestamp":1666959376858,
	"timeofday":"2022-10-28 05:16:16.858 GMT-0700 AM",
	"status":"OK",
	"total":1,
	"data":[
	{
	"acl":{
	"Principal":"User root",
	"Allowed actions":"[dump, restore, m, a, d, fc]"
	},
	"creator":"root",
	"aename":"root",
	"aetype":"0",
	"numreplicas":"3",
	"minreplicas":"2",
	"atimeUpdateInterval":"0",
	"nsNumReplicas":"3",
	"nsMinReplicas":"2",
	"enforceMinReplicationForIO":"false",
	"containerAllocationFactor":"0",
	"reReplTimeOutSec":"0",
	"criticalReReplTimeOutSec":"0",
	"replicationtype":"high_throughput",
	"rackpath":"/data",
	"mirrorthrottle":"1",
	"accesstime":"October 28, 2022",
	"readonly":"0",
	"mountdir":"/myVol",
	"volumename":"myVol",
	"mounted":1,
	"quota":"0",
	"advisoryquota":"0",
	"snapshotcount":0,
	"logicalUsed":"721",
	"replicatedlogicalused":"2163",
	"used":"721",
	"snapshotused":"0",
	"numFile":"1",
	"numDir":"0",
	"numFidMap":"1",
	"numTable":"0",
	"numS3Bucket":"0",
	"totalused":"721",
	"replicatedtotalused":"2163",
	"scheduleid":"0",
	"schedulename":"",
	"mirrorscheduleid":"0",
	"volumetype":"0",
	"mirrortype":3,
	"creatorcontainerid":2312,
	"creatorvolumeuuid":"-8154395437541698325:41319391394798                                                                             92771",
	"volumeid":2930349,
	"actualreplication":[
				  0,
				  0,
				  0,
				  100,
				  0,
				  0,
				  0,
				  0,
				  0,
				  0,
				  0
		],
	"nameContainerSizeMB":0,
	"nameContainerId":2312,
	"nameContainerDataThresholdMB":524288,
	"needsGfsck":"false",
	"maxinodesalarmthreshold":"0",
	"maxnssizembalarmthreshold":"0",
	"dbrepllagsecalarmthresh":"0",
	"dbindexlagsecalarmthresh":"0",
	"limitspread":"true",
	"partlyOutOfTopology":0,
	"wireSecurity":1,
	"skipWireSecuityForTierInternalOps":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,tab                                                  {
	"timestamp":1666959465973,
	"timeofday":"2022-10-28 05:17:45.973 GMT-0700 AM",
	"status":"OK",
	"total":1,
	"data":[
	{
		"acl":{
			"Principal":"User root",
			"Allowed actions":"[dump, restore, m, a, d, fc]"
			},
		"creator":"root",
		"aename":"root",
		"aetype":"0",
		"numreplicas":"3",
		"minreplicas":"2",
		"atimeUpdateInterval":"0",
		"nsNumReplicas":"3",
		"nsMinReplicas":"2",
		"enforceMinReplicationForIO":"false",
		"containerAllocationFactor":"0",
		"reReplTimeOutSec":"0",
		"criticalReReplTimeOutSec":"0",
		"replicationtype":"high_throughput",
		"rackpath":"/data",
		"mirrorthrottle":"1",
		"accesstime":"October 28, 2022",
		"readonly":"0",
		"mountdir":"/myVol",
		"volumename":"myVol",
		"mounted":1,
		"quota":"0",
		"advisoryquota":"0",
		"snapshotcount":0,
		"logicalUsed":"721",
		"replicatedlogicalused":"2163",
		"used":"721",
		"snapshotused":"0",
		"numFile":"1",
		"numDir":"0",
		"numFidMap":"1",
		"numTable":"0",
		"numS3Bucket":"0",
		"totalused":"721",
		"replicatedtotalused":"2163",
		"scheduleid":"0",
		"schedulename":"",
		"mirrorscheduleid":"0",
		"volumetype":"0",
		"mirrortype":3,
		"creatorcontainerid":2312,
		"creatorvolumeuuid":"-8154395437541698325:4131939139479892771",
		"volumeid":2930349,
		"actualreplication":[
					  0,
					  0,
					  0,
					  100,
					  0,
					  0,
					  0,
					  0,
					  0,
					  0,
					  0
					],
		"nameContainerSizeMB":0,
		"nameContainerId":2312,
		"nameContainerDataThresholdMB":524288,
		"needsGfsck":"false",
		"maxinodesalarmthreshold":"0",
		"maxnssizembalarmthreshold":"0",
		"dbrepllagsecalarmthresh":"0",
		"dbindexlagsecalarmthresh":"0",
		"limitspread":"true",
		"partlyOutOfTopology":0,
		"wireSecurity":1,
		"skipWireSecuityForTierInternalOps":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,hardlink,filescan,fileoffload,filerecall,filetierjobstatus,filetierjobabort",
		"disableddataauditoperations":"getattr,filetieroffloadevent,filetierrecallevent",
		"numactivecgcontainers":0,
		"numcontainers":"6",
		"nummetacontainers":"0",
		"volumeAces":{
				  "readAce":"p",
				  "writeAce":"p"
				},
		"enforcementmode":"PolicyAceAndDataAce",
		"fixCreatorId":"false",
		"ReplTypeConversionInProgress":0,
		"creationTime":1666958963262,
		"metricsEnabled":0,
		"dareEnabled":0,
		"allowReadForExecute":0,
		"label":"default",
		"nslabel":"default",
		"tierenable":"false"
	   }
	]
}					
curl -k -X GET 'https://abc.sj.us:8443/rest/volume/info?name=test_vol' --user mapr:mapr
{"timestamp":1529545951212,"timeofday":"2018-06-20 06:52:31.212 GMT-0700 PM","status":"OK",
 "total":1,"data":[{"acl":{"Principal":"User mapr",
 "Allowed actions":"[dump, restore, m, a, d, fc]"},"creator":"mapr","aename":"mapr","aetype":"0",
"numreplicas":"3","minreplicas":"2","nsNumReplicas":"3","nsMinReplicas":"2",
 "enforceMinReplicationForIO":"true","containerAllocationFactor":"0","reReplTimeOutSec":"0",
 "criticalReReplTimeOutSec":"0","replicationtype":"high_throughput","rackpath":"/data",
 "mirrorthrottle":"1","accesstime":"June 20, 2018","readonly":"0","mountdir":"/test_vol",
 "volumename":"test_vol","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":2117,
 "creatorvolumeuuid":"-8953141547368591763:-5762925753444373354","volumeid":84378231,
 "actualreplication":[0,100,0,0,0,0,0,0,0,0,0],"nameContainerSizeMB":0,"nameContainerId":2117,
 "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",
 "numactivecgcontainers":0,"numcontainers":6,"nummetacontainers":0,"volumeAces":{"writeAce":"p","readAce":"p"},"fixCreatorId":"false",
 "ReplTypeConversionInProgress":0,"creationTime":1529545198145,"metricsEnabled":1,
 "dareEnabled":1,"tierenable":"false"}]}

Return information on volume named volt_warm enabled for warm-tier:

/opt/mapr/bin/maprcli volume info -name volt_warm -json
{
	"timestamp":1666960195475,
	"timeofday":"2022-10-28 05:29:55.475 GMT-0700 AM",
	"status":"OK",
	"total":1,
	"data":[
	
		  "accesstime":"October 28, 2022",
		  "readonly":"0",
		  "mountdir":"/volt_warm",
		  "volumename":"volt_warm",
		  "mounted":1,
		  "quota":"0",
		  "advisoryquota":"0",
		  "snapshotcount":0,
		  "logicalUsed":"721",
		  "replicatedlogicalused":"2163",
		  "used":"721",
		  "snapshotused":"0",
		  "numFile":"1",
		  "numDir":"0",
		  "numFidMap":"1",
		  "numTable":"0",
		  "numS3Bucket":"0",
		  "totalused":"721",
		  "replicatedtotalused":"2163",
		  "scheduleid":"0",
		  "schedulename":"",
		  "mirrorscheduleid":"0",
		  "volumetype":"0",
		  "mirrortype":3,
		  "creatorcontainerid":2325,
		  "creatorvolumeuuid":"-8154395437541698325:-987139294933122774",
		  "volumeid":21571618,
		  "actualreplication":"Information is not yet available for volume 'volt_warm'. Please try again.",
		  "nameContainerSizeMB":0,
		  "nameContainerId":2325,
		  "nameContainerDataThresholdMB":524288,
		  "needsGfsck":"false",
		  "maxinodesalarmthreshold":"0",
		  "maxnssizembalarmthreshold":"0"disableddataauditoperations":"getattr,filetieroffloadevent,filetierrecallevent",
		  "numactivecgcontainers":0,
	         "numcontainers":"6",
		  "nummetacontainers":"0",
		  "volumeAces":{
		  "readAce":"p",
		  "writeAce":"p"
		 },
		"enforcementmode":"PolicyAceAndDataAce",
		"fixCreatorId":"false",
		"ReplTypeConversionInProgress":0,
		"creationTime":1666960142764,
		"metricsEnabled":0,
		"dareEnabled":0,
		"allowReadForExecute":0,
		"label":"default",
		"nslabel":"default",
		"tierlocal":"721",
		"tierpurged":"0",
		"tierrecall":"0",
		"tierenable":"true",
		"autooffloadthresholdgb":"1024",
		"tierid":"173029456",
		"tierruleid":"1",
		"tieroffloadscheduleid":"4",
		"tierrecallexpirytime":"1",
		"tiercompactionscheduleid":"4",
		"tiercompactionoverheadthresh":"30",
		"honorRackReliability":false,
		"gateway":"NA",
		"ecscheme":"3+2",
		"ecstripedepthmb":"4",
		"ecstorevolume":"mapr.internal.ec.volt_warm.21571618",
		"ectopology":"/data",
		"eclabel":"default",
		"ectotalused":0
		}
		]
	}
curl -k -X GET 'https://abc.sj.us:8443/rest/volume/info?name=volt_warm' --user mapr:mapr
{"timestamp":1529546479334,"timeofday":"2018-06-20 07:01:19.334 GMT-0700 PM",
"status":"OK","total":1,"data":[{"acl":{"Principal":"User mapr","Allowed actions":"[dump, restore, 
m, a, d, fc]"},"creator":"mapr","aename":"mapr","aetype":"0","numreplicas":"3","minreplicas":"2",
"nsNumReplicas":"3","nsMinReplicas":"2","enforceMinReplicationForIO":"false",
"containerAllocationFactor":"0","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":2070,
"creatorvolumeuuid":"-8953141547368591763:5326977893687028655","volumeid":236703387,
"actualreplication":[0,100,0,0,0,0,0,0,0,0,0],"nameContainerSizeMB":0,"nameContainerId":2070,
"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",
"numactivecgcontainers":0,"numcontainers":"6","nummetacontainers":"0","volumeAces":{"readAce":"p","writeAce":"p"},"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":"1",
"tiercompactionscheduleid":"4","tiercompactionoverheadthresh":"30",
"gateway":"Currently down","ecscheme":"4+2","ecstripedepthmb":"4",
"ecstorevolume":"mapr.internal.ec.volt_warm.236703387","ectopology":"/data","eclabel":"anywhere","ectotalused":0}]}

Return information on volume named volt_cold enabled for cold-tier:

maprcli volume info -name volt_cold -json
{
        "timestamp":1666960892115,
        "timeofday":"2022-10-28 05:41:32.115 GMT-0700 AM",
        "status":"OK",
        "total":1,
        "data":[
                {
                    
                        "aename":"mapr",
                        "aetype":"0",
                        "numreplicas":"3",
                        "minreplicas":"2",
                        "atimeUpdateInterval":"0",
                        "nsNumReplicas":"3",
                        "nsMinReplicas":"2",
                        "enforceMinReplicationForIO":"false",
                        "containerAllocationFactor":"0",
                        "reReplTimeOutSec":"0",
                    
                        "snapshotcount":0,
                        "logicalUsed":"721",
                        "replicatedlogicalused":"2163",
                        "used":"721",
                        "snapshotused":"0",
                        "numFile":"1",
                        "numDir":"0",
                        "numFidMap":"1",
                        "numTable":"0",
                        "numS3Bucket":"0",
                        "totalused":"721",
                        "replicatedtotalused":"2163",
                    ,
                        "creatorvolumeuuid":"-8154395437541698325:4316108003539534759",
                        "volumeid":20303534,
                                                      0
                        ],
                        "nameContainerSizeMB":0,
                        "nameContainerId":2333,
                        "nameContainerDataThresholdMB":524288,
                        "needsGfsck":"false",
                        "maxinodesalarmthreshold":"0",
                        "maxnssizembalarmthreshold":"0",
                        "dbrepllagsecalarmthresh":"0",
                        "dbindexlagsecalarmthresh":"0",
                        "limitspread":"true",
                        "partlyOutOfTopology":0,
                        "wireSecurity":1,
                        "skipWireSecuityForTierInternalOps":0,
                        "auditVolume":0,
                        "audited":0,
                        "forceAudit":0,
                        "coalesceInterval":60,
                       attr,filetieroffloadevent,filetierrecallevent",
                        "numactivecgcontainers":0,
                        "numcontainers":"6",
                        "nummetacontainers":"0",
                        "volumeAces":{
                                "readAce":"p",
                                "writeAce":"p"
                        },
                        "enforcementmode":"PolicyAceAndDataAce",
                        "fixCreatorId":"false",
                        "ReplTypeConversionInProgress":0,
                        "creationTime":1666960749643,
                        "metricsEnabled":0,
                        "dareEnabled":0,
                        "allowReadForExecute":0,
                        "label":"default",
                        "nslabel":"default",
                        "tierlocal":"721",
                        "tierpurged":"0",
                        "tierrecall":"0",
                        "tierenable":"true",
                        "tierid":"209270518",
                        "tierruleid":"1",
                        "tieroffloadscheduleid":"0",
                        "tierencryption":"true",
                        "tierrecallexpirytime":"1",
                        "tiercompactionscheduleid":"4",
                        "tiercompactionoverheadthresh":"30",
                        "honorRackReliability":false,
                        "gateway":"NA"
                }
        ]
}
curl -k -X GET 'https://abc.sj.us:8443/rest/volume/info?name=volt_cold' --user mapr:mapr
{"timestamp":1529546321584,"timeofday":"2018-06-20 06:58:41.584 GMT-0700 PM",
"status":"OK","total":1,"data":[{"acl":{"Principal":"User mapr",
"Allowed actions":"[dump, restore, m, a, d, fc]"},
"creator":"mapr","aename":"mapr","aetype":"0","numreplicas":"3","minreplicas":"2",
"nsNumReplicas":"3","nsMinReplicas":"2","enforceMinReplicationForIO":"false",
"containerAllocationFactor":"0","reReplTimeOutSec":"0",
"criticalReReplTimeOutSec":"0","replicationtype":"high_throughput","rackpath":"/data",
"mirrorthrottle":"1","accesstime":"June 18, 2018","readonly":"0","mountdir":"/volt_cold",
"volumename":"volt_cold","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":2073,
"creatorvolumeuuid":"-8953141547368591763:8600373021905500606","volumeid":20110455,
"actualreplication":[0,100,0,0,0,0,0,0,0,0,0],"nameContainerSizeMB":0,"nameContainerId":2073,
"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","numactivecgcontainers":0,"numcontainers":6,
"nummetacontainers":0,"volumeAces":{"readAce":"p","writeAce":"p"},
"fixCreatorId":"false","ReplTypeConversionInProgress":0,"creationTime":1529342278943,
"metricsEnabled":0,"dareEnabled":0,"tierlocal":"0","tierpurged":"0","tierrecall":"0",
"tierenable":"true","tierid":"222693986","tierruleid":"1","tieroffloadscheduleid":"0",
"tierencryption":"false","tierrecallexpirytime":"1","tiercompactionscheduleid":"4",
"tiercompactionoverheadthresh":"30","gateway":"Currently down"}]}