JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle® ZFS Storage Appliance RESTful Application Programming Interface
Oracle Technology Network
Library
PDF
Print View
Feedback
search filter icon
search icon

Document Information

Using This Documentation

Chapter 1 Overview

Chapter 2 Working with the API

Chapter 3 Alert Service Commands

Chapter 4 Analytics Services

Chapter 5 Hardware Services

Cluster

Get Cluster Properties

Get Cluster Resource

Modify Cluster Resource

Cluster Commands

Cluster Links

Setup Cluster

Chassis

List Chassis

Get Chassis Components

Get Hardware Component

Modify Component Property

Chapter 6 Log Commands

Chapter 7 Network Commands

Chapter 8 Problem Service Commands

Chapter 9 Role Service

Chapter 10 SAN Services

Chapter 11 Service Commands

Chapter 12 Storage Services

Chapter 13 System Commands

Chapter 14 User Service

Chapter 15 Workflow Commands

Chapter 16 RESTful Clients

Get Hardware Component

This command returns the properties from a single hardware component. An HTTP Status 200 (OK) is returned for a successful command. The response object contains the component properties contained in the following table.

Type
Name
Description
string
device
The FRU device ID
boolean
faulted
Flag indicating if FRU is faulted
string
fru
FMRI representation of a FRU
string
interface
FRU interface type
string
label
FRU location label
boolean
locate
Locate indicator on flag
string
manufacturer
FRU manufacturer
string
model
FRU model
string
part
FRU part number
boolean
present
FRU presence indicator
number
rpm
Platter RPM (disk only)
string
serial
FRU serial number
number
size
FRU size (capacity)
string
type
Component type
string
use
Component usage enumeration

Example Request:

GET /api/hardware/v1/chassis/chassis-001/disk/disk-011 HTTP/1.1
Host: zfs-storage.example.com
Accept: application/json

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "disk": {
        "device": "c0t5000CCA01A764FB0d0",
        "faulted": false,
        "href": "/api/hardware/v1/chassis/chassis-001/disk/disk-011",
        "interface": "SAS",
        "label": "HDD 11",
        "locate": false,
        "manufacturer": "HITACHI",
        "model": "H7230AS60SUN3.0T",
        "pathcount": 4,
        "present": true,
        "revision": "A310",
        "rpm": 7200,
        "serial": "001210R322ED        YHJ322ED",
        "size": 3000592982016,
        "type": "data",
        "use": "peer"
    }
}