| Field |
Required |
Accessor |
Description |
|
address
|
|
— |
IPv4 or IPv6 address (with mask)
|
|
status
|
|
— |
Operational status
| Import Value |
Label |
| active |
Active |
| reserved |
Reserved |
| deprecated |
Deprecated |
| dhcp |
DHCP |
| slaac |
SLAAC |
|
|
vrf
|
—
|
name |
Assigned VRF
|
|
tenant
|
—
|
name |
Assigned tenant
|
|
role
|
—
|
— |
Functional role
| Import Value |
Label |
| loopback |
Loopback |
| secondary |
Secondary |
| anycast |
Anycast |
| vip |
VIP |
| vrrp |
VRRP |
| hsrp |
HSRP |
| glbp |
GLBP |
| carp |
CARP |
|
|
device
|
—
|
name |
Parent device of assigned interface (if any)
|
|
virtual_machine
|
—
|
name |
Parent VM of assigned interface (if any)
|
|
interface
|
—
|
name |
Assigned interface
|
|
is_primary
|
—
|
— |
Make this the primary IP for the assigned device
Specify true or false
|
|
is_oob
|
—
|
— |
Designate this as the out-of-band IP address for the assigned device
Specify true or false
|
|
dns_name
|
—
|
— |
Hostname or FQDN (not case-sensitive)
|
|
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.