Field |
Required |
Accessor |
Description |
role
|
|
name |
Assigned role
|
manufacturer
|
|
name |
Device type manufacturer
|
device_type
|
|
model |
Device type model
|
status
|
|
— |
Operational status
Import Value |
Label |
offline |
Offline |
active |
Active |
planned |
Planned |
staged |
Staged |
failed |
Failed |
inventory |
Inventory |
decommissioning |
Decommissioning |
|
site
|
|
name |
Assigned site
|
name
|
—
|
— |
Name
|
tenant
|
—
|
name |
Assigned tenant
|
platform
|
—
|
name |
Assigned platform
|
serial
|
—
|
— |
Chassis serial number, assigned by the manufacturer
|
asset_tag
|
—
|
— |
A unique tag used to identify this device
|
location
|
—
|
name |
Assigned location (if any)
|
rack
|
—
|
name |
Assigned rack (if any)
|
position
|
—
|
— |
The lowest-numbered unit occupied by the device
|
face
|
—
|
— |
Mounted rack face
Import Value |
Label |
front |
Front |
rear |
Rear |
|
latitude
|
—
|
— |
GPS coordinate in decimal format (xx.yyyyyy)
|
longitude
|
—
|
— |
GPS coordinate in decimal format (xx.yyyyyy)
|
parent
|
—
|
name |
Parent device (for child devices)
|
device_bay
|
—
|
name |
Device bay in which this device is installed (for child devices)
|
airflow
|
—
|
— |
Airflow direction
Import Value |
Label |
front-to-rear |
Front to rear |
rear-to-front |
Rear to front |
left-to-right |
Left to right |
right-to-left |
Right to left |
side-to-rear |
Side to rear |
rear-to-side |
Rear to side |
bottom-to-top |
Bottom to top |
top-to-bottom |
Top to bottom |
passive |
Passive |
mixed |
Mixed |
|
virtual_chassis
|
—
|
name |
Virtual chassis
|
vc_position
|
—
|
— |
Virtual chassis position
|
vc_priority
|
—
|
— |
Virtual chassis master election priority
|
cluster
|
—
|
name |
Virtualization cluster
|
description
|
—
|
— |
Description
|
config_template
|
—
|
name |
Config template
|
comments
|
—
|
— |
Comments
|
tags
|
—
|
slug |
Tag slugs separated by commas, encased with double quotes (e.g. "tag1,tag2,tag3")
|
id
|
—
|
— |
Numeric ID of an existing object to update (if not creating a new object)
|
Required fields must be specified for all objects.
Related objects may be referenced by any unique attribute. For example, vrf.rd
would identify a VRF by its route distinguisher.