Hardware Monitor v1.2
Created Dec 18, 2020 at 07:09 PM

Resource: chassis

Chassis data

http://{device}/api/npm.hardware_monitor/1.2/chassis/items/{serial_number}
  • JSON
  • {
      "availability": string,
      "columns": integer,
      "headunit": boolean,
      "health": string,
      "model": string,
      "rows": integer,
      "sensor_status": {
        "cpus": [ cpu ],
        "exhaust_air_sensors": [ exhaust_air_sensor ],
        "intake_air_sensors": [ intake_air_sensor ],
        "power_supplies": [ power_supply ],
        "raid_controllers": [ raid_controller ],
        "storage_unit_controllers": [ storage_unit_controller ],
        "system_fans": [ system_fan ]
      },
      "serial_number": string,
      "unused_slots": [
        [
          integer
        ]
      ]
    }
    Property Name Type Description Notes
    chassis <object> Chassis data
    availability <string> Read-only; Values: ok, missing, foreign, invalid;
    chassis.columns <integer> The number of columns of disk slots on the chassis. '0' is at the left. Read-only; Optional; Minimum 0;
    chassis.headunit <boolean> Indicates whether this is the head unit chassis. Read-only; Optional;
    health <string> Read-only; Values: ok, notice, failing, failed;
    chassis.model <string> Read-only; Optional;
    chassis.rows <integer> The number of rows of disk slots on the chassis. '0' is at the top. Read-only; Optional; Minimum 0;
    chassis.sensor_status <object> Status of the sensors on the chassis Optional;
    chassis.sensor_status.cpus <array of <cpu>> Optional;
    chassis.sensor_status.cpus[items] <cpu>
    chassis.sensor_status.
    exhaust_air_sensors
    <array of <exhaust_air_sensor>> Optional;
    chassis.sensor_status.
    exhaust_air_sensors[items]
    <exhaust_air_sensor>
    chassis.sensor_status.intake_air_sensors <array of <intake_air_sensor>> Optional;
    chassis.sensor_status.intake_air_sensors
    [items]
    <intake_air_sensor>
    chassis.sensor_status.power_supplies <array of <power_supply>> Optional;
    chassis.sensor_status.power_supplies
    [items]
    <power_supply>
    chassis.sensor_status.raid_controllers <array of <raid_controller>> Optional;
    chassis.sensor_status.raid_controllers
    [items]
    <raid_controller>
    chassis.sensor_status.
    storage_unit_controllers
    <array of <storage_unit_controller>> Optional;
    chassis.sensor_status.
    storage_unit_controllers[items]
    <storage_unit_controller>
    chassis.sensor_status.system_fans <array of <system_fan>> Optional;
    chassis.sensor_status.system_fans[items] <system_fan>
    serial_number <string> Read-only;
    chassis.unused_slots <array of <array of <integer>>> A list of positions in the disk grid that are unused. Optional;
    chassis.unused_slots[items] <array of <integer>>
    chassis.unused_slots[items][items] <integer>

    Relations

    chassis: disks

    Related resource

    disks

    Variables
    Related var Data value for replacement
    chassis 0/serial_number

    chassis: instances

    Related resource

    chassis_list

    Resource: chassis_list

    Collection of chassis

    http://{device}/api/npm.hardware_monitor/1.2/chassis{?availability}
  • JSON
  • {
      "items": [ chassis ]
    }
    Property Name Type Description Notes
    chassis_list <object> Collection of chassis
    chassis_list.items <array of <chassis>> Optional;
    chassis_list.items[items] <chassis> Chassis data

    Resource: disk

    http://{device}/api/npm.hardware_monitor/1.2/disks/items/{id}
  • JSON
  • {
      "blink": boolean,
      "chassis": string,
      "device_type": string,
      "disk_type": string,
      "health": string,
      "id": string,
      "location": {
        "column": integer,
        "label": string,
        "row": integer
      },
      "model": string,
      "serial_number": string,
      "size_mb": integer,
      "status": string
    }
    Property Name Type Description Notes
    disk <object> Required properties: [id, blink];
    disk.blink <boolean> Set to true to blink the drive for identification.
    chassis <string> Read-only;
    disk.device_type <string> Read-only; Optional; Values: disk;
    disk.disk_type <string> Disk technology Read-only; Optional;
    health <string> Read-only; Values: ok, notice, failing, failed;
    disk.id <string> A unique identifier for this disk's slot on this system. Read-only;
    location <object> Read-only;
    location.column <integer> Read-only; Optional; Minimum 0;
    location.label <string> Read-only; Optional;
    location.row <integer> Read-only; Optional; Minimum 0;
    disk.model <string> Model string of the disk Read-only; Optional;
    disk.serial_number <string> Unique identifier of the disk Read-only; Optional;
    disk.size_mb <integer> Size of the disk in mebibytes Read-only; Optional;
    status <string> Read-only; Values: ok, failed, failing, rebuilding, missing, invalid, new;

    Relations

    disk: chassis

    Related resource

    chassis

    Variables
    Related var Data value for replacement
    serial_number 0/chassis

    disk: instances

    Related resource

    disks

    Resource: disks

    http://{device}/api/npm.hardware_monitor/1.2/disks{?status,serial_number,chassis,disk_type}
  • JSON
  • {
      "items": [ disk ]
    }
    Property Name Type Description Notes
    disks <object>
    disks.items <array of <disk>> Optional;
    disks.items[items] <disk>

    Resource: hardware_change_event

    Event sent when the status of a hardware object changes.

    http://{device}/api/npm.hardware_monitor/1.2/event_queues/hardware_change_events/{id}
  • JSON
  • {
      "action": string,
      "device_id": string,
      "device_type": string,
      "hdr": event_header,
      "jobs": [
        {
          "job_id": string,
          "name": string
        }
      ],
      "previous_status": string,
      "status": string
    }
    Property Name Type Description Notes
    hardware_change_event <object> Event sent when the status of a hardware object changes. Required properties: [device_type, device_id];
    hardware_change_event.action <string> Type of object change the event is describing. Optional; Values: new, removed, changed;
    hardware_change_event.device_id <string> Identifying unique attribute of the device
    device_type <string> The type of device that changed. Values: disk, chassis;
    hardware_change_event.hdr <event_header> Common properties for all events
    hardware_change_event.jobs <array of <object>> A list of jobs created in response to this event (future use). Optional;
    hardware_change_event.jobs[items] <object> A job record with name and job id
    hardware_change_event.jobs[items].job_id <string> Optional;
    hardware_change_event.jobs[items].name <string> Optional;
    hardware_change_event.previous_status <string> The previous status, if status changed. Optional;
    hardware_change_event.status <string> The current status of the device. Not included if device was removed. Optional;
    hardware_change_event.oneOf[0] <object>
    hardware_change_event.oneOf[0].
    device_type
    <string> Optional; Values: disk;
    hardware_change_event.oneOf[0].
    previous_status
    <disk_status> Values: ok, failed, failing, rebuilding, missing, invalid, new;
    hardware_change_event.oneOf[0].status <disk_status> Values: ok, failed, failing, rebuilding, missing, invalid, new;
    hardware_change_event.oneOf[1] <object>
    hardware_change_event.oneOf[1].
    availability
    <chassis_availability> Values: ok, missing, foreign, invalid;
    hardware_change_event.oneOf[1].
    device_type
    <string> Optional; Values: chassis;
    hardware_change_event.oneOf[1].
    previous_status
    <disk_status> Values: ok, failed, failing, rebuilding, missing, invalid, new;

    Relations

    hardware_change_event: instances

    Related resource

    hardware_change_events

    Resource: hardware_change_events

    http://{device}/api/npm.hardware_monitor/1.2/event_queues/hardware_change_event{?limit,since_id}
  • JSON
  • {
      "items": [ hardware_change_event ]
    }
    Property Name Type Description Notes
    hardware_change_events <object>
    hardware_change_events.items <array of <hardware_change_event>> Optional;
    hardware_change_events.items[items] <hardware_change_event> Event sent when the status of a hardware object changes.

    Resource: hardware_health

    http://{device}/api/npm.hardware_monitor/1.2/status
  • JSON
  • {
      "status": string
    }
    Property Name Type Description Notes
    hardware_health <object>
    status <string> Read-only; Values: ok, notice, failing, failed;

    Resource: volume

    Data Volume

    http://{device}/api/npm.hardware_monitor/1.2/volumes/items/{id}
  • JSON
  • {
      "chassis": string,
      "health": string,
      "id": string,
      "mode": string,
      "roles": [
        string
      ],
      "status": string
    }
    Property Name Type Description Notes
    volume <object> Data Volume Required properties: [id, mode, status, health, chassis, roles];
    chassis <string> Read-only;
    health <string> Read-only; Values: ok, notice, failing, failed;
    volume.id <string> Read-only;
    mode <string> Read-only; Values: , RAID0, RAID5, RAID6;
    volume.roles <array of <string>>
    volume.roles[items] <string> Values: os, data, capture;
    status <string> Read-only; Values: ok, degraded, rebuilding, uninitialized, failed, missing, invalid;

    Relations

    volume: chassis

    Related resource

    chassis

    Variables
    Related var Data value for replacement
    serial_number 0/chassis

    volume: instances

    Related resource

    volumes

    Resource: volumes

    Data Volumes

    http://{device}/api/npm.hardware_monitor/1.2/volumes{?status}
  • JSON
  • {
      "items": [ volumes ]
    }
    Property Name Type Description Notes
    volumes <object> Data Volumes Required properties: [items];
    volumes.items <array of <volumes>>
    volumes.items[items] <volumes> Data Volumes

    Type: chassis_availability

  • JSON
  • string
    Property Name Type Description Notes
    chassis_availability <string> Values: ok, missing, foreign, invalid;

    Type: cpu

  • JSON
  • {
      "name": string,
      "status": sensor_status,
      "status_msg": string,
      "temperature": sensor_temperature
    }
    Property Name Type Description Notes
    cpu <object> Required properties: [status, name, status_msg, temperature];
    cpu.name <string>
    cpu.status <sensor_status> Values: ok, missing, unknown, failing, failed;
    cpu.status_msg <string>
    cpu.temperature <sensor_temperature>

    Type: device_id

  • JSON
  • string
    Property Name Type Description Notes
    device_id <string>

    Type: device_identity

  • JSON
  • {
      "device_id": string,
      "manufacturer": string,
      "model": string
    }
    Property Name Type Description Notes
    device_identity <object> Required properties: [device_id];
    device_identity.device_id <string>
    device_identity.manufacturer <string> Optional;
    device_identity.model <string> Optional;

    Type: device_type

  • JSON
  • string
    Property Name Type Description Notes
    device_type <string> Values: disk, chassis;

    Type: disk_location

  • JSON
  • {
      "column": integer,
      "label": string,
      "row": integer
    }
    Property Name Type Description Notes
    disk_location <object>
    disk_location.column <integer> Optional; Minimum 0;
    disk_location.label <string> Optional;
    disk_location.row <integer> Optional; Minimum 0;

    Type: disk_status

  • JSON
  • string
    Property Name Type Description Notes
    disk_status <string> Values: ok, failed, failing, rebuilding, missing, invalid, new;

    Type: exhaust_air_sensor

  • JSON
  • {
      "name": string,
      "status": sensor_status,
      "status_msg": string,
      "temperature": sensor_temperature
    }
    Property Name Type Description Notes
    exhaust_air_sensor <object> Required properties: [status, name, status_msg, temperature];
    exhaust_air_sensor.name <string>
    exhaust_air_sensor.status <sensor_status> Values: ok, missing, unknown, failing, failed;
    exhaust_air_sensor.status_msg <string>
    exhaust_air_sensor.temperature <sensor_temperature>

    Type: health_status

  • JSON
  • string
    Property Name Type Description Notes
    health_status <string> Values: ok, notice, failing, failed;

    Type: intake_air_sensor

  • JSON
  • {
      "name": string,
      "status": sensor_status,
      "status_msg": string,
      "temperature": sensor_temperature
    }
    Property Name Type Description Notes
    intake_air_sensor <object> Required properties: [status, name, status_msg, temperature];
    intake_air_sensor.name <string>
    intake_air_sensor.status <sensor_status> Values: ok, missing, unknown, failing, failed;
    intake_air_sensor.status_msg <string>
    intake_air_sensor.temperature <sensor_temperature>

    Type: power_supply

  • JSON
  • {
      "name": string,
      "status": sensor_status,
      "status_msg": string,
      "temperature": sensor_temperature
    }
    Property Name Type Description Notes
    power_supply <object> Required properties: [status, name, status_msg, temperature];
    power_supply.name <string>
    power_supply.status <sensor_status> Values: ok, missing, unknown, failing, failed;
    power_supply.status_msg <string>
    power_supply.temperature <sensor_temperature>

    Type: raid_controller

  • JSON
  • {
      "battery": sensor_status,
      "name": string,
      "status": sensor_status,
      "status_msg": string,
      "temperature": sensor_temperature
    }
    Property Name Type Description Notes
    raid_controller <object> Required properties: [status, name, status_msg, battery, temperature];
    raid_controller.battery <sensor_status> Values: ok, missing, unknown, failing, failed;
    raid_controller.name <string>
    raid_controller.status <sensor_status> Values: ok, missing, unknown, failing, failed;
    raid_controller.status_msg <string>
    raid_controller.temperature <sensor_temperature>

    Type: raid_mode

  • JSON
  • string
    Property Name Type Description Notes
    raid_mode <string> Values: , RAID0, RAID5, RAID6;

    Type: rpm

    Revolutions per minute

  • JSON
  • integer
    Property Name Type Description Notes
    rpm <integer> Revolutions per minute

    Type: sensor_status

  • JSON
  • string
    Property Name Type Description Notes
    sensor_status <string> Values: ok, missing, unknown, failing, failed;

    Type: sensor_temperature

  • JSON
  • {
      "current_temperature": integer,
      "threshold": integer
    }
    Property Name Type Description Notes
    sensor_temperature <object> Required properties: [current_temperature, threshold];
    sensor_temperature.current_temperature <integer> Current temperature in celsius
    sensor_temperature.threshold <integer> Threshold temperature in celsius

    Type: storage_unit_controller

  • JSON
  • {
      "name": string,
      "status": sensor_status,
      "status_msg": string,
      "temperature": sensor_temperature
    }
    Property Name Type Description Notes
    storage_unit_controller <object> Required properties: [status, name, status_msg, temperature];
    storage_unit_controller.name <string>
    storage_unit_controller.status <sensor_status> Values: ok, missing, unknown, failing, failed;
    storage_unit_controller.status_msg <string>
    storage_unit_controller.temperature <sensor_temperature>

    Type: system_fan

  • JSON
  • {
      "fan_speed": rpm,
      "name": string,
      "status": sensor_status,
      "status_msg": string
    }
    Property Name Type Description Notes
    system_fan <object> Required properties: [status, name, status_msg, fan_speed];
    system_fan.fan_speed <rpm> Revolutions per minute
    system_fan.name <string>
    system_fan.status <sensor_status> Values: ok, missing, unknown, failing, failed;
    system_fan.status_msg <string>

    Type: volume_status

  • JSON
  • string
    Property Name Type Description Notes
    volume_status <string> Values: ok, degraded, rebuilding, uninitialized, failed, missing, invalid;