| Field |
Required |
Accessor |
Description |
|
name
|
|
— |
Name
|
|
type
|
|
name |
Type of cluster
|
|
status
|
|
— |
Operational status
| Import Value |
Label |
| planned |
Planned |
| staging |
Staging |
| active |
Active |
| decommissioning |
Decommissioning |
| offline |
Offline |
|
|
group
|
—
|
name |
Assigned cluster group
|
|
scope_type
|
—
|
— |
Scope type (app & model)
| Import Value |
Label |
| dcim.location |
DCIM | location |
| dcim.region |
DCIM | region |
| dcim.site |
DCIM | site |
| dcim.sitegroup |
DCIM | site group |
|
|
scope_id
|
—
|
— |
Scope ID
|
|
tenant
|
—
|
name |
Assigned tenant
|
|
description
|
—
|
— |
Description
|
|
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)
|
|
site
|
—
|
name |
Assigned site
|
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.