Update disk ownership, change authentication keys, or sanitize disks

storage disk assign
storage encryption disk modify -data-key-id
storage encryption disk sanitize
security key-manager key query -key-type NSE-AK

Learn more

DOC /storage/disks

Parameters

Name	Type	In	Required	Description
name	string	query	False	Disk name
node	string	query	False	Node to assign disk Introduced in: 9.8
encryption_operation	string	query	False	Name of the operation to apply to encrypting disks. rekey_data_default changes the data authentication key (AK) to the drive-unique Manufacture Secure ID (MSID) value. Allows the drive to be attached to other clusters. Disables data-at-rest protection without erasing the data. rekey_data_auto_id changes the data authentication key (AK) to an AK the cluster selects automatically. Enables data-at-rest protection. sanitize_disk cryptographically erases all user data from a spare or broken drive by altering the data encryption key. Resets the data AK to the drive-unique MSID value and disables data-at-rest protection. Used when a drive is being repurposed or returned. enum: ["rekey_data_default", "rekey_data_auto_id", "sanitize_disk"]
return_records	boolean	query	False	The default is false. If set to true, the records are returned. Default value:

Name

Type

In

Required

Description

name

string

query

False

Disk name

node

string

query

False

Node to assign disk

Introduced in: 9.8

encryption_operation

string

query

False

Name of the operation to apply to encrypting disks.

rekey_data_default changes the data authentication key (AK) to the drive-unique Manufacture Secure ID (MSID) value. Allows the drive to be attached to other clusters. Disables data-at-rest protection without erasing the data.
rekey_data_auto_id changes the data authentication key (AK) to an AK the cluster selects automatically. Enables data-at-rest protection.
sanitize_disk cryptographically erases all user data from a spare or broken drive by altering the data encryption key. Resets the data AK to the drive-unique MSID value and disables data-at-rest protection. Used when a drive is being repurposed or returned.
enum: ["rekey_data_default", "rekey_data_auto_id", "sanitize_disk"]

return_records

boolean

query

False

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

Default value:

Request Body

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
container_type	string	Type of overlying disk container
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
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.
paths	array[disk_path_info]	List of paths to a disk
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
rpm	integer	Revolutions per minute
sector_count	integer	Number of sectors on the disk.
self_encrypting	boolean
serial_number	string
state	string	State
stats	stats
type	string	Disk interface type
uid	string	The unique identifier for a disk
usable_size	integer
vendor	string

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

container_type

string

Type of overlying disk container

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

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.

paths

array[disk_path_info]

List of paths to a disk

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

rpm

integer

Revolutions per minute

sector_count

integer

Number of sectors on the disk.

self_encrypting

boolean

serial_number

string

state

string

State

stats

type

string

Disk interface type

uid

string

The unique identifier for a disk

usable_size

integer

vendor

string

Example request

{
  "aggregates": [
    {
      "name": "aggr1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "bay": "1",
  "bytes_per_sector": "520",
  "class": "solid_state",
  "container_type": "spare",
  "effective_type": "vmdisk",
  "encryption_operation": "string",
  "error": [
    {
      "reason": {
        "code": "string",
        "message": "not responding"
      },
      "type": "notallflashdisk"
    }
  ],
  "firmware_version": "NA51",
  "key_id": {
    "data": "string",
    "fips": "string"
  },
  "model": "X421_HCOBE450A10",
  "name": "1.0.1",
  "node": {
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "outage": {
    "reason": {
      "code": "721081",
      "message": "not responding"
    }
  },
  "paths": [
    {
      "initiator": "3a",
      "port_name": "A",
      "port_type": "sas",
      "wwnn": "5000c2971c1b2b8c",
      "wwpn": "5000c2971c1b2b8d"
    }
  ],
  "pool": "pool0",
  "protection_mode": "string",
  "rated_life_used_percent": "10",
  "rpm": "15000",
  "sector_count": "1172123568",
  "serial_number": "KHG2VX8R",
  "state": "present",
  "stats": {
    "average_latency": "3",
    "iops_total": "12854",
    "path_error_count": "0",
    "power_on_hours": "21016",
    "throughput": "1957888"
  },
  "type": "ssd",
  "uid": "002538E5:71B00B2F:00000000:00000000:00000000:00000000:00000000:00000000:00000000:00000000",
  "usable_size": "959934889984",
  "vendor": "NETAPP"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code	Description
721066	Node is outside the list of controllers for disk.
1441795	Setting the data key ID to the manufacture secure ID is not allowed when in FIPS-compliance mode.
14155777	The operation failed on one or more disks.
14155778	No self-encrypting disks were specified.
14155779	Status from a node shows that a conflicting operation has occurred. Some disk controls might have changed.
14155780	Could not retrieve the required key ID from the key manager.
14155786	Changes to encryption controls are not allowed with drive assignment.

Definitions

See Definitions

href

Name	Type	Description
href	string

Name

Type

Description

href

string

_links

aggregates

Aggregate

Name	Type	Description
name	string
uuid	string

Name

Type

Description

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

reason

Name	Type	Description
code	string	Provides an error code.
message	string	Provides an error message detailing the error state of this disk.

Name

Type

Description

code

string

Provides an error code.

message

string

Provides an error message detailing the error state of this disk.

disk_error_info

Name	Type	Description
reason	reason
type	string	Disk error type.

Name

Type

Description

reason

type

string

Disk error type.

home_node

Name	Type	Description
name	string
uuid	string

Name

Type

Description

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

Name

Type

Description

name

string

uuid

string

reason

Name	Type	Description
code	string	This field provides the error code explaining why a disk failed.
message	string	This field provides the error message explaining why a disk failed.

Name

Type

Description

code

string

This field provides the error code explaining why a disk failed.

message

string

This field provides the error message explaining why a disk failed.

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 accross reboots.
reason	reason

Name

Type

Description

persistently_failed

boolean

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

reason

disk_path_info

Name	Type	Description
initiator	string	Initiator port.
port_name	string	Name of the disk port.
port_type	string	Disk port type.
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.

port_name

string

Name of the disk port.

port_type

string

Disk port type.

wwnn

string

Target device's World Wide Node Name.

wwpn

string

Target device's World Wide Port Name.

shelf

Name	Type	Description
uid	string

Name

Type

Description

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.

disk

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
container_type	string	Type of overlying disk container
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
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.
paths	array[disk_path_info]	List of paths to a disk
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
rpm	integer	Revolutions per minute
sector_count	integer	Number of sectors on the disk.
self_encrypting	boolean
serial_number	string
state	string	State
stats	stats
type	string	Disk interface type
uid	string	The unique identifier for a disk
usable_size	integer
vendor	string

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

container_type

string

Type of overlying disk container

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

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.

paths

array[disk_path_info]

List of paths to a disk

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

rpm

integer

Revolutions per minute

sector_count

integer

Number of sectors on the disk.

self_encrypting

boolean

serial_number

string

state

string

State

stats

type

string

Disk interface type

uid

string

The unique identifier for a disk

usable_size

integer

vendor

string

Update disk ownership, change authentication keys, or sanitize disks

Creating your file...

Related ONTAP commands

Learn more

Parameters

Request Body

Response

Error

Definitions