Viewing Volume Details

Explains how to retrieve and view volume information using the Control System, the CLI, or the REST API.

Viewing Volume Details in the Control System

Procedure

Log in to the Control System and go to the Summary tab in the volume information page for the volume.
The page displays the following:
Quota Usage
Amount of disk space allocated to and utilized by the volume and associated snapshots. For more information, see Monitoring Volume Disk Usage Using the Control System. You can set or edit hard and advisory quotas by clicking Edit Quota. See Setting or Modifying Quota for a Volume for more information.
Active Alarms
Currently active alarms associated with the volume. For more information, see Viewing Active Volume Alarms. You can mute or dismiss alarms by clicking the associated link.
Schedules
The schedules associated with the volume. Standard volumes can have associated snapshot schedule; mirror volumes can have associated snapshot and mirroring schedules; tiered volumes can have associated snapshot and tiering schedules. You can:
Properties
Created By Indicates the user who created the volume.
Volume Type Indicates the type of volume. Value can be one of the following:
  • Standard Volume
  • Mirror Volume
Volume Name Indicates the name of the volume.
Accountable Entity Indicates the name of the accountable entity.
Volume Access Indicates the type of access allowed on the volume. Value can be one of the following:
  • Read/Write
  • Read-only
Mounted Indicates whether or not volume is mounted.
Mount Path Indicates the mount path of the volume.
Collect Metrics Indicates if metrics collection is enabled for the volume.
Last accessed Indicates the date when the volume was last accessed.
Last Access Interval Indicates the frequency (in days) at which the last access time of a file is updated,
Replication and Storage
Table 1. REPLICATION (HOT)
Topology Denotes the location of the volume on the cluster rack.
Replication Indicates the minimum (Min Target) and desired (Max Target) number of copies for the volume data.
Name Container Replication Indicates the minimum (Min Target) and desired (Max Target) number of copies of the name container associated with the volume.
Optimize Replication Indicates the basis for replication. Value can be one of the following:
  • High throughput, or cascading replication
  • Low latency, or star replication
Guarantee Min Replication Indicates whether or not to enforce minimum number of copies.
Actual Replication Indicates the actual number of replicas as a percentage.

The following information is common to all types of storage:

Table 2. Common Storage Information
Type Indicates the storage type.
Label - Volume Indicates the label assigned to the volume.
Label - Name Container Indicates the label assigned to the volume's name container.
Usage Displays disk usage details for the volume.
NOTE
The following is visible only if warm tiering is enabled for the volume.
Table 3. ERASURE CODING (WARM)
Topology Indicates the topology of the erasure-coded volume.
Remote Target Indicates the name of the tier.
Storage Policy Name Indicates the name of the storage policy.
Policy Detail Indicates the rules in the policy for offloading data.
Retention Duration after Recall Indicates the period of time to keep recalled data in the hot tier.
Erasure Coding Scheme Indicates the number of data and parity chunks.
Tier Purged Indicates the amount of offloaded data.
NOTE
The following is visible only if cold tiering is enabled for the volume.
Table 4. REMOTE ARCHIVING (COLD)
Remote Target Indicates the name of the remote storage.
Storage Policy Name Indicates the name of the storage policy.
Policy Detail Indicates the rules in the policy for offloading data.
Retention Duration after Recall Indicates the number of days to keep recalled data in the data-fabric cluster (hot tier).
Tier Purged Indicates the amount of offloaded data.
Security
The enforcement mode for the security settings. See Volume-Level Security Policy Enforcement Mode for more information. You can set new or modify existing enforcement mode by clicking .
The security policies associated with the volume. See Policy-Based Security for more information.
Indicates the entities — public or user, group, and/or role — that have (read and/or write) access to volume data. See Managing Access Control Expressions for more information.
Enable Auditing Indicates whether auditing is enabled at the volume level.
Audit Operations Indicates whether default or custom list of operations are being audited.
Data on Wire Encryption Indicates whether (Yes) or not (No) on-wire encryption is enabled for the volume.
Data at Rest Encryption Indicates whether (Yes) or not (No) data-at-rest encryption (DARE) is enabled for the volume.
Coalesce Interval Indicates the interval of time (in minutes) used for logging multiple READ, WRITE, or GETATTR operations on one file from one client IP address, if auditing is enabled.
Volume Admin Control
Indicates the users and/or groups who have one or more of the following types of permissions on the volume:
  • Dump & Backup — Transport large amount of data or copies of the volume on physical media to a remote cluster using backup files.
  • Restore & Mirror — Restore a volume from a dump file and create mirror volumes, which is a read-only copy of the source volume.
  • Edit — Edit volume properties, create and delete snapshots.
  • Delete — Delete the volume.
  • Admin — View and edit access control settings (but cannot perform other volume administrative operations).
  • Full Control — Perform all volume-related administrative operations except changing access control settings.

Viewing Volume Information Using the CLI and the REST API

About this task

The basic command to retrieve volume information is:

maprcli volume info (-name <volume_name> | -path <volume_path>)
Send a request of type GET. For example: 
curl -X GET 'https://<hostname>:8443/rest/volume/info?name=<volName>' --user <username>:<password>
You must specify either name or path, but not both. For more information, see volume info.