Spare Items

Public Preview: Asset Lifecycle is in public preview. The functionality and API surface may evolve in future releases.

A spare item represents one or more units of a specific type and variant assigned to a spares pool. Items in a pool can be drawn upon to fulfill BOM objects without issuing a new purchase order.

An item whose quantity is greater than one may not carry a serial number or asset tag, since those identifiers apply to a single physical unit.

Fields

Pool

The spares pool to which this item belongs.

Item Type

The content type of the referenced item. One of rack type, device type, module type, or cable type.

Item ID

The primary key of the referenced item within its type.

Variant

An optional JSON object of attributes that distinguish this item from others of the same type. The tracked attributes match those used on BOM line items: airflow direction for devices and modules; color, length, and length unit for cables; racks have no variant attributes.

Quantity

The number of units represented by this record. Must be at least 1. Quantities greater than 1 are permitted only for items without a serial number or asset tag.

Status

The item's operational status. One of:

• Serviceable (default) - In working order and available to draw on.
• Damaged - Present but unfit for use; flagged for repair or disposal.
• Missing - Recorded but cannot currently be located.

Serial Number

The serial number assigned by the manufacturer. Optional. When specified, the combination of item type, item ID, and serial number must be unique.

Asset Tag

A locally-administered label used to identify the item. Optional. Must be unique across all spare items.