dump volumeinfo
Returns information about volumes and the associated containers. For JSON formatted output, use the -json option from the command line.
A volume is a logical unit that allows you to apply policies to a set of files, directories, and sub-volumes. Using volumes, you can enforce disk usage limits, set replication levels, establish ownership and accountability, and measure the cost generated by different projects or departments. For more information, see Administering Volumes.
Syntax
- CLI
-
maprcli dump volumeinfo [-cluster <cluster name>] -volumename <volume name> [-ctime <true|false>]
- REST
- N/A
Parameters
- ctime
-
Set to
true
to display container state/role change time.Default:
false
- cluster
-
The cluster on which to run the command. If this parameter is omitted, the command is run on the cluster on which it is issued. In multi-cluster contexts, you can use this parameter to specify a different cluster on which to run the command.
- volumename
- The name of the volume. To obtain volume names, use the volume list
maprcli volume list
command. This parameter is mandatory.
Output
maprcli volume info
returns information about the volume and the
containers associated with that volume. Volume information includes the ID, volume name,
and replication factor. For each container on the specified volume, the command returns
information about nodes and storage. See the following Example
for sample output. - AccessTime
- Indicates the volumes that are accessed regularly. This value is updated every 6 hours with the last time that an operation occurred on the volume. The access time is not updated for changes to volume properties, creation of a snapshot, or synchronization between a volume and a mirror. However, the volume access time is updated the first time you upgrade to a data-fabric version that includes this property. This property was introduced in data-fabric version 4.0.2.
- ActiveServers
- The IP address and port number of each active node on which the container resides.
- allowGrant
- Indicates whether (
true
) or not (false
) a parent volume grants permission for a child volume to inherit its properties. - Audited
- Indicates whether (
1
) or not (0
) auditing is enabled for the volume. - AuditVolume
- Indicates whether (
1
) or not (0
) the volume accommodates audit logs. - CoalesceInterval
- The interval of time to elapse after the first instance of an operation on a node is recorded in audit logs, if auditing is enabled. Subsequent identical operations performed on the same node from the same client are ignored during the interval.
- ContainerId
- The unique ID number of the container.
- CreatorContainerId
- The container ID of the read-write container. The container ID is retained in all mirrors of those containers (in all mirrors of the volume). The container ID enables the identification of the correct containers to source from, when mirror sources are changed in a mirror chain.
- CreatorVolumeUuid
- A randomly generated unique ID that is shared by all mirrors of a volume, and all containers of them. You can use this ID to avoid undesirable chaining of containers when mirror sources are changed in a mirror chain.
- dareEnabled
- Indicates whether (
1
) or not (0
) data-at-rest encryption (DARE) is enabled for the volume. - DisabledDataAuditOperations
- The list of operations excluded from auditing.
- EnabledDataAuditOperations
- The list of operations selected for auditing.
- enforcementMode
- The data access enforcement mode.
- Epoch
- A sequence number that indicates the most recent copy of the container. The CLDB uses the epoch to ensure that an out-of-date copy cannot become the master for the container.
- fixCreatorId
- An internal flag for data-fabric volumes to fix the creator container ID.
- ForceAudit
- Indicates whether (
1
) or not (0
) to force audit of operations on all files, tables, and streams in the volume. - InactiveServers
- The IP address and port number of each inactive node on which the container resides.
- label
- The label associated with the volume. See Using Storage Labels for more information on labels.
- limitSpread
- An internal flag for data-fabric volumes to control the growth of a volume in terms of number of containers. When this flag is set, CLDB tries to limit the number of new containers created, depending on the present size of a volume. If a volume size (data in volume) is small, CLDB tries to reuse space in existing containers to avoid the creation of new containers. This reuse helps reduce wastage of containers IDs in an environment that has small volumes.
- LogicalSizeMB
- The logical size on disk (in MB) of the container.
- Master
- The IP address and port number of the master copy. The master copy is part of the original copy of the volume.
- MetricsEnabled
- Indicates whether (
1
) or not (0
) metrics collection is enabled for the volume. - MirrorThrottle
- Specifies whether mirror throttling is enabled (true) or disabled (false). Throttling is set on the source volume and applies to all its mirrors. This property was introduced in MapR version 4.0.2.
- Mtime
- Indicates the time when the last modification was made to the contents of the container.
- NameContainer
- Indicates if the container is the name container for the volume. If
true
, the container is the first container of the volume. Replication then occurs simultaneously from the master to the intermediate and tail containers. - NameSpaceMinReplication
- The minimum replication factor or the number of copies of the name container associated with the volume that should be maintained by the data-fabric cluster for normal operation. When the replication factor falls below this minimum value, writes to the volume are disabled. The default value is 2.
- NameSpaceReplication
- The desired replication factor or the number of copies of the name container associated with the volume. The default value is 3. The maximum value is 6.
- nslabel
- The name container label. See Using Storage Labels for more information on labels.
- NumInodesInUse
- Indicates the uumber of inodes used by the container.
- OwnedSizeMB
- The size on disk (in MB) dedicated to the container.
- ReReplicationTimeOutSec
- The timeout (in seconds) period until CLDB starts re-replicating the containers on the node of the volume, when CLDB stops receiving a heartbeat from the node.
- securityPolicyTags
- The list of security policy tags to be associated with this volume.
- SharedSizeMB
- The size on disk (in MB) shared by the container.
- TenantUser
- Displays the name of the tenant user, if any.
- TotalSizeMB
- The total size on disk (in MB) allocated to the container. Combines the Owned Size and Shared Size.
- UnusedServers
- The IP address and port number of servers from which no "heartbeat" has been received for quite some time.
- VolumeId
- The unique ID number of the volume.
- VolumeMinReplication
- The minimum replication factor. Indicates the number of copies of a volume (including the original) that should be maintained by the data-fabric cluster for normal operation. When the replication factor falls below this minimum value, writes to the volume are disabled. The default value is 2. A replication factor of 2 indicates that the number of copies of a volume is 2 (original +1 copy). A replication factor of 3 indicates that the number of copies of a volume is 3 (original + 2 copies).
- VolumeName
- The name of the volume.
- VolumeReplication
- The desired replication factor. Indicates the number of copies of a volume. The default value is 3. The maximum value is 6.
- VolumeTopology
- The volume topology corresponds to the node topology of the rack or nodes
where the volume resides. By default, new volumes are created with a topology
of
/
(root directory). For more information, see Setting Up Node Topology. - VolumeUsedSizeMB
- The size on disk (in MB) of the volume.
- WireSecurityEnabled
- Indicates whether (
1
) or not (0
) wire-level security is enabled.
Example
Dump volume information# /opt/mapr/bin/maprcli dump volumeinfo -cluster docs41cluster -volumename sampleVol -ctime true -json
{
"timestamp":1435363982346,
"timeofday":"2015-06-26 05:13:02.346 GMT-0700",
"status":"OK",
"total":2,
"data":[
{
"VolumeName":"sampleVol",
"VolumeId":47274128,
"VolumeTopology":"/data",
"VolumeUsedSizeMB":0,
"VolumeReplication":3,
"VolumeMinReplication":2,
"NameSpaceReplication":3,
"NameSpaceMinReplication":2,
"ReReplicationTimeOutSec":0,
"MirrorThrottle":true,
"AccessTime":"Fri Jun 26 09:38:30 PDT 2015",
"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",
"WireSecurityEnabled":"1",
"securityPolicyTags":"Lab_Security_Policy,Sensitive_Data",
"enforcementMode":"PolicyAceAndDataAce",
"limitSpread":true,
"allowGrant":false,
"fixCreatorId":false,
"MetricsEnabled":"0",
"dareEnabled":1
"label":"label1",
"nslabel":"label1"
},
{
"ContainerId":2049,
"Epoch":3,
"Master":"10.10.100.126:5660-10.10.101.126:5660-172.17.42.1:5660--3-VALID",
"ActiveServers":{
"IP:Port":"10.10.100.126:5660-10.10.101.126:5660-172.17.42.1:5660--3-VALID, ctime: 2020-09-07 23:15:40"
},
"InactiveServers":{
},
"UnusedServers":{
},
"OwnedSizeMB":"0 MB",
"SharedSizeMB":"0 MB",
"LogicalSizeMB":"0 MB",
"TotalSizeMB":"0 MB",
"NumInodesInUse":41,
"Mtime":"Fri Jun 26 13:27:35 PDT 2015",
"NameContainer":"true",
"CreatorContainerId":0,
"CreatorVolumeUuid":"-8225749748229459176:-4287758954200211096",
"UseActualCreatorId":true
}
]
}
# curl -k -X GET 'https://abc.sj.us:8443/rest/dump/volumeinfo?volumename=sampleVol&ctime=true' --user mapr:mapr
{"timestamp":1531074195026,"timeofday":"2018-07-08 11:23:15.026 GMT-0700 AM","status":"OK","total":2,"data":[{"VolumeName":"sampleVol","VolumeId":245584625,"VolumeTopology":"/data","VolumeUsedSizeMB":0,"VolumeReplication":3,"VolumeMinReplication":2,"NameSpaceReplication":3,"NameSpaceMinReplication":2,"ReReplicationTimeOutSec":0,"MirrorThrottle":true,"AccessTime":"July 7, 2018","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","WireSecurityEnabled":"1",
"securityPolicyTags":"Lab_Security_Policy,Sensitive_Data",
"enforcementMode":"PolicyAceAndDataAce","limitSpread":true,
"allowGrant":false,"fixCreatorId":false,"MetricsEnabled":"0",dareEnabled":0,"label":"label1","nslabel":"label1"},{"ContainerId":2068,"Epoch":3,
"Master":"10.10.82.24:5660--3-VALID","ActiveServers":{"IP:Port":"10.10.100.126:5660-10.10.101.126:5660-172.17.42.1:5660--3-VALID, ctime: 2020-09-07 23:15:40""IP:Port":"10.10.82.24:5660--3-VALID"},"InactiveServers":{},"UnusedServers":{},"OwnedSizeMB":"0 MB","SharedSizeMB":"0 MB","LogicalSizeMB":"0 MB","TotalSizeMB":"0 MB","NumInodesInUse":256,"Mtime":"July 7, 2018","NameContainer":"true","CreatorContainerId":2068,"CreatorVolumeUuid":"-8225749748229459176:-4287758954200211096","UseActualCreatorId":true}]}