Skip to main content
Element Software
A newer release of this product is available.

drive

Contributors netapp-pcarriga
PDFs

The drive object contains information about individual drives in the cluster's active nodes. This object contains details on drives that have been added as volume metadata or block drives, as well as drives that have not yet been added and are available. You can retrieve this information with the ListDrives API method.

Object members

This object contains the following members:

Name Description Type

attributes

List of name-value pairs in JSON object format. This object is always null and is not modifiable.

JSON object

capacity

The total capacity of the drive, in bytes.

integer

chassisSlot

For HCI platforms, this value is the node letter and slot number in the server chassis where this drive is located. For storage platforms, the slot number is a string representation of the "slot" integer.

string

driveFailureDetail

If a drive's status is "Failed", this field provides more detail on why the drive was marked failed.

string

driveID

The ID of this drive.

integer

driveSecurityFaultReason

If enabling or disabling drive security failed, the reason why it failed. If the value is "none", there was no failure.

string

keyID

The keyID used by the key provider to acquire the authentication key for unlocking this drive.

UUID

keyProviderID

Identifies the provider of the authentication key for unlocking this drive.

integer

nodeID

The ID of the node containing this drive.

integer

segmentFileSize

The segment file size of the drive, in bytes.

integer

serial

The drive serial number.

string

slot

The slot number in the server chassis where this drive is located, or -1 if a SATADimm device is used for the internal metadata drive.

integer

status

The status of the drive. Possible values:

  • available: An available drive.

  • active: An active drive.

  • erasing: A drive is in the process of being secure erased. Any data on that drive is permanently removed.

  • failed: A drive that has failed. Any data that was previously on the drive has been migrated to other drives in the cluster.

  • removing: A drive is in the process of being removed. Any data previously on the drive is being migrated to other drives in the cluster.

string

type

The type of drive. Possible values:

  • volume: Stores volume metadata.

  • block: Stores block data.

  • unknown: Drive type not yet active and is yet to be determined.

string

usableCapacity

The usable capacity of the drive, in bytes.

integer

Find more information

ListDrives