| Field |
Required |
Accessor |
Description |
|
name
|
|
— |
Name
|
|
device
|
|
name |
Assigned role
|
|
status
|
|
— |
Status
| Import Value |
Label |
| active |
Active |
| planned |
Planned |
| offline |
Offline |
|
|
tenant
|
—
|
name |
Assigned tenant
|
|
identifier
|
—
|
— |
Numeric identifier unique to the parent device
|
|
comments
|
—
|
— |
Comments
|
|
primary_ip4
|
—
|
address |
IPv4 address with mask, e.g. 1.2.3.4/24
|
|
primary_ip6
|
—
|
address |
IPv6 address with prefix length, e.g. 2001:db8::1/64
|
|
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.