Create a volume on an SVM and storage aggregates

08/29/2024 Contributors

PDFs

POST /storage/volumes

Introduced In: 9.6

Creates a volume on a specified SVM and storage aggregates.

Required properties

svm.uuid or svm.name - Existing SVM in which to create the volume.
name - Name of the volume.
aggregates.name or aggregates.uuid - Existing aggregates in which to create the volume.

Default property values

state - online
size - 20MB
style - flexvol
type - rw
encryption.enabled - false
snapshot_policy.name - default
guarantee.type - volume
anti_ransomware.state - default

volume create
volume clone create

Parameters

Name	Type	In	Required	Description
return_timeout	integer	query	False	The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202. Default value: 1 Max value: 120 Min value: 0
return_records	boolean	query	False	The default is false. If set to true, the records are returned. Default value:

Name

Type

Required

Description

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

Default value: 1
Max value: 120
Min value: 0

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

Default value:

Request Body

Name Type Description

Name	Type	Description
_links	_links
_tags	array[string]	Tags are an optional way to track the uses of a resource. Tag values must be formatted as key:value strings.
access_time_enabled	boolean	Indicates whether or not access time updates are enabled on the volume.
activity_tracking	activity_tracking
aggregates	array[aggregates]	Aggregate hosting the volume. Required on POST.
aggressive_readahead_mode	string	Specifies the aggressive readahead mode enabled on the volume. When set to "file_prefetch", on a file read, the system aggressively issues readaheads for all of the blocks in the file and retains those blocks in a cache for a finite period of time. This feature is only available on FabricPool volumes on FSx for ONTAP and Cloud Volumes ONTAP. Default value: 1 enum: ["none", "file_prefetch"] Introduced in: 9.13 x-nullable: true
analytics	analytics
anti_ransomware	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	application
asynchronous_directory_delete	asynchronous_directory_delete	Configuration for asynchronous directory delete from the client. This is only supported on Flexible volumes and FlexGroup volumes.
autosize	autosize
clone	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.
cloud_write_enabled	boolean	Indicates whether or not cloud writes are enabled on the volume. NFS writes to this volume are sent to the cloud directly instead of the local performance tier. This feature is only available on volumes in FabricPools on FSx or Cloud Volumes ONTAP. Introduced in: 9.13 x-ntap-readModify: true x-nullable: true
comment	string	A comment for the volume. Valid in POST or PATCH.
consistency_group	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=" as query parameters.
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, unless 'optimize_aggregates' is specified as 'true'.
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	efficiency
encryption	encryption
error_state	error_state
files	files
flash_pool	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	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. Introduced in: 9.12 x-nullable: true
guarantee	guarantee
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	metric	Performance numbers, such as IOPS, latency and throughput.
movement	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 Master 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	nas
optimize_aggregates	boolean	Specifies whether to create the constituents of the FlexGroup volume on the aggegates specified in the order they are specified, or whether the system should optimize the ordering of the aggregates. If this value is 'true', the system optimizes the ordering of the aggregates specified. If this value is false, the order of the aggregates is unchanged. The default value is 'false'.
qos	qos	QoS information
queue_for_encryption	boolean	Specifies whether the volume is queued for encryption.
quota	quota	Quotas track the space or file usage of a user, group, or qtree in a FlexVol or a FlexGroup volume.
rebalancing	rebalancing	Configuration and runtime properties involving non-disruptive volume capacity rebalancing for a FlexGroup volume.
scheduled_snapshot_naming_scheme	string	Naming Scheme for automatic Snapshot copies: create_time - Automatic Snapshot copies are saved as per the start of their current date and time. ordinal - Latest automatic snapshot copy is saved as .0 and subsequent copies will follow the create_time naming convention.
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	snaplock
snapmirror	snapmirror	Specifies attributes for SnapMirror protection.
snapshot_count	integer	Number of Snapshot copies in the volume.
snapshot_directory_access_enabled	boolean	This field, if true, enables the visible ".snapshot" directory from the client. The ".snapshot" directory will be available in every directory on the volume.
snapshot_locking_enabled	boolean	Specifies whether or not snapshot copy locking is enabled on the volume.
snapshot_policy	snapshot_policy	This is a reference to the Snapshot copy policy.
space	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	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 or license. 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 volume. When the UDO License is installed, and no aggregates are specified, the system automatically provisions a FlexGroup volume on system selected aggregates. 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	SVM containing the volume. Required on POST.
tiering	tiering
type	string	Type of the volume. rw ‐ read-write volume. dp ‐ data-protection volume. ls ‐ load-sharing `dp` volume. Valid in GET.
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: 028baa66-41bd-11e9-81d5-00a0986138f7 readOnly: 1 Introduced in: 9.6 x-nullable: true

_links

_tags

array[string]

Tags are an optional way to track the uses of a resource. Tag values must be formatted as key:value strings.

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.

aggressive_readahead_mode

string

Specifies the aggressive readahead mode enabled on the volume. When set to "file_prefetch", on a file read, the system aggressively issues readaheads for all of the blocks in the file and retains those blocks in a cache for a finite period of time. This feature is only available on FabricPool volumes on FSx for ONTAP and Cloud Volumes ONTAP.

Default value: 1
enum: ["none", "file_prefetch"]
Introduced in: 9.13
x-nullable: true

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.

cloud_write_enabled

boolean

Indicates whether or not cloud writes are enabled on the volume. NFS writes to this volume are sent to the cloud directly instead of the local performance tier. This feature is only available on volumes in FabricPools on FSx or Cloud Volumes ONTAP.

Introduced in: 9.13
x-ntap-readModify: true
x-nullable: true

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=" as query parameters.

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, unless 'optimize_aggregates' is specified as 'true'.

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.

Introduced in: 9.12
x-nullable: true

guarantee

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 Master 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

optimize_aggregates

boolean

Specifies whether to create the constituents of the FlexGroup volume on the aggegates specified in the order they are specified, or whether the system should optimize the ordering of the aggregates. If this value is 'true', the system optimizes the ordering of the aggregates specified. If this value is false, the order of the aggregates is unchanged. The default value is 'false'.

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

Configuration and runtime properties involving non-disruptive volume capacity rebalancing for a FlexGroup volume.

scheduled_snapshot_naming_scheme

string

Naming Scheme for automatic Snapshot copies:

create_time - Automatic Snapshot copies are saved as per the start of their current date and time.
ordinal - Latest automatic snapshot copy is saved as .0 and subsequent copies will follow the create_time naming convention.

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_directory_access_enabled

boolean

This field, if true, enables the visible ".snapshot" directory from the client. The ".snapshot" directory will be available in every directory on the volume.

snapshot_locking_enabled

boolean

Specifies whether or not snapshot copy locking is enabled on 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 or license. 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 volume. When the UDO License is installed, and no aggregates are specified, the system automatically provisions a FlexGroup volume on system selected aggregates. 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 dp volume. Valid in GET.

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: 028baa66-41bd-11e9-81d5-00a0986138f7
readOnly: 1
Introduced in: 9.6
x-nullable: true

Example request

{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "_tags": [
    "team:csi",
    "environment:test"
  ],
  "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"
    }
  ],
  "aggressive_readahead_mode": "string",
  "analytics": {
    "initialization": {
      "state": "string"
    },
    "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-01 11:06:41 -0400"
      }
    ],
    "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": {
    "inherited_physical_used": 0,
    "inherited_savings": 0,
    "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-04 15:00:00 -0400",
  "efficiency": {
    "application_io_size": "string",
    "auto_state": "string",
    "compaction": "string",
    "compression": "string",
    "compression_type": "string",
    "cross_volume_dedupe": "string",
    "dedupe": "string",
    "idcs_scanner": {
      "mode": "string",
      "operation_state": "string",
      "status": "string",
      "threshold_inactive_time": "P14D"
    },
    "last_op_begin": "string",
    "last_op_end": "string",
    "last_op_err": "string",
    "last_op_size": 0,
    "last_op_state": "string",
    "op_state": "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",
    "volume_path": "string"
  },
  "encryption": {
    "key_create_time": "2022-01-01 14:00:00 -0500",
    "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"
  },
  "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-25 06:20:13 -0500"
    },
    "duration": "PT15S",
    "flexcache": {
      "bandwidth_savings": 4096,
      "cache_miss_percent": 20,
      "duration": "PT1D",
      "status": "ok",
      "timestamp": "2017-01-25 06:20:13 -0500"
    },
    "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-25 06:20:13 -0500"
  },
  "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-07 03:45:12 -0500",
    "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": 493
  },
  "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,
    "engine": {
      "movement": {
        "file_moves_started": 0,
        "last_error": {
          "code": 0,
          "destination": 0,
          "file_id": 0,
          "time": "2018-06-04 15:00:00 -0400"
        },
        "most_recent_start_time": "2018-06-04 15:00:00 -0400"
      },
      "scanner": {
        "blocks_scanned": 0,
        "blocks_skipped": {
          "efficiency_blocks": 0,
          "efficiency_percent": 0,
          "fast_truncate": 0,
          "footprint_invalid": 0,
          "in_snapshot": 0,
          "incompatible": 0,
          "metadata": 0,
          "on_demand_destination": 0,
          "other": 0,
          "remote_cache": 0,
          "too_large": 0,
          "too_small": 0,
          "write_fenced": 0
        },
        "files_scanned": 0,
        "files_skipped": {
          "efficiency_blocks": 0,
          "efficiency_percent": 0,
          "fast_truncate": 0,
          "footprint_invalid": 0,
          "in_snapshot": 0,
          "incompatible": 0,
          "metadata": 0,
          "on_demand_destination": 0,
          "other": 0,
          "remote_cache": 0,
          "too_large": 0,
          "too_small": 0,
          "write_fenced": 0
        }
      }
    },
    "imbalance_percent": 0,
    "imbalance_size": 0,
    "max_constituent_imbalance_percent": 0,
    "max_runtime": "string",
    "notices": [
      {
        "arguments": [
          {
            "code": "string",
            "message": "string"
          }
        ],
        "code": "4",
        "message": "entry doesn't exist",
        "target": "uuid"
      }
    ],
    "runtime": "string",
    "start_time": "string",
    "state": "rebalancing",
    "stop_time": "string",
    "target_used": 0,
    "used_for_imbalance": 0
  },
  "scheduled_snapshot_naming_scheme": "string",
  "snaplock": {
    "append_mode_enabled": "",
    "autocommit_period": "P30M",
    "compliance_clock_time": "2018-06-04 15:00:00 -0400",
    "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,
    "capacity_tier_footprint_data_reduction": 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": {
        "commitment": "string",
        "defer_delete": "string",
        "delete_order": "string",
        "prefix": "string",
        "trigger": "string"
      },
      "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-25 06:20:13 -0500"
    },
    "flexcache_raw": {
      "cache_miss_blocks": 10,
      "client_requested_blocks": 500,
      "status": "ok",
      "timestamp": "2017-01-25 06:20:13 -0500"
    },
    "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-25 06:20:13 -0500"
  },
  "status": [
    "string"
  ],
  "style": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "tiering": {
    "object_tags": [
      "string"
    ],
    "policy": "string",
    "storage_class": "string"
  },
  "type": "string",
  "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}

Response

Status: 202, Accepted

Name	Type	Description
job	job_link

Name

Type

Description

job

job_link

Example response

{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Headers

Name	Description	Type
Location	Useful for tracking the resource location	string

Name

Description

Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code	Description
787140	One of "aggregates.uuid", "aggregates.name", or "style" must be provided.
787141	The specified "aggregates.name" and "aggregates.uuid" refer to different aggregates.
917526	The volume name specified is a duplicate.
917829	Volume autosize grow threshold must be larger than autosize shrink threshold.
917831	Volume minimum autosize must be smaller than the maximum autosize.
917835	Maximum allowed snapshot.reserve_percent value during a volume creation is 90. Use PATCH to set it to a higher value after the volume has been created.
918191	Flexvol tiering min cooling days requires an effective cluster version of ONTAP 9.4 or later.
918194	Tiering min cooling days not supported for SVMDR.
918195	Tiering min cooling days not supported for non data volumes.
918196	Tiering min cooling days not allowed for the provided tiering policy.
918215	FlexGroup tiering min cooling days requires an effective cluster version of ONTAP 9.5 or later.
918233	The target field cannot be specified for this operation.
918236	The specified "parent_volume.uuid" and "parent_volume.name" do not refer to the same volume.
918240	The target style is an invalid volume style.
918241	The target style is an unsupported volume style for volume creation.
918242	When creating a flexible volume, exactly one aggregate must be specified via either "aggregates.name" or "aggregates.uuid".
918243	The specified Snapshot copy UUID is not correct for the specified Snapshot copy name.
918244	Invalid "volume.type" for clone volume.
918246	"volume.clone.parent_volume.name" or "volume.clone.parent_volume.uuid" must be provided.
918247	Specifying a value is not valid for a volume FlexClone creation.
918252	"nas.path" is invalid.
918290	cloud retrieval policy requires an effective cluster version of 9.8 or later.
918291	Invalid volume cloud retrieval policy for the provided tiering policy.
918292	cloud retrieval policy not supported for non data volume.
918521	The volume maximum autosize must be smaller than or equal to the maximum volume size.
918524	Volume minimum autosize must be less than or equal to the current volume size.
2621706	The specified "svm.uuid" and "svm.name" do not refer to the same SVM.
2621707	No SVM was specified. Either "svm.name" or "svm.uuid" must be supplied.
13109258	Cannot enable granular data on volume "name" in Vserver "svm.name". This setting can only be enabled on FlexGroups.
13109260	Failed to enable granular data on the volume.
111411205	File system analytics requires an effective cluster version of 9.8 or later.
111411206	The specified "analytics.state" is invalid.
111411207	File system analytics cannot be enabled on volumes that contain LUNs.
111411207	Volume file system analytics is not supported on volumes that contain LUNs.
111411209	Volume file system analytics is not supported on FlexCache volumes.
111411210	Volume file system analytics is not supported on audit staging volumes.
111411211	Volume file system analytics is not supported on object store server volumes.
111411212	Volume file system analytics is not supported on SnapMirror destination volumes.
111411216	Enabling or disabling volume file system analytics is not supported on individual FlexGroup constituents.
111411217	Volume file system analytics is not supported on SnapLock volumes.
111411230	Volume file system analytics is not supported on volumes that contain NVMe namespaces.
111411241	Volume file system analytics is not supported on All SAN Array clusters.
124518405	Volume activity tracking is not supported on volumes that contain LUNs.
124518407	Volume activity tracking is not supported on FlexCache volumes.
124518408	Volume activity tracking is not supported on audit staging volumes.
124518409	Volume activity tracking is not supported on object store server volumes.
124518410	Volume activity tracking is not supported on SnapMirror destination volumes.
124518411	Enabling or disabling volume activity tracking is not supported on individual FlexGroup constituents.
124518412	Volume activity tracking is not supported on SnapLock volumes.
124518414	Volume activity tracking is not supported on volumes that contain NVMe namespaces.
124518422	Volume activity tracking is not supported on All SAN Array clusters.

Name	Type	Description
error	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

Name

Type

Description

href

string

_links

Name	Type	Description
self	href

Name

Type

Description

self

href

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.

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. enum: ["off", "on"] Introduced in: 9.10 x-nullable: true
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	unsupported_reason

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.

enum: ["off", "on"]
Introduced in: 9.10
x-nullable: true

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	_links
name	string
uuid	string

Name

Type

Description

_links

name

string

uuid

string

initialization

Name	Type	Description
state	string	State of the analytics file system scan.

Name

Type

Description

state

string

State of the analytics file system scan.

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.

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

Name	Type	Description
initialization	initialization
scan_progress	integer	Percentage of files in the volume that the file system analytics initialization scan has processed. Only returned when the state is `initializing`.
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 for all existing files and directories is currently running. If this value is "initialization_paused", this means that the initialization scan is currently paused. If this value is 'unknown', this means that there was an internal error when determining the file system analytics state for the volume. enum: ["unknown", "initializing", "initialization_paused", "off", "on"] Introduced in: 9.8 x-nullable: true
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	unsupported_reason

initialization

scan_progress

integer

Percentage of files in the volume that the file system analytics initialization scan has processed. Only returned when the state is initializing.

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 for all existing files and directories is currently running. If this value is "initialization_paused", this means that the initialization scan is currently paused. If this value is 'unknown', this means that there was an internal error when determining the file system analytics state for the volume.

enum: ["unknown", "initializing", "initialization_paused", "off", "on"]
Introduced in: 9.8
x-nullable: true

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	href

Name

Type

Description

suspects

href

anti_ransomware_attack_report

Name	Type	Description
_links	_links
time	string	Timestamp at which ransomware attack is observed.

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.

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

Name	Type	Description
count	integer	Total number of `suspect_files.format` files observed by the Anti-ransomware analytics engine on the volume.
entropy	string	Indicates the entropy level of this file type.
format	string	File formats observed by the Anti-ransomware analytics engine on the volume.

count

integer

Total number of suspect_files.format files observed by the Anti-ransomware analytics engine on the volume.

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

Name	Type	Description
attack_probability	string	Probability of a ransomware attack. `none` No files are suspected of ransomware activity. `low` A number of files are suspected of ransomware activity. `moderate` A moderate number of files are suspected of ransomware activity. `high` A large number of files are suspected of ransomware activity.
attack_reports	array[anti_ransomware_attack_report]
dry_run_start_time	string	Time when Anti-ransomware monitoring `state` is set to dry-run value for starting evaluation mode.
space	space
state	string	Anti-ransomware state. `disabled` Anti-ransomware monitoring is disabled on the volume. This is the default state in a POST operation. `disable_in_progress` Anti-ransomware monitoring is being disabled and a cleanup operation is in effect. Valid in GET operation. `dry_run` Anti-ransomware monitoring is enabled in the evaluation mode. `enabled` Anti-ransomware monitoring is active on the volume. `paused` Anti-ransomware monitoring is paused on the volume. `enable_paused` Anti-ransomware monitoring is paused on the volume from its earlier enabled state. Valid in GET operation. `dry_run_paused` Anti-ransomware monitoring is paused on the volume from its earlier dry_run state. Valid in GET operation. 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.
surge_as_normal	boolean	Indicates whether or not to set the surge values as historical values.
suspect_files	array[suspect_files]

attack_probability

string

Probability of a ransomware attack. none No files are suspected of ransomware activity. low A number of files are suspected of ransomware activity. moderate A moderate number of files are suspected of ransomware activity. high A large number of files are suspected of ransomware activity.

attack_reports

array[anti_ransomware_attack_report]

dry_run_start_time

string

Time when Anti-ransomware monitoring state is set to dry-run value for starting evaluation mode.

space

state

string

Anti-ransomware state. disabled Anti-ransomware monitoring is disabled on the volume. This is the default state in a POST operation. disable_in_progress Anti-ransomware monitoring is being disabled and a cleanup operation is in effect. Valid in GET operation. dry_run Anti-ransomware monitoring is enabled in the evaluation mode. enabled Anti-ransomware monitoring is active on the volume. paused Anti-ransomware monitoring is paused on the volume. enable_paused Anti-ransomware monitoring is paused on the volume from its earlier enabled state. Valid in GET operation. dry_run_paused Anti-ransomware monitoring is paused on the volume from its earlier dry_run state. Valid in GET operation. 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.

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.

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.

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.

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	_links
name	string
uuid	string

Name

Type

Description

_links

name

string

uuid

string

parent_svm

Name	Type	Description
_links	_links
name	string	The name of the SVM.
uuid	string	The unique identifier of the 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	_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. example: 028baa66-41bd-11e9-81d5-00a0986138f7 Introduced in: 9.6 x-nullable: true

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.

example: 028baa66-41bd-11e9-81d5-00a0986138f7
Introduced in: 9.6
x-nullable: true

clone

Name	Type	Description
inherited_physical_used	integer	Inherited physical used from the clone's base snapshot.
inherited_savings	integer	Inherited savings from the clone's base snapshot.
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	snapshot_reference
parent_svm	parent_svm
parent_volume	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.

Name

Type

Description

inherited_physical_used

integer

Inherited physical used from the clone's base snapshot.

inherited_savings

integer

Inherited savings from the clone's base snapshot.

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

snapshot_reference

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.

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.

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	_links
name	string
uuid	string

Name

Type

Description

_links

name

string

uuid

string

movement

Name	Type	Description
cutover_window	integer	Time window in seconds for cutover. The allowed range is between 30 to 300 seconds.
destination_aggregate	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

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.

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.

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.
large_size_enabled	boolean	Specifies whether the support for large volumes and large files is enabled on the volume.
local_tier_footprint	integer	Space used by the local tier for this volume in the aggregate, in bytes.
logical_space	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	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.

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.

large_size_enabled

boolean

Specifies whether the support for large volumes and large files is enabled on the volume.

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	aggregates
movement	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	space

Name

Type

Description

aggregates

movement

name

string

FlexGroup Constituents name.

space

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, except for 'operation_state' which is valid for PATCH and GET, and is used to start/stop the scanner.

Name	Type	Description
enabled	boolean	Specifies the administrative state of the inactive data compression scanner.
inactive_days	integer	Data blocks older than, or equal to, 'inactive_days' are picked up by the inactive data compression scanner. Valid for PATCH only. Only applicable when 'operation_state' set to 'active'.
mode	string	Specifies the mode of inactive data compression scanner. Valid for PATCH and GET.
operation_state	string	Specifies the operational state of the inactive data compression scanner. VALID for PATCH and GET. Valid options for PATCH are "idle" and "active".
status	string	Status of last inactive data compression scan on the volume.
threshold_inactive_time	string	Time interval after which inactive data compression is automatically triggered. The value is in days and is represented in the ISO-8601 format "PD", for example "P3D" represents a duration of 3 days.

Name

Type

Description

enabled

boolean

Specifies the administrative state of the inactive data compression scanner.

inactive_days

integer

Data blocks older than, or equal to, 'inactive_days' are picked up by the inactive data compression scanner. Valid for PATCH only. Only applicable when 'operation_state' set to 'active'.

mode

string

Specifies the mode of inactive data compression scanner. Valid for PATCH and GET.

operation_state

string

Specifies the operational state of the inactive data compression scanner. VALID for PATCH and GET. Valid options for PATCH are "idle" and "active".

status

string

Status of last inactive data compression scan on the volume.

threshold_inactive_time

string

Time interval after which inactive data compression is automatically triggered. The value is in days and is represented in the ISO-8601 format "PD", for example "P3D" represents a duration of 3 days.

policy

Name	Type	Description
name	string	Specifies the name of the efficiency 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. This option is not supported for FSX/CVO platforms.
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".

Name

Type

Description

compression

boolean

Start compression if scanning old data. Valid for PATCH and GET. This option is not supported for FSX/CVO platforms.

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.

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.

auto_state

string

Automatic deduplication schedule volume state. auto ‐ Volumes with auto_state set to auto start post-process deduplication automatically. deprioritized ‐ Volumes with auto_state set to deprioritized do not start post-process deduplication automatically.

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.

that On volumes with container compression enabled, background compression refers to inactive data compression scan enabled on the volume.

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.

idcs_scanner

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.

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.

enum: ["disabled", "enabled", "mixed", "custom"]
Introduced in: 9.9
x-nullable: true

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.

volume_path

string

Absolute volume path of the volume.

status

Name	Type	Description
code	string	Encryption progress message code.
message	string	Encryption progress message.

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	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).

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.

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.

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.

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.

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?
type	string	The type of space guarantee of this volume in the aggregate.

Name

Type

Description

honored

boolean

Is the space guarantee of this volume honored in the aggregate?

type

string

The type of space guarantee of this volume in the aggregate.

iops

The rate of I/O operations observed at the storage object.

Name	Type	Description
other	integer	Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.
read	integer	Performance metric for read I/O operations.
total	integer	Performance metric aggregated over all types of I/O operations.
write	integer	Peformance metric for write I/O operations.

Name

Type

Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency

The round trip latency in microseconds observed at the storage object.

Name	Type	Description
other	integer	Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.
read	integer	Performance metric for read I/O operations.
total	integer	Performance metric aggregated over all types of I/O operations.
write	integer	Peformance metric for write I/O operations.

Name

Type

Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

cloud

Performance numbers (IOPS and latency) for cloud store. These numbers are relevant only for volumes hosted on FabricPools.

Name	Type	Description
duration	string	The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:
iops	iops	The rate of I/O operations observed at the storage object.
latency	latency	The round trip latency in microseconds observed at the storage object.
status	string	Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.
timestamp	string	The timestamp of the performance data.

Name

Type

Description

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

iops

The rate of I/O operations observed at the storage object.

latency

The round trip latency in microseconds observed at the storage object.

status

string

Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

timestamp

string

The timestamp of the performance data.

flexcache

Performance number for FlexCache used to measure cache effectiveness.

Name

Type

Description

bandwidth_savings

integer

Bandwidth savings denoting the amount of data served locally by the cache, in bytes.

cache_miss_percent

integer

Cache miss percentage.

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

status

string

timestamp

string

The timestamp of the performance data.

throughput

The rate of throughput bytes per second observed at the storage object.

Name

Type

Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

metric

Performance numbers, such as IOPS, latency and throughput.

Name

Type

Description

_links

cloud

Performance numbers (IOPS and latency) for cloud store. These numbers are relevant only for volumes hosted on FabricPools.

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

flexcache

Performance number for FlexCache used to measure cache effectiveness.

iops

The rate of I/O operations observed at the storage object.

latency

The round trip latency in microseconds observed at the storage object.

status

string

throughput

The rate of throughput bytes per second observed at the storage object.

timestamp

string

The timestamp of the performance data.

movement

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

start_time

string

Start time of volume move.

state

string

tiering_policy

string

Tiering policy for FabricPool

export_policy

Export Policy

Name

Type

Description

_links

integer

name

string

junction_parent

Name

Type

Description

_links

name

string

The name of the parent volume that contains the junction inode of this volume. The junction parent volume must belong to the same SVM that owns this volume.

uuid

string

Unique identifier for the parent volume.

nas

Name

Type

Description

export_policy

Export Policy

gid

integer

The UNIX group ID of the volume. Valid in POST or PATCH.

junction_parent

path

string

The fully-qualified path in the owning SVM's namespace at which the volume is mounted. The path is case insensitive and must be unique within a SVM's namespace. Path must begin with '/' and must not end with '/'. Only one volume can be mounted at any given junction path. An empty path in POST creates an unmounted volume. An empty path in PATCH deactivates and unmounts the volume. Taking a volume offline or restricted state removes its junction path. This attribute is reported in GET only when the volume is mounted.

security_style

string

Security style associated with the volume. Valid in POST or PATCH. mixed ‐ Mixed-style security ntfs ‐ NTFS/WIndows-style security unified ‐ Unified-style security, unified UNIX, NFS and CIFS permissions unix ‐ Unix-style security.

uid

integer

The UNIX user ID of the volume. Valid in POST or PATCH.

unix_permissions

integer

UNIX permissions to be viewed as an octal number. It consists of 4 digits derived by adding up bits 4 (read), 2 (write) and 1 (execute). First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file; the third selects permissions for other users in the same group; the fourth for other users not in the group. Valid in POST or PATCH. For security style "mixed" or "unix", the default setting is 0755 in octal (493 in decimal) and for security style "ntfs", the default setting is 0000. In cases where only owner, group and other permissions are given (as in 755, representing the second, third and fourth dight), first digit is assumed to be zero.

policy

Name

Type

Description

_links

max_throughput_iops

integer

Specifies the maximum throughput in IOPS, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH.

max_throughput_mbps

integer

Specifies the maximum throughput in Megabytes per sec, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH.

min_throughput_iops

integer

Specifies the minimum throughput in IOPS, 0 means none. Setting "min_throughput" is supported on AFF platforms only, unless FabricPool tiering policies are set. This is mutually exclusive with name and UUID during POST and PATCH.

min_throughput_mbps

integer

Specifies the minimum throughput in Megabytes per sec, 0 means none. This is mutually exclusive with name and UUID during POST and PATCH.

name

string

The QoS policy group name. This is mutually exclusive with UUID and other QoS attributes during POST and PATCH.

uuid

string

The QoS policy group UUID. This is mutually exclusive with name and other QoS attributes during POST and PATCH.

qos

QoS information

Name

Type

Description

policy

quota

Quotas track the space or file usage of a user, group, or qtree in a FlexVol or a FlexGroup volume.

Name

Type

Description

enabled

boolean

This option is used to enable or disable the quota for the volume. This option is valid only in PATCH. Quotas are enabled for FlexVols or FlexGroup volumes when the quota state is "on". Quotas are disabled for FlexVols or FlexGroup volumes when the quota state is "off".

state

string

Quota state of the volume

last_error

Error information for the last failed file move on the constituent.

Name

Type

Description

code

integer

Error code of the last file move error on the constiutent.

destination

integer

DSID of the destination constituent of the last file move error on the constiutent.

file_id

integer

File ID of the last file move error on the constiutent.

time

string

Time of the last file move error on the constiutent.

movement

Properties on this constituent related to file movement.

Name

Type

Description

file_moves_started

integer

Number of file moves started on this constituent.

last_error

Error information for the last failed file move on the constituent.

most_recent_start_time

string

Start time of the most recent file move on the constiutent.

blocks_skipped

Number of blocks skipped by the scanner on this constiutent due to various reasons.

Name

Type

Description

efficiency_blocks

integer

Number of blocks skipped by the scanner on this constituent because storage efficiency lost, in blocks, would be too high.

efficiency_percent

integer

Number of blocks skipped by the scanner on this constituent because storage efficiency lost, in percent, would be too high.

fast_truncate

integer

Number of blocks skipped by the scanner on this constituent because fast truncate is currently running on files.

footprint_invalid

integer

Number of blocks skipped by the scanner on this constituent because of files with invalid space footprints.

in_snapshot

integer

Number of blocks skipped by the scanner on this constituent because of files in Snapshot copies.

incompatible

integer

Number of blocks skipped by the scanner on this constituent because of incompatible files.

metadata

integer

Number of blocks skipped by the scanner on this constituent because of metadata files.

on_demand_destination

integer

Number of blocks skipped by the scanner on this constituent because of on demand destination files.

other

integer

Number of blocks skipped by the scanner on this constituent for all other reasons.

remote_cache

integer

Number of blocks skipped by the scanner on this constituent because of remote caches.

too_large

integer

Number of blocks skipped by the scanner on this constituent because of files that are larger than rebalancing.max_file_size.

too_small

integer

Number of blocks skipped by the scanner on this constituent because of files that are smaller than rebalancing.min_file_size.

write_fenced

integer

Number of blocks skipped by the scanner on this constituent because of files fenced for write operations.

files_skipped

Number of files skipped by the scanner on this constiutent due to various reasons.

Name

Type

Description

efficiency_blocks

integer

Number of files skipped by the scanner on this constituent because storage efficiency lost, in blocks, would be too high.

efficiency_percent

integer

Number of files skipped by the scanner on this constituent because storage efficiency lost, in percent, would be too high.

fast_truncate

integer

Number of files skipped by the scanner on this constituent because fast truncate is currently running on the file.

footprint_invalid

integer

Number of files skipped by the scanner on this constituent because their space footprints are invalid.

in_snapshot

integer

Number of files skipped by the scanner on this constituent because they are trapped in Snapshot copies.

incompatible

integer

Number of files skipped by the scanner on this constituent because they are incompatible.

metadata

integer

Number of files skipped by the scanner on this constituent because they metadata files.

on_demand_destination

integer

Number of files skipped by the scanner on this constituent because they are on demand destinations.

other

integer

Number of files skipped by the scanner on this constituent for all other reasons.

remote_cache

integer

Number of files skipped by the scanner on this constituent because they are remote caches.

too_large

integer

Number of files skipped by the scanner on this constituent because they are larger than rebalancing.max_file_size.

too_small

integer

Number of files skipped by the scanner on this constituent because they are smaller than rebalancing.min_file_size.

write_fenced

integer

Number of files skipped by the scanner on this constituent because they are fenced for write operations.

scanner

Properties related to determining which files to move and where to move them to.

Name

Type

Description

blocks_scanned

integer

Number of blocks scanned on this constituent.

blocks_skipped

Number of blocks skipped by the scanner on this constiutent due to various reasons.

files_scanned

integer

Number of files scanned on this constituent.

files_skipped

Number of files skipped by the scanner on this constiutent due to various reasons.

engine

Each constituent has one rebalancing engine that co-ordinates scanning constituents for free space and files to move, as well as moving files between constituents. The engine properties must be explicitly requested, are meant for helping diagnose why the volume rebalancer is making decisions.

Name

Type

Description

movement

Properties on this constituent related to file movement.

scanner

Properties related to determining which files to move and where to move them to.

error_arguments

Name

Type

Description

code

string

Argument code

message

string

Message argument

error

Name

Type

Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.

rebalancing

Configuration and runtime properties involving non-disruptive volume capacity rebalancing for a FlexGroup volume.

Name

Type

Description

_links

data_moved

integer

The amount of data that has been moved in or out of a constituent. A positive value represents data moving into the constituent while a negative value is data moving out of the constituent.

engine

exclude_snapshots

boolean

Specifies whether or not to exclude files that are stuck in Snapshot copies during rebalancing operation. When a new capacity rebalancing operation is started on a FlexGroup volume, it uses the current "exclude_snapshots" value. Once the operation is started, any changes to the "exclude_snapshots" value do not affect the currently running capacity rebalancing operation. Only future capacity rebalancing operations will use the new "exclude_snapshots" value.

imbalance_percent

integer

Represents the percentage the volume is out of balance.

imbalance_size

integer

Represents how much the volume is out of balance, in bytes.

max_constituent_imbalance_percent

integer

Absolute percentage of the constituent that is most out of balance. This value will update every 30 seconds when rebalancing is not active and every 10 seconds when rebalancing is active.

max_file_moves

integer

Specifies the maximum number of concurrent file moves in a volume capacity rebalancing operation on a constituent of the FlexGroup volume. When a new capacity rebalancing operation is started on a FlexGroup volume, it uses the current "max_file_moves" value. Once the operation is started, any changes to the "max_file_moves" value do not affect the currently running capacity rebalancing operation. Only future capacity rebalancing operations will use the new "max_file_moves" value.

max_runtime

string

This optional field specifies the maximum time a capacity rebalancing operation runs for. Once the maximum runtime has passed, the capacity rebalancing operation stops. If it is not set, the default value is 6 hours. This value cannot be updated while a capacity rebalancing operation is running. The maximum runtime can be in years, months, days, hours, and minutes. A period specified for years, months, and days is represented in the ISO-8601 format as "PY", "PM", "PD" respectively, for example "P3D" represents a duration of 3 days. A duration in hours and minutes is represented by "PTH" and "PTM" respectively.

max_threshold

integer

Specifies the maximum imbalance percentage for FlexGroup volume constituents. When a constituent's imbalance percentage is larger than this value, files are moved from the constituent. When a new capacity rebalancing operation is started on a FlexGroup volume, it uses the current "max_threshold" value. Once the operation is started, any changes to the "max_threshold" value do not affect the currently running capacity rebalancing operation. Only future capacity rebalancing operations will use the new "max_threshold" value.

min_file_size

integer

Specifies the minimum file size to consider for a volume capacity rebalancing operation. When a new capacity rebalancing operation is started on a FlexGroup volume, it uses the current "min_file_size" value. Once the operation is started, any changes to the "min_file_size" value do not affect the currently running capacity rebalancing operation. Only future capacity rebalancing operations will use the new "min_file_size" value. The value must be a multiple of 4KB. If it is not set, the default value is 100MB. Setting "min-file-size" to less than the default value leads to more files being moved. Moved files use granular data, which may impact read/write I/O performance.

min_threshold

integer

Specifies the minimum imbalance percentage for FlexGroup volume constituents. When a constituent's imbalance percentage is smaller than this value, files are not moved from the constituent. When a new capacity rebalancing operation is started on a FlexGroup volume, it will use the current "min_threshold" value. Once the operation is started, any changes to the "min_threshold" value do not affect the currently running capacity rebalancing operation. Only future capacity rebalancing operations will use the new "min_threshold" value.

notices

array[error]

Capacity rebalancing notice messages.

runtime

string

Duration the capacity rebalancing operation has been running.

start_time

string

Time when the current capacity rebalancing operation started, or when a future scheduled rebalancing operation begins.

state

string

State of the volume capacity rebalancing operation. PATCH the state to "starting" to trigger the capacity rebalance operation, and include start_time to schedule rebalancing. PATCH the state to "stopping" to stop the capacity rebalance operation, or cancel a scheduled rebalancing operation. PATCH without the state with a valid start_time to modify the start_time of an existing scheduled rebalance operation.

While a FlexGroup volume is rebalancing, every constituent will have a rebalancing engine that can either be scanning the filesystem for space usage and files to move, actively moving files or temporarily doing neither.

If one or more constituents has a state of "rebalancing_source" or "rebalancing_dest", then files are being moved to rebalance the FlexGroup.

If no files are being moved, more information about what the rebalancing engine is doing for each constituent is available using the "rebalancing.engine" property.

The following values apply to FlexGroup volumes. not_running ‐ capacity rebalancing is not running on the volume. starting ‐ used in a PATCH operation to start a capacity rebalancing operation. rebalancing ‐ capacity rebalancing is running on the volume. paused ‐ volume capacity rebalancing is paused on the volume. stopping ‐ used in a PATCH operation to stop a capacity rebalancing operation. unknown ‐ the system was unable to determine the rebalancing state for the volume.

The following values apply to FlexGroup volume constituents. idle ‐ capacity rebalancing is running on the constituent, however, no active scanning or file movement is currently occurring. scanning ‐ the constituent's file system is being scanned to find files to move and determine free space. rebalancing_source ‐ a file is being moved off of the constituent. rebalancing_dest ‐ a file is being moved to the constituent. not_running ‐ capacity rebalancing is not running on the constituent. unknown ‐ the system was unable to determine the rebalancing state for the constituent.

stop_time

string

Time when the capacity rebalancing operation stopped.

target_used

integer

Represents the ideal used size of each constituent. Calculated by dividing the total FlexGroup volume used size by the number of constituents.

used_for_imbalance

integer

Represents the used size of each constituent, as determined by the rebalancing engine. Calculated by subtracting the size used by Snapshot copies, the size of files pending deletion and the size of filesystem metadata from the volume used size.

retention

Name

Type

Description

default

string

Specifies the default retention period that is applied to files while committing them to the WORM state without an associated retention period. The retention value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours, and minutes. A duration specified for years, months, and days is represented in the ISO-8601 format as "PY", "PM", "PD" respectively, for example "P10Y" represents a duration of 10 years. A duration in hours and minutes is represented by "PTH" and "PTM" respectively. The retention string must contain only a single time element that is, either years, months, days, hours, or minutes. A duration which combines different periods is not supported, for example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the duration field also accepts the string "infinite" to set an infinite retention period and the string "unspecified" to set an unspecified retention period.

maximum

string

Specifies the maximum allowed retention period for files committed to the WORM state on the volume. The retention value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours, and minutes. A duration specified for years, months, and days is represented in the ISO-8601 format as "PY", "PM", "PD" respectively, for example "P10Y" represents a duration of 10 years. A duration in hours and minutes is represented by "PTH" and "PTM" respectively. The retention string must contain only a single time element that is, either years, months, days, hours, or minutes. A duration which combines different periods is not supported, for example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the duration field also accepts the string "infinite" to set an infinite retention period.

minimum

string

Specifies the minimum allowed retention period for files committed to the WORM state on the volume. The retention value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours, and minutes. A duration specified for years, month,s and days is represented in the ISO-8601 format as "PY", "PM", "PD" respectively, for example "P10Y" represents a duration of 10 years. A duration in hours and minutes is represented by "PTH" and "PTM" respectively. The retention string must contain only a single time element that is, either years, months, days, hours, or minutes. A duration which combines different periods is not supported, for example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the duration field also accepts the string "infinite" to set an infinite retention period.

snaplock

Name

Type

Description

append_mode_enabled

boolean

Specifies if the volume append mode is enabled or disabled. When it is enabled, all the files created with write permissions on the volume are, by default, WORM appendable files. The user can append the data to a WORM appendable file but cannot modify the existing contents of the file nor delete the file until it expires.

autocommit_period

string

Specifies the autocommit period for SnapLock volume. All files which are not modified for a period greater than the autocommit period of the volume are committed to the WORM state. The autocommit period value represents a duration and must be specified in the ISO-8601 duration format. The autocommit period can be in years, months, days, hours, and minutes. A period specified for years, months, and days is represented in the ISO-8601 format as "PY", "PM", "PD" respectively, for example "P10Y" represents a duration of 10 years. A duration in hours and minutes is represented by "PTH" and "PTM" respectively. The period string must contain only a single time element that is, either years, months, days, hours, or minutes. A duration which combines different periods is not supported, for example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the autocommit field also accepts the string "none".

compliance_clock_time

string

This is the volume compliance clock time which is used to manage the SnapLock objects in the volume.

expiry_time

string

Expiry time of the volume.

is_audit_log

boolean

Indicates if this volume has been configured as SnapLock audit log volume for the SVM .

litigation_count

integer

Litigation count indicates the number of active legal-holds on the volume.

privileged_delete

string

Specifies the privileged-delete attribute of a SnapLock volume. On a SnapLock Enterprise (SLE) volume, a designated privileged user can selectively delete files irrespective of the retention time of the file. SLE volumes can have privileged delete as disabled, enabled or permanently_disabled and for SnapLock Compliance (SLC) volumes it is always permanently_disabled.

retention

type

string

The SnapLock type of the volume. compliance ‐ A SnapLock Compliance(SLC) volume provides the highest level of WORM protection and an administrator cannot destroy a SLC volume if it contains unexpired WORM files. enterprise ‐ An administrator can delete a SnapLock Enterprise(SLE) volume. non_snaplock ‐ Indicates the volume is non-snaplock.

unspecified_retention_file_count

integer

Indicates the number of files with an unspecified retention time in the volume.

destinations

Name

Type

Description

is_cloud

boolean

Specifies whether a volume is a SnapMirror source volume, using SnapMirror to protect its data to a cloud destination.

is_ontap

boolean

Specifies whether a volume is a SnapMirror source volume, using SnapMirror to protect its data to an ONTAP destination.

readOnly: 1
Introduced in: 9.9
x-nullable: true

snapmirror

Specifies attributes for SnapMirror protection.

Name

Type

Description

destinations

is_protected

boolean

Specifies whether a volume is a SnapMirror source volume, using SnapMirror to protect its data.

snapshot_policy

This is a reference to the Snapshot copy policy.

Name

Type

Description

_links

name

string

uuid

string

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

integer

SUM of (physical-used, shared_refs, compression_saved_in_plane0, vbn_zero, future_blk_cnt), in bytes.

used_by_afs

integer

The virtual space used by AFS alone (includes volume reserves) and along with storage efficiency, in bytes.

used_by_snapshots

integer

Size that is logically used across all Snapshot copies in the volume, in bytes.

used_percent

integer

SUM of (physical-used, shared_refs, compression_saved_in_plane0, vbn_zero, future_blk_cnt), as a percentage.

autodelete

Name

Type

Description

commitment

string

By default, Snapshot copy autodelete does not delete Snapshot copies locked by Snapmirror, clones of a volume, a LUN, an NVMe namespace, or a file. Deletion of Snapshot copies locked by these applications is specified using this option. The default value is try.

defer_delete

string

Allows the user to inform Snapshot copy autodelete to defer the deletion of a specified Snapshot copy until the end. The default value is user_created.

delete_order

string

Specifies the order in which Snapshot copy autodelete occurs. Ordering is done using the date and time the Snapshot copy is created. The default value is oldest_first.

enabled

boolean

Specifies whether Snapshot copy autodelete is currently enabled on this volume.

prefix

string

Specifies the prefix of the Snapshot copy which if matched, is deleted last. Used with autodelete_defer_delete when used with a prefix value.

target_free_space

integer

Snapshot copies are deleted, one at a time, until the used volume space reaches the value specified. The default is 20% free space or 80% utilized.

trigger

string

Specifies when the system should trigger an autodelete of Snapshot copies. When set to volume, autodelete is triggered based on volume fullness. When set to snap_reserve, autodelete is triggered based on Snapshot copy reserve fullness. The default value is volume.

snapshot

Name

Type

Description

autodelete

autodelete_enabled

boolean

Specifies whether Snapshot copy autodelete is currently enabled on this volume. This field will no longer be supported in a future release. Use autodelete.enabled instead.

autodelete_trigger

string

reserve_available

integer

Size available for Snapshot copies within the Snapshot copy reserve, in bytes.

reserve_percent

integer

The space that has been set aside as a reserve for Snapshot copy usage, in percent.

reserve_size

integer

Size in the volume that has been set aside as a reserve for Snapshot copy usage, in bytes.

space_used_percent

integer

Percentage of snapshot reserve size that has been used.

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.

auto_adaptive_compression_footprint_data_reduction

integer

Savings achieved due to Auto Adaptive Compression, in bytes.

available

integer

The available space, in bytes.

available_percent

integer

The space available, as a percent.

block_storage_inactive_user_data

integer

block_storage_inactive_user_data_percent

integer

Percentage of size that is physically used in the performance tier of the volume.

capacity_tier_footprint

integer

Space used by capacity tier for this volume in the FabricPool aggregate, in bytes.

capacity_tier_footprint_data_reduction

integer

Savings achieved in the space used by the capacity tier for this volume in the FabricPool aggregate, in bytes.

cross_volume_dedupe_metafiles_footprint

integer

Cross volume deduplication metadata footprint, in bytes.

cross_volume_dedupe_metafiles_temporary_footprint

integer

Cross volume temporary deduplication metadata footprint, in bytes.

dedupe_metafiles_footprint

integer

Deduplication metadata footprint, in bytes.

dedupe_metafiles_temporary_footprint

integer

Temporary deduplication metadata footprint, in bytes.

delayed_free_footprint

integer

Delayed free blocks footprint, in bytes.

effective_total_footprint

integer

Volume footprint after efficiency savings, in bytes.

expected_available

integer

Size that should be available for the volume, irrespective of available size in the aggregate, in bytes.

file_operation_metadata

integer

File operation metadata footprint, in bytes.

filesystem_size

integer

Total usable size of the volume, in bytes.

filesystem_size_fixed

boolean

Specifies whether the file system is to remain of the same size when set to true or to grow when set to false. This option is automatically set to true when a volume becomes SnapMirrored.

footprint

integer

Data used for this volume in the aggregate, in bytes.

fractional_reserve

integer

Used to change the amount of space reserved for overwrites of reserved objects in a volume.

full_threshold_percent

integer

Volume full threshold percentage at which EMS warnings can be sent.

is_used_stale

boolean

Specifies if the virtual space used is stale.

large_size_enabled

boolean

Indicates if the support for large FlexVol volumes and large files is enabled on this volume. When configured to true, FlexVol volume size can reach up to 300TB and single file size can reach 128TB.

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.

nearly_full_threshold_percent

integer

Volume nearly full threshold percentage at which EMS warnings can be sent.

over_provisioned

integer

The amount of space not available for this volume in the aggregate, in bytes.

overwrite_reserve

integer

Reserved space for overwrites, in bytes.

overwrite_reserve_used

integer

Overwrite logical reserve space used, in bytes.

percent_used

integer

Percentage of the volume size that is used.

performance_tier_footprint

integer

Space used by the performance tier for this volume in the FabricPool aggregate, in bytes.

physical_used

integer

Size that is physically used in the volume, in bytes.

physical_used_percent

integer

Size that is physically used in the volume, as a percentage.

size

integer

Total provisioned size. The default size is equal to the minimum size of 20MB, in bytes.

size_available_for_snapshots

integer

Available space for Snapshot copies from snap-reserve, in bytes.

snapmirror_destination_footprint

integer

SnapMirror destination footprint, in bytes.

snapshot

snapshot_reserve_unusable

integer

Snapshot reserve that is not available for Snapshot copy creation, in bytes.

snapshot_spill

integer

Space used by the snapshot copies beyond the snap-reserve, in bytes.

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.

user_data

integer

User data, in bytes.

volume_guarantee_footprint

integer

Space reserved for future writes in the volume, in bytes.

access

Raw count and latency data for access operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

audit

Raw count and latency data for audit operations. These statistics are only applicable for CIFS protocol operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

dir

Raw count and latency data for directory-create operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

file

Raw count and latency data for file-create operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

other

Raw count and latency data for create operations on objects other than files, directories and symlinks.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

symlink

Raw count and latency data for symlink-create operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

create

Raw count and latency data for create operations.

Name

Type

Description

dir

Raw count and latency data for directory-create operations.

file

Raw count and latency data for file-create operations.

other

Raw count and latency data for create operations on objects other than files, directories and symlinks.

symlink

Raw count and latency data for symlink-create operations.

getattr

Raw count and latency data for getattr operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

link

Raw count and latency data for link operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

lock

Raw count and latency data for lock operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

lookup

Raw count and latency data for lookup operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

open

Raw count and latency data for open operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

read

Raw count and latency data for read operations, including histograms categorizing operations by size and latency.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
readOnly: 1
x-ntap-advanced: true
Introduced in: 9.11
x-nullable: true

volume_protocol_latency_histogram_counts

array[integer]

volume_protocol_latency_histogram_labels

array[string]

Labels for the latency histogram, ranging from <2us to >20s.

volume_protocol_size_histogram_counts

array[integer]

volume_protocol_size_histogram_labels

array[string]

Labels for the size histogram, ranging from <4KB to >1024KB.

readdir

Raw count and latency data for readdir operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

readlink

Raw count and latency data for readlink operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

rename

Raw count and latency data for rename operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

setattr

Raw count and latency data for setattr operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

unlink

Raw count and latency data for unlink operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

watch

Raw count and latency data for watch operations. These statistics are only applicable for CIFS protocol operations.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
Introduced in: 9.11
x-nullable: true

write

Raw count and latency data for write operations, including histograms categorizing operations by size and latency.

Name

Type

Description

count

integer

Number of operations of the given type performed on this volume.

total_time

integer

The raw data component latency in microseconds measured within ONTAP for all operations of the given type.

example: 200
readOnly: 1
x-ntap-advanced: true
Introduced in: 9.11
x-nullable: true

volume_protocol_latency_histogram_counts

array[integer]

volume_protocol_latency_histogram_labels

array[string]

Labels for the latency histogram, ranging from <2us to >20s.

volume_protocol_size_histogram_counts

array[integer]

volume_protocol_size_histogram_labels

array[string]

Labels for the size histogram, ranging from <4KB to >1024KB.

cifs_ops_raw

Raw data component performance values for CIFS operations on this volume, including number of operations and raw latency, in microseconds for each operation. The values are cumulative and increase while the volume is online.

Name

Type

Description

access

Raw count and latency data for access operations.

audit

Raw count and latency data for audit operations. These statistics are only applicable for CIFS protocol operations.

create

Raw count and latency data for create operations.

getattr

Raw count and latency data for getattr operations.

link

Raw count and latency data for link operations.

lock

Raw count and latency data for lock operations.

lookup

Raw count and latency data for lookup operations.

open

Raw count and latency data for open operations.

read

Raw count and latency data for read operations, including histograms categorizing operations by size and latency.

readdir

Raw count and latency data for readdir operations.

readlink

Raw count and latency data for readlink operations.

rename

Raw count and latency data for rename operations.

setattr

Raw count and latency data for setattr operations.

unlink

Raw count and latency data for unlink operations.

watch

Raw count and latency data for watch operations. These statistics are only applicable for CIFS protocol operations.

write

Raw count and latency data for write operations, including histograms categorizing operations by size and latency.

iops_raw

The number of I/O operations observed at the storage object. This can be used along with delta time to calculate the rate of I/O operations per unit of time.

Name

Type

Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency_raw

The raw latency in microseconds observed at the storage object. This can be divided by the raw IOPS value to calculate the average latency per I/O operation.

Name

Type

Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

cloud

These are raw performance numbers (IOPS and latency) for the cloud store. These numbers are aggregated across all nodes in the cluster and increase with the uptime of the cluster. These numbers are relevant only for volumes hosted on FabricPools.

Name

Type

Description

iops_raw

The number of I/O operations observed at the storage object. This can be used along with delta time to calculate the rate of I/O operations per unit of time.

latency_raw

The raw latency in microseconds observed at the storage object. This can be divided by the raw IOPS value to calculate the average latency per I/O operation.

status

string

timestamp

string

The timestamp of the performance data.

flexcache_raw

Performance numbers for FlexCache used to measure cache effectiveness.

Name

Type

Description

cache_miss_blocks

integer

Blocks retrieved from origin in case of a cache miss. This can be divided by the raw client_requested_blocks and multiplied by 100 to calculate the cache miss percentage.

client_requested_blocks

integer

Total blocks requested by the client.

status

string

timestamp

string

The timestamp of the performance data.

nfs_ops_raw

Raw data component performance values for NFS operations on this volume, including number of operations and raw latency, in microseconds for each operation. The values are cumulative and increase while the volume is online.

Name

Type

Description

access

Raw count and latency data for access operations.

audit

Raw count and latency data for audit operations. These statistics are only applicable for CIFS protocol operations.

create

Raw count and latency data for create operations.

getattr

Raw count and latency data for getattr operations.

link

Raw count and latency data for link operations.

lock

Raw count and latency data for lock operations.

lookup

Raw count and latency data for lookup operations.

open

Raw count and latency data for open operations.

read

Raw count and latency data for read operations, including histograms categorizing operations by size and latency.

readdir

Raw count and latency data for readdir operations.

readlink

Raw count and latency data for readlink operations.

rename

Raw count and latency data for rename operations.

setattr

Raw count and latency data for setattr operations.

unlink

Raw count and latency data for unlink operations.

watch

Raw count and latency data for watch operations. These statistics are only applicable for CIFS protocol operations.

write

Raw count and latency data for write operations, including histograms categorizing operations by size and latency.

throughput_raw

Throughput bytes observed at the storage object. This can be used along with delta time to calculate the rate of throughput bytes per unit of time.

Name

Type

Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

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.

Name

Type

Description

cifs_ops_raw

cloud

flexcache_raw

Performance numbers for FlexCache used to measure cache effectiveness.

iops_raw

The number of I/O operations observed at the storage object. This can be used along with delta time to calculate the rate of I/O operations per unit of time.

latency_raw

The raw latency in microseconds observed at the storage object. This can be divided by the raw IOPS value to calculate the average latency per I/O operation.

nfs_ops_raw

status

string

throughput_raw

Throughput bytes observed at the storage object. This can be used along with delta time to calculate the rate of throughput bytes per unit of time.

timestamp

string

The timestamp of the performance data.

svm

SVM containing the volume. Required on POST.

Name

Type

Description

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

tiering

Name

Type

Description

min_cooling_days

integer

This parameter specifies the minimum number of days that user data blocks of the volume must be cooled before they can be considered cold and tiered out to the cloud tier. Note that this parameter is only used for tiering purposes and does not affect the reporting of inactive data. The value specified should be greater than the frequency with which applications in the volume shift between different sets of data. This parameter cannot be set when volume tiering policy is either "none" or "all". The default value of this parameter depends on the volume's tiering policy. See the tiering policy section of this documentation for corresponding default values. If the tiering policy on the volume gets changed, then this parameter will be reset to the default value corresponding to the new tiering policy.

object_tags

array[string]

This parameter specifies tags of a volume for objects stored on a FabricPool-enabled aggregate. Each tag is a key,value pair and should be in the format "key=value".

policy

string

Policy that determines whether the user data blocks of a volume in a FabricPool will be tiered to the cloud store when they become cold. FabricPool combines flash (performance tier) with a cloud store into a single aggregate. Temperature of a volume block increases if it is accessed frequently and decreases when it is not. Valid in POST or PATCH. all ‐ This policy allows tiering of both Snapshot copies and active file system user data to the cloud store as soon as possible by ignoring the temperature on the volume blocks. auto ‐ This policy allows tiering of both snapshot and active file system user data to the cloud store none ‐ Volume blocks will not be tiered to the cloud store. snapshot_only ‐ This policy allows tiering of only the volume Snapshot copies not associated with the active file system. The default tiering policy is "snapshot-only" for a FlexVol and "none" for a FlexGroup. The default minimum cooling period for the "snapshot-only" tiering policy is 2 days and for the "auto" tiering policy is 31 days.

storage_class

string

This parameter specifies the storage class that a FabricPool uses. This feature is only available on volumes in a FabricPools on FSx or Cloud Volumes ONTAP for AWS.

Default value: 1
enum: ["default", "S3_standard", "S3_standard_IA", "S3_glacier_IR"]
Introduced in: 9.13
x-ntap-modifyOnly: true
x-nullable: true

supported

boolean

This parameter specifies whether or not FabricPools are selected when provisioning a FlexGroup without specifying "aggregates.name" or "aggregates.uuid". Only FabricPool aggregates are used if this parameter is set to true and only non FabricPool aggregates are used if this parameter is set to false. Tiering support for a FlexGroup can be changed by moving all of the constituents to the required aggregates. Note that in order to tier data, not only does the volume need to support tiering by using FabricPools, the tiering "policy" must not be 'none'. A volume that uses FabricPools but has a tiering "policy" of 'none' supports tiering, but will not tier any data.

volume

Name Type Description

_links

_tags

array[string]

Tags are an optional way to track the uses of a resource. Tag values must be formatted as key:value strings.

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.

aggressive_readahead_mode

string

Default value: 1
enum: ["none", "file_prefetch"]
Introduced in: 9.13
x-nullable: true

analytics

anti_ransomware

Anti-ransomware related information of the volume.

anti_ransomware_state

string

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

cloud_write_enabled

boolean

Introduced in: 9.13
x-ntap-readModify: true
x-nullable: true

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=" as query parameters.

constituents_per_aggregate

integer

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

Introduced in: 9.12
x-nullable: true

guarantee

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

metric

Performance numbers, such as IOPS, latency and throughput.

movement

msid

integer

The volume's Master Set ID.

name

string

nas

optimize_aggregates

boolean

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

Configuration and runtime properties involving non-disruptive volume capacity rebalancing for a FlexGroup volume.

scheduled_snapshot_naming_scheme

string

Naming Scheme for automatic Snapshot copies:

create_time - Automatic Snapshot copies are saved as per the start of their current date and time.
ordinal - Latest automatic snapshot copy is saved as .0 and subsequent copies will follow the create_time naming convention.

size

integer

snaplock

snapmirror

Specifies attributes for SnapMirror protection.

snapshot_count

integer

Number of Snapshot copies in the volume.

snapshot_directory_access_enabled

boolean

This field, if true, enables the visible ".snapshot" directory from the client. The ".snapshot" directory will be available in every directory on the volume.

snapshot_locking_enabled

boolean

Specifies whether or not snapshot copy locking is enabled on the volume.

snapshot_policy

This is a reference to the Snapshot copy policy.

space

state

string

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

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 dp volume. Valid in GET.

use_mirrored_aggregates

boolean

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: 028baa66-41bd-11e9-81d5-00a0986138f7
readOnly: 1
Introduced in: 9.6
x-nullable: true

job_link

Name

Type

Description

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

Create a volume on an SVM and storage aggregates

Creating your file...

Required properties

Default property values

Related ONTAP commands

Parameters

Request Body

Response

Headers

Error

Definitions