Retrieve a specific disk

storage disk show

Learn more

DOC /storage/disks

Parameters

Name	Type	In	Required	Description
name	string	path	True	Disk name
fields	array[string]	query	False	Specify the fields to return.

Name

Type

In

Required

Description

name

string

path

True

Disk name

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok

Name	Type	Description
aggregates	array[aggregates]	List of aggregates sharing this disk
bay	integer	Disk shelf bay
bytes_per_sector	integer	Bytes per sector.
class	string	Disk class
compliance_standard	string	Security standard that the device is certified to.
container_type	string	Type of overlying disk container
control_standard	string	Standard that the device supports for encryption control.
dr_node	dr_node
drawer	drawer
effective_type	string	Effective Disk type
encryption_operation	string	This field should only be set as a query parameter in a PATCH operation. It is input only and won't be returned by a subsequent GET.
error	array[disk_error_info]	List of disk errors information.
fips_certified	boolean
firmware_version	string
home_node	home_node
key_id	key_id
local	boolean	Indicates if a disk is locally attached versus being remotely attached. A locally attached disk resides in the same proximity as the host cluster versus been attached to the remote cluster.
model	string
name	string	Cluster-wide disk name
node	node
outage	outage	Indicates if a disk has an entry in the failed disk registry, along with the reason for the failure.
overall_security	string	Overall Security rating, for FIPS-certified devices.
paths	array[disk_path_info]	List of paths to a disk
physical_size	integer	Physical size, in units of bytes
pool	string	Pool to which disk is assigned
protection_mode	string	Mode of drive data protection and FIPS compliance. Possible values are: open - Data is unprotected data - Data protection only, without FIPS compliance part - Data is unprotected; other FIPS compliance settings present full - Full data and FIPS compliance protection miss - Protection mode information is not available
rated_life_used_percent	integer	Percentage of rated life used
right_size_sector_count	integer	Number of usable disk sectors that remain after subtracting the right-size adjustment for this disk.
rpm	integer	Revolutions per minute
sector_count	integer	Number of sectors on the disk.
self_encrypting	boolean
serial_number	string
shelf	shelf	Shelf
state	string	State
stats	stats
storage_pool	storage_pool	Shared Storage Pool
type	string	Disk interface type
uid	string	The unique identifier for a disk
usable_size	integer
vendor	string
virtual	virtual	Information about backing storage for disks on cloud platforms.

Name

Type

Description

aggregates

array[aggregates]

List of aggregates sharing this disk

bay

integer

Disk shelf bay

bytes_per_sector

integer

Bytes per sector.

class

string

Disk class

compliance_standard

string

Security standard that the device is certified to.

container_type

string

Type of overlying disk container

control_standard

string

Standard that the device supports for encryption control.

dr_node

drawer

effective_type

string

Effective Disk type

encryption_operation

string

This field should only be set as a query parameter in a PATCH operation. It is input only and won't be returned by a subsequent GET.

error

array[disk_error_info]

List of disk errors information.

fips_certified

boolean

firmware_version

string

home_node

key_id

local

boolean

Indicates if a disk is locally attached versus being remotely attached. A locally attached disk resides in the same proximity as the host cluster versus been attached to the remote cluster.

model

string

name

string

Cluster-wide disk name

node

outage

Indicates if a disk has an entry in the failed disk registry, along with the reason for the failure.

overall_security

string

Overall Security rating, for FIPS-certified devices.

paths

array[disk_path_info]

List of paths to a disk

physical_size

integer

Physical size, in units of bytes

pool

string

Pool to which disk is assigned

protection_mode

string

Mode of drive data protection and FIPS compliance. Possible values are:

open - Data is unprotected
data - Data protection only, without FIPS compliance
part - Data is unprotected; other FIPS compliance settings present
full - Full data and FIPS compliance protection
miss - Protection mode information is not available

rated_life_used_percent

integer

Percentage of rated life used

right_size_sector_count

integer

Number of usable disk sectors that remain after subtracting the right-size adjustment for this disk.

rpm

integer

Revolutions per minute

sector_count

integer

Number of sectors on the disk.

self_encrypting

boolean

serial_number

string

shelf

Shelf

state

string

State

stats

storage_pool

Shared Storage Pool

type

string

Disk interface type

uid

string

The unique identifier for a disk

usable_size

integer

vendor

string

virtual

Information about backing storage for disks on cloud platforms.

Example response

{
  "aggregates": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "aggr1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "bay": 1,
  "bytes_per_sector": 520,
  "class": "solid_state",
  "compliance_standard": "FIPS 140-2",
  "container_type": "spare",
  "control_standard": "TCG Enterprise",
  "dr_node": {
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "effective_type": "vmdisk",
  "error": {
    "reason": {
      "arguments": {
        "code": "string",
        "message": "string"
      },
      "code": "4",
      "message": "entry doesn't exist",
      "target": "uuid"
    },
    "type": "notallflashdisk"
  },
  "firmware_version": "NA51",
  "home_node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "model": "X421_HCOBE450A10",
  "name": "1.0.1",
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "outage": {
    "reason": {
      "arguments": {
        "code": "string",
        "message": "string"
      },
      "code": "4",
      "message": "entry doesn't exist",
      "target": "uuid"
    }
  },
  "overall_security": "Level 2",
  "paths": {
    "initiator": "3a",
    "node.name": "vsim4",
    "node.uuid": "cf7fe057-526d-11ec-af4e-0050568e9df0",
    "port_name": "A",
    "port_type": "sas",
    "vmdisk_hypervisor_file_name": "xvds vol0a0567ae156ca59f6",
    "wwnn": "5000c2971c1b2b8c",
    "wwpn": "5000c2971c1b2b8d"
  },
  "physical_size": 228930,
  "pool": "pool0",
  "protection_mode": "data",
  "rated_life_used_percent": 10,
  "right_size_sector_count": 1172123568,
  "rpm": 15000,
  "sector_count": 1172123568,
  "serial_number": "KHG2VX8R",
  "shelf": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uid": "7777841915827391056"
  },
  "state": "present",
  "stats": {
    "average_latency": 3,
    "iops_total": 12854,
    "path_error_count": 0,
    "power_on_hours": 21016,
    "throughput": 1957888
  },
  "storage_pool": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "storage_pool_1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "type": "ssd",
  "uid": "002538E5:71B00B2F:00000000:00000000:00000000:00000000:00000000:00000000:00000000:00000000",
  "usable_size": 959934889984,
  "vendor": "NETAPP",
  "virtual": {
    "container": "nviet12122018113936-rg",
    "object": "f1fu63se",
    "storage_account": "nviet12122018113936ps",
    "target_address": "string"
  }
}

Error

Status: Default, Error

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

aggregates

Name	Type	Description
_links	_links
name	string
uuid	string

Name

Type

Description

_links

name

string

uuid

string

dr_node

Name	Type	Description
name	string
uuid	string

Name

Type

Description

name

string

uuid

string

drawer

Name	Type	Description
id	integer
slot	integer

Name

Type

Description

id

integer

slot

integer

error_arguments

Name	Type	Description
code	string	Argument code
message	string	Message argument

Name

Type

Description

code

string

Argument code

message

string

Message argument

error

The message and code detailing the error state of this disk.

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.

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.

disk_error_info

Name	Type	Description
reason	error	The message and code detailing the error state of this disk.
type	string	Disk error type.

Name

Type

Description

reason

error

The message and code detailing the error state of this disk.

type

string

Disk error type.

home_node

Name	Type	Description
_links	_links
name	string
uuid	string

Name

Type

Description

_links

name

string

uuid

string

key_id

Name	Type	Description
data	string	Key ID of the data authentication key
fips	string	Key ID of the FIPS authentication key

Name

Type

Description

data

string

Key ID of the data authentication key

fips

string

Key ID of the FIPS authentication key

node

Name	Type	Description
_links	_links
name	string
uuid	string

Name

Type

Description

_links

name

string

uuid

string

error

This error message and code explaining the disk failure.

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.

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.

outage

Indicates if a disk has an entry in the failed disk registry, along with the reason for the failure.

Name	Type	Description
persistently_failed	boolean	Indicates whether RAID maintains the state of this disk as failed across reboots.
reason	error	This error message and code explaining the disk failure.

Name

Type

Description

persistently_failed

boolean

Indicates whether RAID maintains the state of this disk as failed across reboots.

reason

error

This error message and code explaining the disk failure.

disk_path_info

Name	Type	Description
initiator	string	Initiator port.
node.name	string	Controller with the initiator port for this path.
node.uuid	string	Controller UUID, to identify node for this path.
port_name	string	Name of the disk port.
port_type	string	Disk port type.
vmdisk_hypervisor_file_name	string	Virtual disk hypervisor file name.
wwnn	string	Target device's World Wide Node Name.
wwpn	string	Target device's World Wide Port Name.

Name

Type

Description

initiator

string

Initiator port.

node.name

string

Controller with the initiator port for this path.

node.uuid

string

Controller UUID, to identify node for this path.

port_name

string

Name of the disk port.

port_type

string

Disk port type.

vmdisk_hypervisor_file_name

string

Virtual disk hypervisor file name.

wwnn

string

Target device's World Wide Node Name.

wwpn

string

Target device's World Wide Port Name.

shelf

Shelf

Name	Type	Description
_links	_links
uid	string

Name

Type

Description

_links

uid

string

stats

Name	Type	Description
average_latency	integer	Average I/O latency across all active paths, in milliseconds.
iops_total	integer	Total I/O operations per second read and written to this disk across all active paths.
path_error_count	integer	Disk path error count; failed I/O operations.
power_on_hours	integer	Hours powered on.
throughput	integer	Total disk throughput per second across all active paths, in bytes.

Name

Type

Description

average_latency

integer

Average I/O latency across all active paths, in milliseconds.

iops_total

integer

Total I/O operations per second read and written to this disk across all active paths.

path_error_count

integer

Disk path error count; failed I/O operations.

power_on_hours

integer

Hours powered on.

throughput

integer

Total disk throughput per second across all active paths, in bytes.

storage_pool

Shared Storage Pool

Name	Type	Description
_links	_links
name	string
uuid	string

Name

Type

Description

_links

name

string

uuid

string

virtual

Information about backing storage for disks on cloud platforms.

Name	Type	Description
container	string	Container name of the virtual disk.
object	string	Object name of the virtual disk.
storage_account	string	Storage account name of the virtual disk.
target_address	string	Target address of the virtual disk.

Name

Type

Description

container

string

Container name of the virtual disk.

object

string

Object name of the virtual disk.

storage_account

string

Storage account name of the virtual disk.

target_address

string

Target address of the virtual disk.

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.

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.

Retrieve a specific disk

Creating your file...

Related ONTAP commands

Learn more

Parameters

Response

Error

Definitions