Field |
Required |
Accessor |
Description |
device
|
|
name |
Device
|
name
|
|
— |
Name
|
label
|
—
|
— |
Physical label
|
type
|
—
|
— |
Port type
Import Value |
Label |
de-9 |
DE-9 |
db-25 |
DB-25 |
rj-11 |
RJ-11 |
rj-12 |
RJ-12 |
rj-45 |
RJ-45 |
mini-din-8 |
Mini-DIN 8 |
usb-a |
USB Type A |
usb-b |
USB Type B |
usb-c |
USB Type C |
usb-mini-a |
USB Mini A |
usb-mini-b |
USB Mini B |
usb-micro-a |
USB Micro A |
usb-micro-b |
USB Micro B |
usb-micro-ab |
USB Micro AB |
other |
Other |
|
speed
|
—
|
— |
Port speed in bps
Import Value |
Label |
1200 |
1200 bps |
2400 |
2400 bps |
4800 |
4800 bps |
9600 |
9600 bps |
19200 |
19.2 kbps |
38400 |
38.4 kbps |
57600 |
57.6 kbps |
115200 |
115.2 kbps |
|
mark_connected
|
—
|
— |
Treat as if a cable is connected
Specify true or false
|
description
|
—
|
— |
Description
|
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.