| Field |
Required |
Accessor |
Description |
|
prefix
|
|
— |
IPv4 or IPv6 network with mask
|
|
status
|
|
— |
Operational status
| Import Value |
Label |
| container |
Container |
| active |
Active |
| reserved |
Reserved |
| deprecated |
Deprecated |
|
|
vrf
|
—
|
name |
Assigned VRF
|
|
tenant
|
—
|
name |
Assigned tenant
|
|
vlan_group
|
—
|
name |
VLAN's group (if any)
|
|
vlan_site
|
—
|
name |
VLAN's site (if any)
|
|
vlan
|
—
|
vid |
Assigned VLAN
|
|
role
|
—
|
name |
Functional role
|
|
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
|
|
is_pool
|
—
|
— |
All IP addresses within this prefix are considered usable
Specify true or false
|
|
mark_utilized
|
—
|
— |
Treat as fully utilized
Specify true or false
|
|
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)
|
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.