| Field |
Required |
Accessor |
Description |
|
device
|
|
name |
The device in which this module is installed
|
|
module_bay
|
|
name |
The module bay in which this module is installed
|
|
module_type
|
|
model |
The type of module
|
|
status
|
|
— |
Operational status
| Import Value |
Label |
| offline |
Offline |
| active |
Active |
| planned |
Planned |
| staged |
Staged |
| failed |
Failed |
| decommissioning |
Decommissioning |
|
|
serial
|
—
|
— |
Serial number
|
|
asset_tag
|
—
|
— |
A unique tag used to identify this device
|
|
description
|
—
|
— |
Description
|
|
comments
|
—
|
— |
Comments
|
|
replicate_components
|
—
|
— |
Automatically populate components associated with this module type (enabled by default)
Specify true or false
|
|
adopt_components
|
—
|
— |
Adopt already existing components
Specify true or false
|
|
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.