Conch::Controller::Device

SOURCE

https://github.com/joyent/conch-api/blob/master/lib/Conch/Controller/Device.pm

METHODS

find_device

Chainable action that uses the device_id, device_serial_number or device_id_or_serial_number provided in the stash (usually via the request URL) to look up a device, and stashes the query to get to it in device_rs.

If require_role is provided in the stash, it is used as the minimum required role for the user to continue; otherwise the HTTP method is used to determine its value (HEAD and GET imply read-only, POST, PUT and DELETE imply read/write); or the user must be a registered relay user or a system admin.

If phase_earlier_than is provided in the stash, 409 Conflict is returned if the device is in the provided phase (or later).

get

Retrieves details about a single device. Response uses the DetailedDevice json schema.

Note: The results of this endpoint can be cached, but since the checksum is based only on the device’s last updated time, and not on any other components associated with it (disks, network interfaces, location etc) it is only suitable for using to determine if a subsequent device report has been submitted for this device (or columns directly on the device have been updated). Updates to the device through other means (such as changing its location) may not be reflected in the checksum.

lookup_by_other_attribute

Looks up one or more devices by a single query parameter (because these options are intended to match only one or a very few device(s)). Supports:

/device?hostname=$hostname
/device?mac=$macaddr
/device?ipaddr=$ipaddr
/device?link=$link
/device?$setting_key=$setting_value

Response uses the Devices json schema.

get_pxe

Gets PXE-specific information about a device.

Response uses the DevicePXE json schema.

set_asset_tag

Sets the asset_tag field on a device

set_validated

Sets the validated field on a device unless that field has already been set

get_phase

Gets just the device’s phase. Response uses the DevicePhase json schema.

get_sku

Gets just the device’s hardware_product_id and sku. Response uses the DeviceSku json schema.

set_phase

add_links

Appends the provided link(s) to the device record.

remove_links

When a payload is specified, remove specified links from the device record; with a null payload, removes all links.

set_build

Moves the device to a new build.

Also requires read/write access to the old and new builds.

set_hardware_product

Changes the hardware product (sku) assigned to the device.

Requires admin access to the device.

LICENSING

This Source Code Form is subject to the terms of the Mozilla Public License, v.2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://www.mozilla.org/en-US/MPL/2.0/.