Retrieve a volume
GET /storage/volumes/{uuid}
Introduced In: 9.6
Retrieves a volume. The GET API can be used to retrieve the quota state for a FlexVol or a FlexGroup volume.
Expensive properties
There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields
query parameter. See Requesting specific fields to learn more.
-
is_svm_root
-
analytics.*
-
anti_ransomware.*
-
application.*
-
encryption.*
-
convert_unicode
-
clone.parent_snapshot.name
-
clone.parent_snapshot.uuid
-
clone.parent_svm.name
-
clone.parent_svm.uuid
-
clone.parent_volume.name
-
clone.parent_volume.uuid
-
clone.split_complete_percent
-
clone.split_estimate
-
clone.split_initiated
-
efficiency.*
-
error_state.*
-
files.*
-
max_dir_size
-
nas.export_policy.id
-
nas.gid
-
nas.path
-
nas.security_style
-
nas.uid
-
nas.unix_permissions
-
nas.junction_parent.name
-
nas.junction_parent.uuid
-
snaplock.*
-
restore_to.*
-
snapshot_policy.uuid
-
quota.*
-
qos.*
-
flexcache_endpoint_type
-
space.block_storage_inactive_user_data
-
space.capacity_tier_footprint
-
space.performance_tier_footprint
-
space.local_tier_footprint
-
space.footprint
-
space.over_provisioned
-
space.metadata
-
space.total_footprint
-
space.dedupe_metafiles_footprint
-
space.dedupe_metafiles_temporary_footprint
-
space.delayed_free_footprint
-
space.file_operation_metadata
-
space.snapmirror_destination_footprint
-
space.volume_guarantee_footprint
-
space.cross_volume_dedupe_metafiles_footprint
-
space.cross_volume_dedupe_metafiles_temporary_footprint
-
space.auto_adaptive_compression_footprint_data_reduction
-
space.effective_total_footprint
-
space.snapshot_reserve_unusable
-
space.snapshot_spill
-
space.user_data
-
space.logical_space.*
-
space.snapshot.*
-
space.used_by_afs
-
space.afs_total
-
space.available_percent
-
space.full_threshold_percent
-
space.nearly_full_threshold_percent
-
space.overwrite_reserve
-
space.overwrite_reserve_used
-
space.size_available_for_snapshots
-
space.percent_used
-
space.fractional_reserve
-
space.block_storage_inactive_user_data_percent
-
space.physical_used
-
space.physical_used_percent
-
space.expected_available
-
space.filesystem_size
-
space.filesystem_size_fixed
-
guarantee.*
-
autosize.*
-
movement.*
-
statistics.*
-
asynchronous_directory_delete.*
Related ONTAP commands
-
volume show
-
volume clone show
-
volume efficiency show
-
volume encryption show
-
volume flexcache show
-
volume flexgroup show
-
volume move show
-
volume quota show
-
volume show-space
-
volume snaplock show
-
security anti-ransomware volume show
-
security anti-ransomware volume attack generate-report
-
security anti-ransomware volume space show
-
volume file async-delete client show
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
uuid |
string |
path |
True |
Unique identifier of the volume. |
is_constituent |
boolean |
query |
False |
When set to false, only FlexVol and FlexGroup volumes are returned. When set to true, only FlexGroup constituent volumes are returned. Default for GET calls is false.
|
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
access_time_enabled |
boolean |
Indicates whether or not access time updates are enabled on the volume. |
activity_tracking |
||
aggregates |
array[aggregates] |
Aggregate hosting the volume. Required on POST. |
analytics |
||
anti_ransomware |
Anti-ransomware related information of the volume. |
|
anti_ransomware_state |
string |
The Anti-ransomware state of the volume. If no "anti_ransomware_state" property is specified, the volume inherits the value from its parent SVM's "anti_ransomware_default_volume_state" property. If this value is "disabled", Anti-ransomware is disabled on the volume. If this value is "enabled", Anti-ransomware is enabled on the volume and alerts are raised if any suspect is detected for those volumes. If this value is "dry_run", Anti-ransomware is enabled in the dry-run or learning mode on the volume. The "dry_run" state is same as the "enabled" state except that the analytics data is used here for learning. No alerts are raised for any detections or violations. If this value is "paused", Anti-ransomware is paused on the volume. Additionally, three more states are available, which are only valid for GET. If this value is "disable_in_progress", Anti-ransomware monitoring is being disabled and a cleanup operation is in effect. If this value is "enable_paused", Anti-ransomware is paused on the volume from its earlier enabled state. If this value is "dry_run_paused", Anti-ransomware monitoring is paused on the volume from its earlier dry_run state. For POST, the valid Anti-ransomware states are only "disabled", "enabled" and "dry_run", whereas for PATCH, "paused" is also valid along with the three valid states for POST. |
application |
||
asynchronous_directory_delete |
Configuration for asynchronous directory delete from the client. This is only supported on Flexible volumes and FlexGroup volumes. |
|
autosize |
||
clone |
||
cloud_retrieval_policy |
string |
This parameter specifies the cloud retrieval policy for the volume. This policy determines which tiered out blocks to retrieve from the capacity tier to the performance tier. The available cloud retrieval policies are "default" policy retrieves tiered data based on the underlying tiering policy. If the tiering policy is 'auto', tiered data is retrieved only for random client driven data reads. If the tiering policy is 'none' or 'snapshot_only', tiered data is retrieved for random and sequential client driven data reads. If the tiering policy is 'all', tiered data is not retrieved. "on_read" policy retrieves tiered data for all client driven data reads. "never" policy never retrieves tiered data. "promote" policy retrieves all eligible tiered data automatically during the next scheduled scan. It is only supported when the tiering policy is 'none' or 'snapshot_only'. If the tiering policy is 'snapshot_only', the only data brought back is the data in the AFS. Data that is only in a snapshot copy stays in the cloud and if tiering policy is 'none' then all data is retrieved. |
comment |
string |
A comment for the volume. Valid in POST or PATCH. |
consistency_group |
Consistency group the volume is part of. |
|
constituents |
array[constituents] |
FlexGroup Constituents. FlexGroup Constituents can be retrieved more efficiently by specifying "is_constituent=true" or "is_constituent=true&flexgroup.uuid= |
constituents_per_aggregate |
integer |
Specifies the number of times to iterate over the aggregates listed with the "aggregates.name" or "aggregates.uuid" when creating or expanding a FlexGroup volume. If a volume is being created on a single aggregate, the system creates a flexible volume if the "constituents_per_aggregate" field is not specified, or a FlexGroup volume if it is specified. If a volume is being created on multiple aggregates, the system always creates a FlexGroup volume. The root constituent of a FlexGroup volume is always placed on the first aggregate in the list. |
convert_unicode |
boolean |
Specifies whether directory Unicode format conversion is enabled when directories are accessed by NFS clients. |
create_time |
string |
Creation time of the volume. This field is generated when the volume is created. |
efficiency |
||
encryption |
||
error_state |
||
files |
||
flash_pool |
||
flexcache_endpoint_type |
string |
FlexCache endpoint type. none ‐ The volume is neither a FlexCache nor origin of any FlexCache. cache ‐ The volume is a FlexCache volume. origin ‐ The volume is origin of a FlexCache volume. |
flexgroup |
||
granular_data |
boolean |
State of granular data on the volume. This setting is true by default when creating a new FlexGroup volume, but can be specified as false at the time of creation via a POST request. On FlexVol volumes, the setting is always false, as only FlexGroup volumes and FlexGroup constituents support this feature. Once enabled, this setting can only be disabled by restoring a Snapshot copy. Earlier versions of ONTAP (pre 9.11) are not compatible with this feature. Therefore, reverting to an earlier version of ONTAP is not possible unless this volume is deleted or restored to a Snapshot copy that was taken before the setting was enabled.
|
guarantee |
||
idcs_scanner |
Inactive data compression scan looks and picks up blocks that have not been read for a certain amount of time(threshold_inactive_days). These blocks are then compressed in 32K chunks. All attributes are valid for GET only, expect for 'op_state' that is valid for PATCH and GET, and is used to start/stop the scanner. |
|
is_object_store |
boolean |
Specifies whether the volume is provisioned for an object store server. |
is_svm_root |
boolean |
Specifies whether the volume is a root volume of the SVM it belongs to. |
language |
string |
Language encoding setting for volume. If no language is specified, the volume inherits its SVM language encoding setting. |
max_dir_size |
integer |
Maximum directory size. This value sets maximum size, in bytes, to which a directory can grow. The default maximum directory size for FlexVol volumes is model-dependent, and optimized for the size of system memory. Before increasing the maximum directory size, involve technical support. |
metric |
Performance numbers, such as IOPS, latency and throughput. |
|
movement |
Volume movement. All attributes are modify, that is, not writable through POST. Set PATCH state to destination_aggregate to initiate a volume move operation. Volume movement on FlexGroup constituents are not supported. |
|
msid |
integer |
The volume's Mirror Set ID. |
name |
string |
Volume name. The name of volume must start with an alphabetic character (a to z or A to Z) or an underscore (_). The name must be 197 or fewer characters in length for FlexGroups, and 203 or fewer characters in length for all other types of volumes. Volume names must be unique within an SVM. Required on POST. |
nas |
||
qos |
QoS information |
|
queue_for_encryption |
boolean |
Specifies whether the volume is queued for encryption. |
quota |
Quotas track the space or file usage of a user, group, or qtree in a FlexVol or a FlexGroup volume. |
|
rebalancing |
Configurations and settings involving non-disruptive volume capacity rebalancing for a FlexGroup volume. |
|
scheduled_snapshot_naming_scheme |
string |
Naming Scheme for automatic Snapshot copies:
|
size |
integer |
Physical size of the volume, in bytes. The minimum size for a FlexVol volume is 20MB and the minimum size for a FlexGroup volume is 200MB per constituent. The recommended size for a FlexGroup volume is a minimum of 100GB per constituent. For all volumes, the default size is equal to the minimum size. |
snaplock |
||
snapmirror |
Specifies attributes for SnapMirror protection. |
|
snapshot_count |
integer |
Number of Snapshot copies in the volume. |
snapshot_policy |
This is a reference to the Snapshot copy policy. |
|
space |
||
state |
string |
Volume state. Client access is supported only when volume is online and junctioned. Taking volume to offline or restricted state removes its junction path and blocks client access. When volume is in restricted state some operations like parity reconstruction and iron on commit are allowed. The 'mixed' state applies to FlexGroup volumes only and cannot be specified as a target state. An 'error' state implies that the volume is not in a state to serve data. |
statistics |
These are raw performance numbers, such as IOPS latency and throughput. These numbers are aggregated across all nodes in the cluster and increase with the uptime of the cluster. |
|
status |
array[string] |
Describes the current status of a volume. |
style |
string |
The style of the volume. If "style" is not specified, the volume type is determined based on the specified aggregates. Specifying a single aggregate, without "constituents_per_aggregate", creates a flexible volume. Specifying multiple aggregates, or a single aggregate with "constituents_per_aggregate", creates a FlexGroup. Specifying a volume "style" creates a volume of that type. For example, if the style is "flexvol" you must specify a single aggregate. If the style is "flexgroup", the system either uses the specified aggregates or automatically provisions aggregates if there are no specified aggregates. The style "flexgroup_constiutent" is not supported when creating a volume. flexvol ‐ flexible volumes and FlexClone volumes flexgroup ‐ FlexGroup volumes flexgroup_constituent ‐ FlexGroup constituents. |
svm |
SVM containing the volume. Required on POST. |
|
tiering |
||
type |
string |
Type of the volume.
rw ‐ read-write volume.
dp ‐ data-protection volume.
ls ‐ load-sharing |
use_mirrored_aggregates |
boolean |
Specifies whether mirrored aggregates are selected when provisioning a FlexGroup without specifying "aggregates.name" or "aggregates.uuid". Only mirrored aggregates are used if this parameter is set to 'true' and only unmirrored aggregates are used if this parameter is set to 'false'. Aggregate level mirroring for a FlexGroup can be changed by moving all of the constituents to the required aggregates. The default value is 'true' for a MetroCluster configuration and is 'false' for a non-MetroCluster configuration. |
uuid |
string |
Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.
|
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"activity_tracking": {
"state": "string",
"unsupported_reason": {
"code": "124518405",
"message": "Volume activity tracking cannot be enabled on volumes that contain LUNs."
}
},
"aggregates": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "aggr1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
],
"analytics": {
"scan_progress": 17,
"state": "string",
"unsupported_reason": {
"code": "111411207",
"message": "File system analytics cannot be enabled on volumes that contain LUNs."
}
},
"anti_ransomware": {
"attack_probability": "string",
"attack_reports": [
{
"_links": {
"suspects": {
"href": "/api/resourcelink"
}
},
"time": "2021-06-01T20:36:41+05:30"
}
],
"dry_run_start_time": "string",
"space": {
"snapshot_count": 0,
"used": 0,
"used_by_logs": 0,
"used_by_snapshots": 0
},
"state": "string",
"suspect_files": [
{
"count": 0,
"entropy": "string",
"format": "string"
}
]
},
"anti_ransomware_state": "string",
"application": {
"name": "string",
"uuid": "1cd8a442-86d1-11e0-ae1d-123478563412"
},
"asynchronous_directory_delete": {
"trash_bin": "string"
},
"autosize": {
"mode": "string"
},
"clone": {
"parent_snapshot": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "this_snapshot",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"parent_svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"parent_volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
},
"split_complete_percent": 0,
"split_estimate": 0
},
"cloud_retrieval_policy": "string",
"comment": "string",
"consistency_group": {
"name": "consistency_group_1",
"uuid": "1cd8a442-86d1-11e0-ae1d-123478563412"
},
"constituents": [
{
"aggregates": {
"name": "string",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
},
"movement": {
"cutover_window": 30,
"destination_aggregate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "aggr1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"percent_complete": 0,
"state": "replicating",
"tiering_policy": "string"
},
"name": "string",
"space": {
"available": 0,
"block_storage_inactive_user_data": 0,
"capacity_tier_footprint": 0,
"footprint": 0,
"local_tier_footprint": 0,
"logical_space": {
"available": 0,
"used_by_afs": 0
},
"metadata": 0,
"over_provisioned": 0,
"performance_tier_footprint": 0,
"snapshot": {
"used": 0
},
"total_footprint": 0,
"used": 0
}
}
],
"create_time": "2018-06-04T19:00:00Z",
"efficiency": {
"application_io_size": "string",
"compaction": "string",
"compression": "string",
"compression_type": "string",
"cross_volume_dedupe": "string",
"dedupe": "string",
"last_op_begin": "string",
"last_op_end": "string",
"last_op_err": "string",
"last_op_size": 0,
"last_op_state": "string",
"op_state": "string",
"path": "string",
"policy": {
"name": "string"
},
"progress": "string",
"scanner": {
"state": "string"
},
"schedule": "string",
"space_savings": {
"compression": 0,
"compression_percent": 0,
"dedupe": 0,
"dedupe_percent": 0,
"dedupe_sharing": 0,
"total": 0,
"total_percent": 0
},
"state": "string",
"storage_efficiency_mode": "string",
"type": "string"
},
"encryption": {
"key_create_time": "2022-01-01T19:00:00Z",
"key_id": "string",
"key_manager_attribute": "CRN=v1:bluemix:public:containers-kubernetes:us-south:a/asdfghjkl1234:asdfghjkl1234:worker:kubernetes-asdfghjkl-worker1",
"state": "string",
"status": {
"code": "string",
"message": "string"
},
"type": "string"
},
"files": {
"used": 0
},
"flash_pool": {
"cache_eligibility": "string",
"cache_retention_priority": "string",
"caching_policy": "string"
},
"flexcache_endpoint_type": "string",
"flexgroup": {
"name": "my_flexgroup",
"uuid": "75c9cfb0-3eb4-11eb-9fb4-005056bb088a"
},
"guarantee": {
"type": "string"
},
"idcs_scanner": {
"mode": "string",
"operation_state": "string",
"status": "string",
"threshold_inactive_time": "string"
},
"language": "string",
"metric": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"cloud": {
"duration": "PT15S",
"iops": {
"read": 200,
"total": 1000,
"write": 100
},
"latency": {
"read": 200,
"total": 1000,
"write": 100
},
"status": "ok",
"timestamp": "2017-01-25T11:20:13Z"
},
"duration": "PT15S",
"flexcache": {
"bandwidth_savings": 4096,
"cache_miss_percent": 20,
"duration": "PT1D",
"status": "ok",
"timestamp": "2017-01-25T11:20:13Z"
},
"iops": {
"read": 200,
"total": 1000,
"write": 100
},
"latency": {
"read": 200,
"total": 1000,
"write": 100
},
"status": "ok",
"throughput": {
"read": 200,
"total": 1000,
"write": 100
},
"timestamp": "2017-01-25T11:20:13Z"
},
"movement": {
"cutover_window": 30,
"destination_aggregate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "aggr1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"percent_complete": 0,
"start_time": "2020-12-07T03:45:12-05:00",
"state": "replicating",
"tiering_policy": "string"
},
"name": "vol_cs_dept",
"nas": {
"export_policy": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"id": 100,
"name": "default"
},
"junction_parent": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "vs1_root",
"uuid": "75c9cfb0-3eb4-11eb-9fb4-005056bb088a"
},
"path": "/user/my_volume",
"security_style": "string",
"unix_permissions": 755
},
"qos": {
"policy": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"max_throughput_iops": 10000,
"max_throughput_mbps": 500,
"min_throughput_iops": 2000,
"min_throughput_mbps": 500,
"name": "performance",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
},
"quota": {
"state": "string"
},
"rebalancing": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"data_moved": 0,
"failure_reason": {
"code": "string",
"message": "string"
},
"imbalance_percent": 0,
"imbalance_size": 0,
"max_constituent_imbalance_percent": 0,
"max_runtime": "string",
"runtime": "string",
"start_time": "string",
"state": "rebalancing",
"stop_time": "string",
"target_used": 0
},
"scheduled_snapshot_naming_scheme": "string",
"snaplock": {
"append_mode_enabled": "",
"autocommit_period": "P30M",
"compliance_clock_time": "2018-06-04T19:00:00Z",
"expiry_time": "Wed Sep 5 11:02:42 GMT 2018",
"is_audit_log": 1,
"litigation_count": 10,
"privileged_delete": "enabled",
"retention": {
"default": "P30Y",
"maximum": "P30Y",
"minimum": "P30Y"
},
"type": "enterprise",
"unspecified_retention_file_count": 10
},
"snapshot_count": 0,
"snapshot_policy": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "default",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"space": {
"auto_adaptive_compression_footprint_data_reduction": 0,
"available": 0,
"block_storage_inactive_user_data": 0,
"block_storage_inactive_user_data_percent": 0,
"capacity_tier_footprint": 0,
"cross_volume_dedupe_metafiles_footprint": 0,
"cross_volume_dedupe_metafiles_temporary_footprint": 0,
"dedupe_metafiles_footprint": 0,
"dedupe_metafiles_temporary_footprint": 0,
"delayed_free_footprint": 0,
"effective_total_footprint": 0,
"file_operation_metadata": 0,
"filesystem_size": 0,
"footprint": 0,
"local_tier_footprint": 0,
"logical_space": {
"available": 0,
"used": 0,
"used_by_afs": 0,
"used_by_snapshots": 0,
"used_percent": 0
},
"metadata": 0,
"over_provisioned": 0,
"overwrite_reserve": 0,
"overwrite_reserve_used": 0,
"percent_used": 0,
"performance_tier_footprint": 0,
"size_available_for_snapshots": 0,
"snapmirror_destination_footprint": 0,
"snapshot": {
"autodelete_trigger": "string",
"reserve_available": 0,
"reserve_size": 0,
"space_used_percent": 0,
"used": 0
},
"snapshot_reserve_unusable": 0,
"snapshot_spill": 0,
"total_footprint": 0,
"used": 0,
"user_data": 0,
"volume_guarantee_footprint": 0
},
"state": "string",
"statistics": {
"cifs_ops_raw": {
"access": {
"count": 1000,
"total_time": 200
},
"audit": {
"count": 1000,
"total_time": 200
},
"create": {
"dir": {
"count": 1000,
"total_time": 200
},
"file": {
"count": 1000,
"total_time": 200
},
"other": {
"count": 1000,
"total_time": 200
},
"symlink": {
"count": 1000,
"total_time": 200
}
},
"getattr": {
"count": 1000,
"total_time": 200
},
"link": {
"count": 1000,
"total_time": 200
},
"lock": {
"count": 1000,
"total_time": 200
},
"lookup": {
"count": 1000,
"total_time": 200
},
"open": {
"count": 1000,
"total_time": 200
},
"read": {
"count": 1000,
"total_time": 200,
"volume_protocol_latency_histogram_counts": [
0,
0,
0,
0,
0,
15,
35,
100,
200,
200,
300,
500,
500,
500,
1000,
1000,
800,
500,
500,
300,
200,
50,
40,
15,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"volume_protocol_latency_histogram_labels": [
"<2us",
"<6us",
"<10us",
"<14us",
"<20us",
"<40us",
"<60us",
"<80us",
"<100us",
"<200us",
"<400us",
"<600us",
"<800us",
"<1ms",
"<2ms",
"<4ms",
"<6ms",
"<8ms",
"<10ms",
"<12ms",
"<14ms",
"<16ms",
"<18ms",
"<20ms",
"<40ms",
"<60ms",
"<80ms",
"<100ms",
"<200ms",
"<400ms",
"<600ms",
"<800ms",
"<1s",
"<2s",
"<4s",
"<6s",
"<8s",
"<10s",
"<20s",
">20s"
],
"volume_protocol_size_histogram_counts": [
2400,
1055,
1100,
700,
500,
300,
200,
100,
100,
50,
50,
75,
25,
0,
0
],
"volume_protocol_size_histogram_labels": [
"< 4KB",
"= 4KB",
"< 8KB",
"= 8KB",
"< 16KB",
"= 16KB",
"< 32KB",
"= 32KB",
"< 64KB",
"= 64KB",
"< 256KB",
"= 256KB",
"< 1024KB",
"= 1024KB",
"> 1024KB"
]
},
"readdir": {
"count": 1000,
"total_time": 200
},
"readlink": {
"count": 1000,
"total_time": 200
},
"rename": {
"count": 1000,
"total_time": 200
},
"setattr": {
"count": 1000,
"total_time": 200
},
"unlink": {
"count": 1000,
"total_time": 200
},
"watch": {
"count": 1000,
"total_time": 200
},
"write": {
"count": 1000,
"total_time": 200,
"volume_protocol_latency_histogram_counts": [
0,
0,
0,
0,
0,
15,
35,
100,
200,
200,
300,
500,
500,
500,
1000,
1000,
800,
500,
500,
300,
200,
50,
40,
15,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"volume_protocol_latency_histogram_labels": [
"<2us",
"<6us",
"<10us",
"<14us",
"<20us",
"<40us",
"<60us",
"<80us",
"<100us",
"<200us",
"<400us",
"<600us",
"<800us",
"<1ms",
"<2ms",
"<4ms",
"<6ms",
"<8ms",
"<10ms",
"<12ms",
"<14ms",
"<16ms",
"<18ms",
"<20ms",
"<40ms",
"<60ms",
"<80ms",
"<100ms",
"<200ms",
"<400ms",
"<600ms",
"<800ms",
"<1s",
"<2s",
"<4s",
"<6s",
"<8s",
"<10s",
"<20s",
">20s"
],
"volume_protocol_size_histogram_counts": [
2400,
1055,
1100,
700,
500,
300,
200,
100,
100,
50,
50,
75,
25,
0,
0
],
"volume_protocol_size_histogram_labels": [
"< 4KB",
"= 4KB",
"< 8KB",
"= 8KB",
"< 16KB",
"= 16KB",
"< 32KB",
"= 32KB",
"< 64KB",
"= 64KB",
"< 256KB",
"= 256KB",
"< 1024KB",
"= 1024KB",
"> 1024KB"
]
}
},
"cloud": {
"iops_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"latency_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"status": "ok",
"timestamp": "2017-01-25T11:20:13Z"
},
"flexcache_raw": {
"cache_miss_blocks": 10,
"client_requested_blocks": 500,
"status": "ok",
"timestamp": "2017-01-25T11:20:13Z"
},
"iops_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"latency_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"nfs_ops_raw": {
"access": {
"count": 1000,
"total_time": 200
},
"audit": {
"count": 1000,
"total_time": 200
},
"create": {
"dir": {
"count": 1000,
"total_time": 200
},
"file": {
"count": 1000,
"total_time": 200
},
"other": {
"count": 1000,
"total_time": 200
},
"symlink": {
"count": 1000,
"total_time": 200
}
},
"getattr": {
"count": 1000,
"total_time": 200
},
"link": {
"count": 1000,
"total_time": 200
},
"lock": {
"count": 1000,
"total_time": 200
},
"lookup": {
"count": 1000,
"total_time": 200
},
"open": {
"count": 1000,
"total_time": 200
},
"read": {
"count": 1000,
"total_time": 200,
"volume_protocol_latency_histogram_counts": [
0,
0,
0,
0,
0,
15,
35,
100,
200,
200,
300,
500,
500,
500,
1000,
1000,
800,
500,
500,
300,
200,
50,
40,
15,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"volume_protocol_latency_histogram_labels": [
"<2us",
"<6us",
"<10us",
"<14us",
"<20us",
"<40us",
"<60us",
"<80us",
"<100us",
"<200us",
"<400us",
"<600us",
"<800us",
"<1ms",
"<2ms",
"<4ms",
"<6ms",
"<8ms",
"<10ms",
"<12ms",
"<14ms",
"<16ms",
"<18ms",
"<20ms",
"<40ms",
"<60ms",
"<80ms",
"<100ms",
"<200ms",
"<400ms",
"<600ms",
"<800ms",
"<1s",
"<2s",
"<4s",
"<6s",
"<8s",
"<10s",
"<20s",
">20s"
],
"volume_protocol_size_histogram_counts": [
2400,
1055,
1100,
700,
500,
300,
200,
100,
100,
50,
50,
75,
25,
0,
0
],
"volume_protocol_size_histogram_labels": [
"< 4KB",
"= 4KB",
"< 8KB",
"= 8KB",
"< 16KB",
"= 16KB",
"< 32KB",
"= 32KB",
"< 64KB",
"= 64KB",
"< 256KB",
"= 256KB",
"< 1024KB",
"= 1024KB",
"> 1024KB"
]
},
"readdir": {
"count": 1000,
"total_time": 200
},
"readlink": {
"count": 1000,
"total_time": 200
},
"rename": {
"count": 1000,
"total_time": 200
},
"setattr": {
"count": 1000,
"total_time": 200
},
"unlink": {
"count": 1000,
"total_time": 200
},
"watch": {
"count": 1000,
"total_time": 200
},
"write": {
"count": 1000,
"total_time": 200,
"volume_protocol_latency_histogram_counts": [
0,
0,
0,
0,
0,
15,
35,
100,
200,
200,
300,
500,
500,
500,
1000,
1000,
800,
500,
500,
300,
200,
50,
40,
15,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"volume_protocol_latency_histogram_labels": [
"<2us",
"<6us",
"<10us",
"<14us",
"<20us",
"<40us",
"<60us",
"<80us",
"<100us",
"<200us",
"<400us",
"<600us",
"<800us",
"<1ms",
"<2ms",
"<4ms",
"<6ms",
"<8ms",
"<10ms",
"<12ms",
"<14ms",
"<16ms",
"<18ms",
"<20ms",
"<40ms",
"<60ms",
"<80ms",
"<100ms",
"<200ms",
"<400ms",
"<600ms",
"<800ms",
"<1s",
"<2s",
"<4s",
"<6s",
"<8s",
"<10s",
"<20s",
">20s"
],
"volume_protocol_size_histogram_counts": [
2400,
1055,
1100,
700,
500,
300,
200,
100,
100,
50,
50,
75,
25,
0,
0
],
"volume_protocol_size_histogram_labels": [
"< 4KB",
"= 4KB",
"< 8KB",
"= 8KB",
"< 16KB",
"= 16KB",
"< 32KB",
"= 32KB",
"< 64KB",
"= 64KB",
"< 256KB",
"= 256KB",
"< 1024KB",
"= 1024KB",
"> 1024KB"
]
}
},
"status": "ok",
"throughput_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"timestamp": "2017-01-25T11:20:13Z"
},
"status": [
"string"
],
"style": "string",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"tiering": {
"object_tags": [
"string"
],
"policy": "string"
},
"type": "string",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
Error
Status: Default, Error
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
self |
unsupported_reason
Name | Type | Description |
---|---|---|
code |
string |
If volume activity tracking is not supported on the volume, this field provides an appropriate error code. |
message |
string |
If volume activity tracking is not supported on the volume, this field provides an error message detailing why this is the case. |
activity_tracking
Name | Type | Description |
---|---|---|
state |
string |
Activity tracking state of the volume. If this value is "on", ONTAP collects top metrics information for the volume in real time. There is a slight impact to I/O performance in order to collect this information. If this value is "off", no activity tracking information is collected or available to view.
|
supported |
boolean |
This field indicates whether or not volume activity tracking is supported on the volume. If volume activity tracking is not supported, the reason why is provided in the "activity_tracking.unsupported_reason" field. |
unsupported_reason |
aggregates
Aggregate
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
unsupported_reason
Name | Type | Description |
---|---|---|
code |
string |
If file system analytics is not supported on the volume, this field provides the error code explaining why. |
message |
string |
If file system analytics is not supported on the volume, this field provides the error message explaining why. |
analytics
Name | Type | Description |
---|---|---|
scan_progress |
integer |
Percentage of files in the volume that the file system analytics initialization scan has processed. Only returned when the state is |
state |
string |
File system analytics state of the volume. If this value is "on", ONTAP collects extra file system analytics information for all directories on the volume. There will be a slight impact to I/O performance to collect this information. If this value is "off", file system analytics information is not collected and not available to be viewed. If this value is "initializing", that means file system analytics was recently turned on, and the initialization scan to gather information all all existing files and directories is currently running. If this value is 'unknown' that means there was an internal error when determining the file system analytics state for the volume.
|
supported |
boolean |
This field indicates whether or not file system analytics is supported on the volume. If file system analytics is not supported, the reason will be specified in the "analytics.unsupported_reason" field. |
unsupported_reason |
_links
Name | Type | Description |
---|---|---|
suspects |
anti_ransomware_attack_report
Name | Type | Description |
---|---|---|
_links |
||
time |
string |
Timestamp at which ransomware attack is observed. |
space
Name | Type | Description |
---|---|---|
snapshot_count |
integer |
Total number of Anti-ransomware backup Snapshot copies. |
used |
integer |
Total space in bytes used by the Anti-ransomware feature. |
used_by_logs |
integer |
Space in bytes used by the Anti-ransomware analytics logs. |
used_by_snapshots |
integer |
Space in bytes used by the Anti-ransomware backup Snapshot copies. |
suspect_files
Name | Type | Description |
---|---|---|
count |
integer |
Total number of |
entropy |
string |
Indicates the entropy level of this file type. |
format |
string |
File formats observed by the Anti-ransomware analytics engine on the volume. |
anti_ransomware
Anti-ransomware related information of the volume.
Name | Type | Description |
---|---|---|
attack_probability |
string |
Probability of a ransomware attack.
|
attack_reports |
||
dry_run_start_time |
string |
Time when Anti-ransomware monitoring |
space |
||
state |
string |
Anti-ransomware state.
|
surge_as_normal |
boolean |
Indicates whether or not to set the surge values as historical values. |
suspect_files |
array[suspect_files] |
application
Name | Type | Description |
---|---|---|
name |
string |
Name of the application to which the volume belongs. Available only when the volume is part of an application. |
uuid |
string |
UUID of the application to which the volume belongs. Available only when the volume is part of an application. |
asynchronous_directory_delete
Configuration for asynchronous directory delete from the client. This is only supported on Flexible volumes and FlexGroup volumes.
Name | Type | Description |
---|---|---|
enabled |
boolean |
Specifies whether asynchronous directory delete from the client is enabled on the volume. |
trash_bin |
string |
Name of the trash bin directory. If no "trash_bin" property is specified when enabling, the default trash bin name, "._ontaptrashbin", is used. |
autosize
Name | Type | Description |
---|---|---|
grow_threshold |
integer |
Used space threshold size, in percentage, for the automatic growth of the volume. When the amount of used space in the volume becomes greater than this threhold, the volume automatically grows unless it has reached the maximum size. The volume grows when 'space.used' is greater than this percent of 'space.size'. The 'grow_threshold' size cannot be less than or equal to the 'shrink_threshold' size.. |
maximum |
integer |
Maximum size in bytes up to which a volume grows automatically. This size cannot be less than the current volume size, or less than or equal to the minimum size of volume. |
minimum |
integer |
Minimum size in bytes up to which the volume shrinks automatically. This size cannot be greater than or equal to the maximum size of volume. |
mode |
string |
Autosize mode for the volume. grow ‐ Volume automatically grows when the amount of used space is above the 'grow_threshold' value. grow_shrink ‐ Volume grows or shrinks in response to the amount of space used. off ‐ Autosizing of the volume is disabled. |
shrink_threshold |
integer |
Used space threshold size, in percentage, for the automatic shrinkage of the volume. When the amount of used space in the volume drops below this threshold, the volume automatically shrinks unless it has reached the minimum size. The volume shrinks when the 'space.used' is less than the 'shrink_threshold' percent of 'space.size'. The 'shrink_threshold' size cannot be greater than or equal to the 'grow_threshold' size. |
snapshot_reference
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
parent_svm
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
parent_volume
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the volume. |
uuid |
string |
Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.
|
clone
Name | Type | Description |
---|---|---|
is_flexclone |
boolean |
Specifies if this volume is a normal FlexVol or FlexClone. This field needs to be set when creating a FlexClone. Valid in POST. |
parent_snapshot |
||
parent_svm |
||
parent_volume |
||
split_complete_percent |
integer |
Percentage of FlexClone blocks split from its parent volume. |
split_estimate |
integer |
Space required by the containing-aggregate to split the FlexClone volume. |
split_initiated |
boolean |
This field is set when split is executed on any FlexClone, that is when the FlexClone volume is split from its parent FlexVol. This field needs to be set for splitting a FlexClone form FlexVol. Valid in PATCH. |
consistency_group
Consistency group the volume is part of.
Name | Type | Description |
---|---|---|
name |
string |
The name of the consistency group to which the volume belongs. Available only when the volume is part of a consistency group. If this volume belongs to a child consistency group, then this will be the UUID of the parent consistency group. |
uuid |
string |
The UUID of the consistency group to which the volume belongs. Available only when the volume is part of a consistency group. If this volume belongs to a child consistency group, then this will be the UUID of the parent consistency group. |
aggregates
Name | Type | Description |
---|---|---|
name |
string |
Name of the aggregate hosting the FlexGroup Constituent. |
uuid |
string |
Unique identifier for the aggregate. |
destination_aggregate
Aggregate
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
movement
Volume movement. All attributes are modify, that is, not writable through POST. Set PATCH state to destination_aggregate to initiate a volume move operation. Volume movement on FlexGroup constituents are not supported.
Name | Type | Description |
---|---|---|
cutover_window |
integer |
Time window in seconds for cutover. The allowed range is between 30 to 300 seconds. |
destination_aggregate |
Aggregate |
|
percent_complete |
integer |
Completion percentage |
state |
string |
State of volume move operation. PATCH the state to "aborted" to abort the move operation. PATCH the state to "cutover" to trigger cutover. PATCH the state to "paused" to pause the volume move operation in progress. PATCH the state to "replicating" to resume the paused volume move operation. PATCH the state to "cutover_wait" to go into cutover manually. When volume move operation is waiting to go into "cutover" state, this is indicated by the "cutover_pending" state. A change of state is only supported if volume movement is in progress. |
tiering_policy |
string |
Tiering policy for FabricPool |
logical_space
Name | Type | Description |
---|---|---|
available |
integer |
The amount of space available in this volume with storage efficiency space considered used, in bytes. |
enforcement |
boolean |
Specifies whether space accounting for operations on the volume is done along with storage efficiency. |
reporting |
boolean |
Specifies whether space reporting on the volume is done along with storage efficiency. |
used_by_afs |
integer |
The virtual space used by AFS alone (includes volume reserves) and along with storage efficiency, in bytes. |
snapshot
Name | Type | Description |
---|---|---|
autodelete_enabled |
boolean |
Specifies whether Snapshot copy autodelete is currently enabled on this volume. |
reserve_percent |
integer |
The space that has been set aside as a reserve for Snapshot copy usage, in percent. |
used |
integer |
The total space used by Snapshot copies in the volume, in bytes. |
space
Name | Type | Description |
---|---|---|
afs_total |
integer |
Total size of AFS, excluding snap-reserve, in bytes. |
available |
integer |
The available space, in bytes. |
available_percent |
integer |
The space available, as a percent. |
block_storage_inactive_user_data |
integer |
The size that is physically used in the block storage of the volume and has a cold temperature. In bytes. This parameter is only supported if the volume is in an aggregate that is either attached to a cloud store or could be attached to a cloud store. |
capacity_tier_footprint |
integer |
Space used by capacity tier for this volume in the FabricPool aggregate, in bytes. |
footprint |
integer |
Data used for this volume in the aggregate, in bytes. |
local_tier_footprint |
integer |
Space used by the local tier for this volume in the aggregate, in bytes. |
logical_space |
||
metadata |
integer |
Space used by the volume metadata in the aggregate, in bytes. |
over_provisioned |
integer |
The amount of space not available for this volume in the aggregate, in bytes. |
performance_tier_footprint |
integer |
Space used by the performance tier for this volume in the FabricPool aggregate, in bytes. |
size |
integer |
Total provisioned size. The default size is equal to the minimum size of 20MB, in bytes. |
snapshot |
||
total_footprint |
integer |
Data and metadata used for this volume in the aggregate, in bytes. |
used |
integer |
The virtual space used (includes volume reserves) before storage efficiency, in bytes. |
used_by_afs |
integer |
The space used by Active Filesystem, in bytes. |
used_percent |
integer |
The virtual space used (includes volume reserves) before storage efficiency, as a percent. |
constituents
Name | Type | Description |
---|---|---|
aggregates |
||
movement |
Volume movement. All attributes are modify, that is, not writable through POST. Set PATCH state to destination_aggregate to initiate a volume move operation. Volume movement on FlexGroup constituents are not supported. |
|
name |
string |
FlexGroup Constituents name. |
space |
policy
Name | Type | Description |
---|---|---|
name |
string |
Specifies the name of the efficiency policy. |
scanner
Name | Type | Description |
---|---|---|
compression |
boolean |
Start compression if scanning old data. Valid for PATCH and GET. |
dedupe |
boolean |
Start deduplication if scanning old data. Valid for PATCH and GET. |
scan_old_data |
boolean |
Indicates whether or not to scan old data. Valid for PATCH and GET. |
state |
string |
State of the volume efficiency scanner. Valid for PATCH and GET. Valid options for PATCH are "idle" and "active". |
space_savings
Name | Type | Description |
---|---|---|
compression |
integer |
Total disk space that is saved by compressing blocks on the referenced file system, in bytes. |
compression_percent |
integer |
Percentage of total disk space that is saved by compressing blocks on the referenced file system. |
dedupe |
integer |
Total disk space that is saved by deduplication and file cloning, in bytes. |
dedupe_percent |
integer |
Percentage of total disk space that is saved by deduplication and file cloning. |
dedupe_sharing |
integer |
Total disk space that is shared due to deduplication and file cloning. |
total |
integer |
Total disk space saved in the volume due to deduplication, compression and file cloning, in bytes. |
total_percent |
integer |
Percentage of total disk space saved in the volume due to deduplication, compression and file cloning. |
efficiency
Name | Type | Description | ||
---|---|---|---|---|
application_io_size |
string |
Block size to use by compression. |
||
compaction |
string |
The system can be enabled/disabled compaction. inline ‐ Data will be compacted first and written to the volume. none ‐ None mixed ‐ Read only field for FlexGroups, where some of the constituent volumes are compaction enabled and some are disabled. |
||
compression |
string |
The system can be enabled/disabled compression. inline ‐ Data will be compressed first and written to the volume. background ‐ Data will be written to the volume and compressed later. both ‐ Inline compression compresses the data and write to the volume, background compression compresses only the blocks on which inline compression is not run. none ‐ None mixed ‐ Read only field for FlexGroups, where some of the constituent volumes are compression enabled and some are disabled.
|
||
compression_type |
string |
Compression type to use by compression. Valid for PATCH and GET. |
||
cross_volume_dedupe |
string |
The system can be enabled/disabled cross volume dedupe. it can be enabled only when dedupe is enabled. inline ‐ Data will be cross volume deduped first and written to the volume. background ‐ Data will be written to the volume and cross volume deduped later. both ‐ Inline cross volume dedupe dedupes the data and write to the volume, background cross volume dedupe dedupes only the blocks on which inline dedupe is not run. none ‐ None mixed ‐ Read only field for FlexGroups, where some of the constituent volumes are cross volume dedupe enabled and some are disabled. |
||
dedupe |
string |
The system can be enabled/disabled dedupe. inline ‐ Data will be deduped first and written to the volume. background ‐ Data will be written to the volume and deduped later. both ‐ Inline dedupe dedupes the data and write to the volume, background dedupe dedupes only the blocks on which inline dedupe is not run. none ‐ None mixed ‐ Read only field for FlexGroups, where some of the constituent volumes are dedupe enabled and some are disabled. |
||
has_savings |
boolean |
When true, indicates that the volume contains shared(deduplication, file clones) or compressed data. |
||
last_op_begin |
string |
Last sis operation begin timestamp. |
||
last_op_end |
string |
Last sis operation end timestamp. |
||
last_op_err |
string |
Last sis operation error text. |
||
last_op_size |
integer |
Last sis operation size. |
||
last_op_state |
string |
Last sis operation state. |
||
logging_enabled |
boolean |
When true, indicates that space savings for any newly-written data are being logged. |
||
op_state |
string |
Sis status of the volume. |
||
path |
string |
Absolute volume path of the volume. |
||
policy |
||||
progress |
string |
Sis progress of the volume. |
||
scanner |
||||
schedule |
string |
Schedule associated with volume. |
||
space_savings |
||||
state |
string |
Storage efficiency state of the volume. Currently, this field supports POST/PATCH only for RW (Read-Write) volumes on FSx for ONTAP and Cloud Volumes ONTAP. disabled ‐ All storage efficiency features are disabled. mixed ‐ Read-only field for FlexGroup volumes, storage efficiency is enabled on certain constituents and disabled on others. On FSx for ONTAP and Cloud Volumes ONTAP ‐ enabled ‐ All supported storage efficiency features for the volume are enabled. custom ‐ Read-only field currently only supported for the FSx for ONTAP and Cloud Volumes ONTAP, user-defined storage efficiency features are enabled. For other platforms ‐ enabled ‐ At least one storage efficiency feature for the volume is enabled.
|
||
storage_efficiency_mode |
string |
Storage efficiency mode used by volume. This parameter is supported only on AFF platform. |
||
type |
string |
Sis Type of the volume. |
status
Name | Type | Description |
---|---|---|
code |
string |
Encryption progress message code. |
message |
string |
Encryption progress message. |
encryption
Name | Type | Description |
---|---|---|
enabled |
boolean |
Creates an encrypted or an unencrypted volume. For POST, when set to 'true', a new key is generated and used to encrypt the given volume. In that case, the underlying SVM must be configured with the key manager. When set to 'false', the volume created will be unencrypted. For PATCH, when set to 'true', it encrypts an unencrypted volume. Specifying the parameter as 'false' in a PATCH operation for an encrypted volume is only supported when moving the volume to another aggregate. |
key_create_time |
string |
Encryption key creation time of the volume. |
key_id |
string |
The key ID used for creating encrypted volume. A new key-id is generated for creating an encrypted volume. This key-id is associated with the generated key. |
key_manager_attribute |
string |
Specifies an additional key manager attribute that is an identifier-value pair, separated by '='. For example, CRN=unique-value. This parameter is required when using the POST method and an IBM Key Lore key manager is configured on the SVM. |
rekey |
boolean |
If set to 'true', re-encrypts the volume with a new key. Valid in PATCH. |
state |
string |
Volume encryption state. encrypted ‐ The volume is completely encrypted. encrypting ‐ Encryption operation is in progress. partial ‐ Some constituents are encrypted and some are not. Applicable only for FlexGroup volume. rekeying. Encryption of volume with a new key is in progress. unencrypted ‐ The volume is a plain-text one. |
status |
||
type |
string |
Volume encryption type. none ‐ The volume is a plain-text one. volume ‐ The volume is encrypted with NVE (NetApp Volume Encryption). aggregate ‐ The volume is encrypted with NAE (NetApp Aggregate Encryption). |
error_state
Name | Type | Description |
---|---|---|
has_bad_blocks |
boolean |
Indicates whether the volume has any corrupt data blocks. If the damaged data block is accessed, an IO error, such as EIO for NFS or STATUS_FILE_CORRUPT for CIFS, is returned. |
is_inconsistent |
boolean |
Indicates whether the file system has any inconsistencies. true ‐ File system is inconsistent. false ‐ File system in not inconsistent. |
files
Name | Type | Description |
---|---|---|
maximum |
integer |
The maximum number of files (inodes) for user-visible data allowed on the volume. This value can be increased or decreased. Increasing the maximum number of files does not immediately cause additional disk space to be used to track files. Instead, as more files are created on the volume, the system dynamically increases the number of disk blocks that are used to track files. The space assigned to track files is never freed, and this value cannot be decreased below the current number of files that can be tracked within the assigned space for the volume. Valid in PATCH. |
used |
integer |
Number of files (inodes) used for user-visible data permitted on the volume. This field is valid only when the volume is online. |
flash_pool
Name | Type | Description |
---|---|---|
cache_eligibility |
string |
If this parameter is specified, the command displays information only about the volume or volumes with the specified Flash Pool caching attributes. |
cache_retention_priority |
string |
If this parameter is specified, the command displays the volumes that match the specified cache retention priority policy. A cache retention priority defines how long the blocks of a volume will be cached in the Flash Pool once they become cold. |
caching_policy |
string |
This optionally specifies the caching policy to apply to the volume. A caching policy defines how the system caches a volume's data in Flash Cache modules. If a caching policy is not assigned to a volume, the system uses the caching policy that is assigned to the containing SVM. If a caching policy is not assigned to the containing SVM, the system uses the default cluster-wide policy. |
flexgroup
Name | Type | Description |
---|---|---|
name |
string |
Name of the FlexGroup volume that the constituent is part of. |
uuid |
string |
Unique identifier for the FlexGroup volume that the constituent is part of. |
guarantee
Name | Type | Description |
---|---|---|
honored |
boolean |
Is the space guarantee of this volume honored in the aggregate? |