APIs in Category: disk | API version 1.8

disk-fail disk-list-info disk-release-all-reservations disk-remove disk-replace-start disk-replace-stop disk-sanown-assign disk-sanown-filer-list-info disk-sanown-list-info disk-sanown-reassign disk-sanown-remove-ownership disk-swap disk-unfail disk-unswap disk-update-disk-fw disk-zero-spares

NetApp Manage ONTAP

disk-fail | [top]

> Fail a file system disk. Removes the specified file system disk from the RAID configuration, spinning the disk down when removal is complete. disk fail is used to remove a file system disk that may be logging excessive errors and requires replacement. Note that if optional input parameter 'is-immediate' is true, the specified disk will be immediately failed out, and the RAID group to which the disk belongs will enter degraded mode (meaning a disk is missing from the RAID group). If a spare disk at least as large as the disk being removed is available, the contents of the disk being removed will be reconstructed onto that spare disk. If 'is-immediate' options is false or not specified, system will prefail the disk and its content will be copied to a replacement disk if a suitable spare disk is available, and afterwards the prefailed disk will be failed out. This process can be observed by polling disk-list-info for this disk and tracking values of elements copy-destination and copy-percent. The disk being failed is marked as ``broken'', so that if it remains in the disk shelf, it will not be used by the filer as a spare disk. If the disk is moved to another filer, that filer will use it as a spare. This is not a recommended course of action, as the reason that the disk was failed may have been because it needed to be replaced. NOTE: Data ONTAP 7.0 and earlier releases don't indicate failure code properly.

> Input Name | Range | Type | Description
> disk |  | string | Name of the disk to fail, e.g. "v0.1".
> is-immediate |  | boolean optional | Specify 'true' if disk is to be failed out immediately. If disk is to be prefailed, specify 'false'. Default value is 'false'.

> Errno | Description
> EINTERNALERROR |  |
> EDISKNOTFOUND |  |
> ESWAPINPROGRESS |  |
> ENOTDISKOWNER |  |
> EOPNOTSUPPORTED |  |
> EDISKINRAIDZEROVOL |  |
> ENOTSTARTED |  |
> EDISKISSPARE |  |
> ESAVECOREDISK |  |

disk-list-info | [top]

> Get disk status information from RAID. Only disks owned by the filer or its partner are eligible for inclusion in the returned list. To obtain information about disks connected to the filer but not owned by the local filer or its CFO partner, use the disk-sanown-list-info api.

> Input Name | Range | Type | Description
> disk |  | string optional | Get status for given disk, if not supplied, get status for all disks owned by the filer and its CFO partner.
> Output Name | Range | Type | Description
> disk-details |  | disk-detail-info[] | List of disks and their status.

> Errno | Description
> EINTERNALERROR |  |
> EDISKNOTFOUND |  |

> Vfiler-enabled
> Yes

disk-release-all-reservations | [top]

> Release reservations on all reserved disks. When invoked from maintenance mode, all reservations are released on all disks until the system is rebooted. When not in maintenance mode, then the system will automatically re-issue reservations for disks it owns. In sanown environment the system will reserve its disks everu 30 seconds.

> Errno | Description
> ERESERVATIONSDISABLED |  |
> EUNABLETORELEASE |  |

disk-remove | [top]

> Remove a spare disk. Removes the specified spare disk from the RAID configuration, spinning the disk down when removal is complete. You can use disk remove to remove a spare disk so that it can be used by another filer (as a replacement for a failed disk or to expand file system space). NOTE: Data ONTAP 7.0 and earlier releases don't indicate failure code properly.

> Input Name | Range | Type | Description
> disk |  | string | Disk to remove.

> Errno | Description
> EINTERNALERROR |  |
> EDISKNOTFOUND |  |
> ENOTSTARTED |  |
> EDISKNOTSPARE |  |
> ESAVECOREDISK |  |

disk-replace-start | [top]

> Initiate replacing a file system disk with an appropriate spare disk. Uses Rapid RAID Recovery to copy data from the source file system disk to the destination spare disk. Roles of disks are reversed at the end of that process. The spare disk will replace the file system disk in the RAID group and the file system disk will become a spare. This process can be observed by polling disk-list-info for this disk and tracking values of elements copy-destination and copy-percent.

> Input Name | Range | Type | Description
> disk |  | string | Name of the file system disk to replace.
> force |  | boolean optional | Allow replacement-disk to come from the opposite spare pool. Also allow replacement-disk not matching rotational speed of majority of disks in the aggregate.
> replacement-disk |  | string | Name of the spare disk to use as a replacement.

> Errno | Description
> EDISKNOTFOUND |  |
> ENOTDISKOWNER |  |
> EDISKISSPARE |  |
> EDISKNOTSPARE |  |
> EDISKTOOSMALL |  |
> EDISKINRAIDZEROVOL |  |
> EALREADYSTARTED |  |
> ERAIDGROUPDEGRADED |  |
> EVOLUMEOFFLINE |  |
> EINTERNALERROR |  |

disk-replace-stop | [top]

> Abort disk replace.

> Input Name | Range | Type | Description
> disk |  | string | Name of the file system disk being replaced.

> Errno | Description
> EDISKNOTFOUND |  |
> EDISKISSPARE |  |
> ENOTSTARTED |  |
> EINTERNALERROR |  |

disk-sanown-assign | [top]

> Changes ownership on a disk. The normal usage is when there is no current owner or to assign a disk to a pool.

> Input Name | Range | Type | Description
> auto |  | boolean optional | Auto-assign unowned disks which are on loops where only 1 filer owns the disks and the pool information is the same. No other input parameters are allowed when specifying this option.
> checksum |  | string optional | Assign checksum type to disk. Option may only be specified on a gFiler. Possible values: 'block' or 'zoned'.
> disk |  | string | Name of disk to assign. Wildcarding for disk string is supported.
> force |  | boolean optional | Force flag need to be set to 'true' if assigning disks which are already owned a Filer. However, if that Filer is up and has put a reservation on the disk, even the force option won't work.
> owner |  | string optional | Assign disk to specific owner.
> owner-id |  | integer optional | Assign disk to specific owner ID (NVRAM ID or serial number). Range : [0..2^32-1].
> pool |  | integer optional | Assign disk to specific pool, e.g. '0' or '1'.

> Errno | Description
> EINTERNALERROR |  |
> EDISKNOTFOUND |  |
> EINVALIDOWNER |  |
> EINVALIDINPUTERROR |  |

disk-sanown-filer-list-info | [top]

> Get sanown filer information.

> Output Name | Range | Type | Description
> disk-sanown-filer-details |  | disk-sanown-filer-detail-info[] | List of filers and their information.

> Errno | Description
> EINTERNALERROR |  |
> ESANOWNNOTENABLED |  |

disk-sanown-list-info | [top]

> Get sanown disk information.

> Input Name | Range | Type | Description
> disk |  | string optional | Get ownership status for given disk, if not supplied, get ownership for all disks or if onership-type is supplied, get ownership info for disks of specific type. '6a*' wildcarding is supported.
> ownership-type |  | string optional | Possible values are 'all' which will list all disks. 'unowned' which will list all disks without owners. 'owned' which will list all disks with owners. 'unknown' which will list all disks with unknown owners. 'visible' which will list all disks belonging to the local and partner filer. Default is 'all'. If specific disk is specified, ownership-type will be ignored.
> Output Name | Range | Type | Description
> disk-sanown-details |  | disk-sanown-detail-info[] | List of disks and their sanown information.

> Errno | Description
> EINTERNALERROR |  |
> EDISKNOTFOUND |  |

disk-sanown-reassign | [top]

> Changes ownership on disks already belonging to an owner.

> Input Name | Range | Type | Description
> force |  | boolean optional | Force flag need to be set to 'true' if reassigning disks which are owned by another Filer. However, if that Filer is up and has put a reservation on the disk, even the force option won't work. In this case reassign will need to be run on the Filer which owns the disks.
> new-owner |  | string optional | Name of new owner. This form will assign all the disks belonging to the old owner to the specific owner.
> new-owner-id |  | integer optional | ID of new owner. This form will assign all the disks belonging to the old owner to the specific owner ID. Either new-owner or new-owner-id (or both) must be specified. Range : [0..2^32-1].
> old-owner |  | string optional | Name of old owner. This form takes all disks currently belonging to the specific old owner, and reassigns them to a new owner.
> old-owner-id |  | integer optional | ID of old owner. This form takes all disks currently belonging to the specific old owner ID, and reassign them to a new owner. Either old-owner or old-owner-id must be specified, but not both. Range : [0..2^32-1].

> Errno | Description
> EINTERNALERROR |  |

disk-sanown-remove-ownership | [top]

> Removes ownership information on a disk. Default usage is to remove ownership information for all disks owned by the local node, in maintenance mode.

> Input Name | Range | Type | Description
> all |  | boolean optional | If 'true' remove ownership information from all disks. (maintenance mode only)
> disk-list |  | disk-name[] optional | List of disks to remove ownership information from. Example: 4a.18 5b.16 switch1:10.126L4
> owner-id |  | integer optional | Remove ownership of all disks owned by this owner-id (maintenance mode only). Range [0..2^32-1]

> Errno | Description
> EINVALIDINPUTERROR |  |
> EDISKNOTFOUND |  |
> EINVALIDOWNER |  |
> EINVALIDRESERVATION |  |
> ENODISKSFOUND |  |
> EMUSTBEINMAINTMODE |  |
> EINTERNALERROR |  |

disk-swap | [top]

> Prepare (quiet) bus for swap. Applies to SCSI disks only. It stalls all I/O on the filer to allow a disk to be physically added or removed from a disk shelf. Typically, this command would be used to allow removal of a failed disk, or of a file system or spare disk that was prepared for removal using the disk fail or disk remove command. Once a disk is physically added or removed from a disk shelf, system I/O will automatically continue. NOTE: It is important to issue the disk swap command only when you have a disk that you want to physically remove or add to a disk shelf, because all I/O will stall until a disk is added or removed from the shelf.

> Errno | Description
> EOPNOTSUPPORTED |  |
> EALREADYSTARTED |  |
> EINTERNALERROR |  |

disk-unfail | [top]

> Unfail a disk in the broken pool, by clearing its FDR (Failed Disk Registry) entry and unfailing it at the Storage Layer, as necessary. If the "make-spare" option is set to B_TRUE, the disk is returned to the spare pool. Otherwise, label assimilation will bring the disk back according to its on-disk labels, with one of four possible outcomes. 1. Disk becomes a spare. This is the common case. The disk becomes a spare upon unfail, because its parent volume is complete and online. 2. Disk is assimilated into former volume. This is a recovery scenario. The disk is brought back into an existing volume, which may result in this volume coming back online. 3. Disk is assimilated into a new partial volume. This may occur in the rare case that the disk's former volume was destroyed or moved. 4. Disk returned to broken pool. This is the case if a fatal error occurs in process of unfailing the disk.

> Input Name | Range | Type | Description
> disk |  | string | Name of the disk, e.g. "v0.1".
> make-spare |  | boolean optional | Specify 'true' to force the disk to become a spare upon unfail. Default value is 'false'.

> Errno | Description
> EINTERNALERROR |  |
> EDISKNOTFOUND |  |

disk-unswap | [top]

> Undo disk swap and resume service.

> Errno | Description
> EOPNOTSUPPORTED |  |
> ENOTSTARTED |  |
> EINTERNALERROR |  |

disk-update-disk-fw | [top]

> Start disk firmware download process to update firmware on disks. This operation is asynchronous, and therefore returns no errors that might occur during the download process. This operation will only update firmware on disks that do not have the latest firmware revision. The firmware revision on the disk can be monitored via the disk-list-info API.

> Input Name | Range | Type | Description
> disk-list |  | disk-name[] optional | List of disks to be updated. If not specified, all disks are updated. Example: 4a.18 5b.16 switch1:10.126L4

> Errno | Description
> EINTERNALERROR |  |
> EDISKNOTFOUND |  |
> EINVALIDINPUTERROR |  |

disk-zero-spares | [top]

> Set up all non-zeroed spares owned by the filer to start zeroing. This operation is asynchronous, and therefore returns no errors that might occur when the zeroing operation actually starts, which could be several seconds after this API operation completes. Zeroing progress can be monitored via the disk-list-info API. The "zeroing-percent" element of disk-detail-info is returned if disk zeroing has started, and "is-zeroed" returns TRUE once the zeroing has completed (or, if zeroing wasn't necessary in the first place).

> Errno | Description
> EINTERNALERROR |  |

Element definition: disk-detail-info | [top]

> Disk status information.

> Name | Range | Type | Description
> aggregate |  | string optional | Aggregate that the disk resides on. Returned for disks contained on a flexible volume. Not returned for traditional volumes.
> bay |  | string | Disk bay. If disk bay can't be determined, value will be "?".
> blocks-read |  | integer | Number of blocks read since the controller was power on last. Range: [0..2^64-1]
> blocks-written |  | integer | Number of blocks written since the controller was powered on last. Range: [0..2^64-1]
> broken-details |  | string optional | Reason for the disk failure, if raid-state is 'broken'. Possible values are 'unknown', 'failed', 'admin failed', 'labeled broken', 'init failed', 'admin removed', 'not responding', 'pulled', 'bad label', 'bypassed', and 'not failed'. If raid-state is not 'broken', broken-details will be omitted in the ouput.
> bytes-per-sector |  | integer | Bytes per sector. Range : [0..2^31-1].
> checksum-compatibility |  | string | Checksum compatibility based on BPS. Valid values are "zoned", "zoned/block", or "none".
> copy-destination |  | string optional | The name of the disk selected as the destination to copy this disk when it must be replaced (is-prefailed or is-replacing is true). This element is not returned if the destination is not selected. The destination might not be present even when is-prefailed or is-replacing is true, if there is no appropriate spare, or other disk copy is in progress, or the destination was not yet selected, including immediately after disk-replace-start.
> copy-percent |  | integer optional | Percent of disk copy done, if disk is involved in Rapid RAID Recovery, either as the source (is-prefailed or is-replacing is true) or as the destination (raid-state is 'copy') of disk copy. This element is not returned if the destination is not selected yet. Range : [0..100].
> disk-model |  | string | Disk model.
> disk-type |  | string | Type of disk: ATA, EATA, FCAL, LUN, SAS, SATA, SCSI, XATA, XSAS, or unknown.
> disk-uid |  | string | Disk unique identifier. Maximum length of 90 characters.
> effective-disk-type |  | string | Disks with same effective-disk-type are compatible, and they can be used in the same aggregate, even though their physical disk type, as reported by disk-type may be different. Possible values are the same as for disk-type: ATA, EATA, FCAL, LUN, SAS, SATA, SCSI, XATA, XSAS, or unknown.
> firmware-revision |  | string | Firmware revision of disk. The format of the firmware revision will vary depending on the type of disk and its vendor.
> grown-defect-list-count |  | integer | Number of entries in the drive's grown defect list. Range: [0..2^64-1]
> host-adapter |  | string | Host adapter.
> id |  | integer | internal Id of disk. Range : [-2^31..2^31-1].
> is-dynamically-qualified |  | boolean | True if the drive was dynamically qualified.
> is-offline |  | boolean optional | True if the disk is offline. If the disk is not offline, this element will not be included with the output.
> is-prefailed |  | boolean optional | True if the disk is prefailed and undergoing disk copy (as the source) or waiting for such disk copy to be started, false otherwise.
> is-replacing |  | boolean optional | True if the disk is marked to be replaced with another disk and undergoing disk copy (as the source) or waiting for such disk copy to be started, false otherwise.
> is-zeroed |  | boolean optional | True if the disk is a spare and has already been zeroed, false otherwise. If disk is not a spare or if it is currently being zeroed, this element will not be included with the output.
> name |  | string | Name of the disk, e.g. v1.1
> physical-blocks |  | integer | Number of 512-byte blocks on disk. Range : [0..2^64-1].
> physical-space |  | integer | Physical disk size in bytes. Range : [0..2^64-1].
> plex |  | string optional | Plex the disk belongs. Not returned if disk doesn't belong to any plex. Example : plex0.
> pool |  | string optional | Pool the disk is in. Example : pool0.
> port |  | string | Port of disk, e.g. A.
> port-name |  | string | The port name of the disk object, e.g. FC:A.
> poweron-hours |  | integer optional | Number of hours the drive has been powered on. Range: [0..2^64-1]
> raid-group |  | string optional | Raid group disk belongs. Not returned if disk doesn't belong to any raid group.
> raid-state |  | string | Raid state. Possible values are : partner, broken, zeroing, spare, copy, pending, reconstructing, and present.
> raid-type |  | string | Raid type. Possible values are : pending, parity, dparity, data.
> raw-disk-sectors |  | integer | Number of sectors on disk (as reported by the read capacity command). Range: [0..2^64-1].
> reconstruction-percent |  | integer optional | Percent of reconstruction done, if the disk is undergoing reconstruction (raid-state is 'reconstructing'). This element is not returned if the disk is not being reconstructed. Range : [0..100].
> rpm |  | integer optional | Rotational speed in revolutions per minute. Possible values are: 5400, 7200, 10000, and 15000. This element is not returned when the value is not known, or when it does not apply.
> scrub-count |  | integer | Number of times the drive was scrubbed since the controller was powered on last. Range: [0..2^64-1]
> scrub-last-done |  | integer | Minutes since the last time scrub was completed. Range: [0-2^64-1]
> secondary-name |  | string | Secondary name.
> secondary-port |  | string | Secondary port.
> serial-number |  | string | Disk serial number. Maximum length of 129 characters.
> shelf |  | string | Disk shelf. If disk shelf can't be determined, value will be "?".
> shm-time-interval |  | integer | Number of seconds we have been counting errors from SHM (Storage Health Monitor). Range: [0..2^64-1]
> used-blocks |  | integer | Number of 512-byte blocks used. Range : [0..2^64-1].
> used-space |  | integer | Used space in bytes. Range : [0..2^64-1].
> v-series-detail-info |  | v-series-detail-info | Lists v-series(gfiler) status info for the disk
> vendor-id |  | string | Vendor of this disk.
> volume |  | string optional | Volume the disks is used in. Not returned if disk isn't used in any volume or if the disk belongs to a partner or if the disk is in an aggregate.
> zeroing-percent |  | integer optional | Zeroing percentage done, if disk is being zeroed. Element is not returned if disk is not being zeroed. Range : [0..100].

Element definition: disk-name | [top]

> name of a disk.

> [none]

Element definition: disk-sanown-detail-info | [top]

> Disk sanown information.

> Name | Range | Type | Description
> checksum |  | string optional | Only returned on gFiler's. Possible values: 'block' or 'zoned'.
> home |  | string optional | The home of the disk. On NG will be different than owner if the home node has been taken over. On Classic this will be the same as owner. If the disk has no owner, this will not be returned.
> home-id |  | integer optional | ID (NVRAM ID) of disk home. Range : [0..2^32-1].
> is-failed |  | boolean | 'true' if the disk is failed, 'false' otherwise.
> name |  | string | Name of the disk, e.g. v1.1 Wildcarding for disk string is suuported, e.g. v1.*
> owner |  | string optional | Current owner of the disk. If disk has no owner, this will not be returned.
> owner-id |  | integer optional | ID (NVRAM ID) of owner if there is one. Range : [0..2^32-1].
> pool |  | integer optional | Pool the disk belongs to, if it has a owner.
> reserved-by |  | integer | ID (NVRAM ID) of node with the reservation on this disk, 0 if there is none. Range : [0..2^32-1].
> serial-no |  | string | Serial number of the disk.

Element definition: disk-sanown-filer-detail-info | [top]

> Disk sanown filer information.

> Name | Range | Type | Description
> filer-id |  | integer | ID (NVRAM ID) of owner. Range : [0..2^32-1].
> filer-name |  | string optional | Name of the filer. If the filer name hasn't been written to the disks, this will not be returned.

Element definition: v-series-detail-info | [top]

> v-series(gfiler) status information for the disk

> Name | Range | Type | Description
> alternate-array-port-wwn |  | string | The V-Series (gFiler) alternate path is the path that can be used to communicate with the LUN, but not currently used. This is the WWN of the array FC port used as primary path.
> alternate-array-switch-port-wwn |  | string optional | The V-Series (gFiler) alternate path is the path that can be used to communicate with the LUN, but not currently used. This is the WWN of the switch FC port connected to the array FC port used as primary path. This field is present in switch attached configrations only.
> alternate-controller-port-wwn |  | string | The V-Series (gFiler) alternate path is the path that can be used to communicate with the LUN, but not currently used. This is the WWN of the V-Series controller FC port used as primary path.
> alternate-lun-number |  | integer | LUN number on the alternate path
> alternate-switch-name |  | string optional | Switch name of the alternate path. Present for switch attached configurations only.
> alternate-switch-port |  | integer optional | Switch port of the alternate path. Present for switch attached configurations only. Range: [0..1024].
> primary-array-port-wwn |  | string | The V-Series (gFiler) primary path is the path that is currently used to communicate with the LUN. This is the WWN of the array FC port used as primary path.
> primary-array-switch-port-wwn |  | string optional | The V-Series (gFiler) primary path is the path that is currently used to communicate with the LUN. This is the WWN of the switch FC port connected to the array FC port used as primary path. This field is present in switch attached configrations only.
> primary-controller-port-wwn |  | string | The V-Series (gFiler) primary path is the path that is currently used to communicate with the LUN. This is the WWN of the V-Series controller FC port used as primary path.
> primary-lun-number |  | integer | LUN number on the primary path
> primary-switch-name |  | string optional | Switch name of the primary path. Present for switch attached configurations only.
> primary-switch-port |  | integer optional | Switch port of the primary path. Present for switch attached configurations only. Range: [0..1024].
> product-id |  | string | Product id string of the raid array lun resides on.