Field |
Required |
Accessor |
Description |
device
|
|
name |
Device
|
name
|
|
— |
Name
|
type
|
|
— |
Physical medium
Import Value |
Label |
virtual |
Virtual |
bridge |
Bridge |
lag |
Link Aggregation Group (LAG) |
100base-fx |
100BASE-FX (10/100ME FIBER) |
100base-lfx |
100BASE-LFX (10/100ME FIBER) |
100base-tx |
100BASE-TX (10/100ME) |
100base-t1 |
100BASE-T1 (10/100ME Single Pair) |
1000base-t |
1000BASE-T (1GE) |
1000base-lx |
1000BASE-LX (1GE) |
1000base-tx |
1000BASE-TX (1GE) |
2.5gbase-t |
2.5GBASE-T (2.5GE) |
5gbase-t |
5GBASE-T (5GE) |
10gbase-t |
10GBASE-T (10GE) |
10gbase-cx4 |
10GBASE-CX4 (10GE) |
100base-x-sfp |
SFP (100ME) |
1000base-x-gbic |
GBIC (1GE) |
1000base-x-sfp |
SFP (1GE) |
10gbase-x-sfpp |
SFP+ (10GE) |
10gbase-x-xfp |
XFP (10GE) |
10gbase-x-xenpak |
XENPAK (10GE) |
10gbase-x-x2 |
X2 (10GE) |
25gbase-x-sfp28 |
SFP28 (25GE) |
50gbase-x-sfp56 |
SFP56 (50GE) |
40gbase-x-qsfpp |
QSFP+ (40GE) |
50gbase-x-sfp28 |
QSFP28 (50GE) |
100gbase-x-cfp |
CFP (100GE) |
100gbase-x-cfp2 |
CFP2 (100GE) |
200gbase-x-cfp2 |
CFP2 (200GE) |
400gbase-x-cfp2 |
CFP2 (400GE) |
100gbase-x-cfp4 |
CFP4 (100GE) |
100gbase-x-cxp |
CXP (100GE) |
100gbase-x-cpak |
Cisco CPAK (100GE) |
100gbase-x-dsfp |
DSFP (100GE) |
100gbase-x-sfpdd |
SFP-DD (100GE) |
100gbase-x-qsfp28 |
QSFP28 (100GE) |
100gbase-x-qsfpdd |
QSFP-DD (100GE) |
200gbase-x-qsfp56 |
QSFP56 (200GE) |
200gbase-x-qsfpdd |
QSFP-DD (200GE) |
400gbase-x-qsfp112 |
QSFP112 (400GE) |
400gbase-x-qsfpdd |
QSFP-DD (400GE) |
400gbase-x-osfp |
OSFP (400GE) |
400gbase-x-osfp-rhs |
OSFP-RHS (400GE) |
400gbase-x-cdfp |
CDFP (400GE) |
400gbase-x-cfp8 |
CPF8 (400GE) |
800gbase-x-qsfpdd |
QSFP-DD (800GE) |
800gbase-x-osfp |
OSFP (800GE) |
1000base-kx |
1000BASE-KX (1GE) |
2.5gbase-kx |
2.5GBASE-KX (2.5GE) |
5gbase-kr |
5GBASE-KR (5GE) |
10gbase-kr |
10GBASE-KR (10GE) |
10gbase-kx4 |
10GBASE-KX4 (10GE) |
25gbase-kr |
25GBASE-KR (25GE) |
40gbase-kr4 |
40GBASE-KR4 (40GE) |
50gbase-kr |
50GBASE-KR (50GE) |
100gbase-kp4 |
100GBASE-KP4 (100GE) |
100gbase-kr2 |
100GBASE-KR2 (100GE) |
100gbase-kr4 |
100GBASE-KR4 (100GE) |
ieee802.11a |
IEEE 802.11a |
ieee802.11g |
IEEE 802.11b/g |
ieee802.11n |
IEEE 802.11n |
ieee802.11ac |
IEEE 802.11ac |
ieee802.11ad |
IEEE 802.11ad |
ieee802.11ax |
IEEE 802.11ax |
ieee802.11ay |
IEEE 802.11ay |
ieee802.11be |
IEEE 802.11be |
ieee802.15.1 |
IEEE 802.15.1 (Bluetooth) |
ieee802.15.4 |
IEEE 802.15.4 (LR-WPAN) |
other-wireless |
Other (Wireless) |
gsm |
GSM |
cdma |
CDMA |
lte |
LTE |
4g |
4G |
5g |
5G |
sonet-oc3 |
OC-3/STM-1 |
sonet-oc12 |
OC-12/STM-4 |
sonet-oc48 |
OC-48/STM-16 |
sonet-oc192 |
OC-192/STM-64 |
sonet-oc768 |
OC-768/STM-256 |
sonet-oc1920 |
OC-1920/STM-640 |
sonet-oc3840 |
OC-3840/STM-1234 |
1gfc-sfp |
SFP (1GFC) |
2gfc-sfp |
SFP (2GFC) |
4gfc-sfp |
SFP (4GFC) |
8gfc-sfpp |
SFP+ (8GFC) |
16gfc-sfpp |
SFP+ (16GFC) |
32gfc-sfp28 |
SFP28 (32GFC) |
32gfc-sfpp |
SFP+ (32GFC) |
64gfc-qsfpp |
QSFP+ (64GFC) |
64gfc-sfpdd |
SFP-DD (64GFC) |
64gfc-sfpp |
SFP+ (64GFC) |
128gfc-qsfp28 |
QSFP28 (128GFC) |
infiniband-sdr |
SDR (2 Gbps) |
infiniband-ddr |
DDR (4 Gbps) |
infiniband-qdr |
QDR (8 Gbps) |
infiniband-fdr10 |
FDR10 (10 Gbps) |
infiniband-fdr |
FDR (13.5 Gbps) |
infiniband-edr |
EDR (25 Gbps) |
infiniband-hdr |
HDR (50 Gbps) |
infiniband-ndr |
NDR (100 Gbps) |
infiniband-xdr |
XDR (250 Gbps) |
t1 |
T1 (1.544 Mbps) |
e1 |
E1 (2.048 Mbps) |
t3 |
T3 (45 Mbps) |
e3 |
E3 (34 Mbps) |
xdsl |
xDSL |
docsis |
DOCSIS |
bpon |
BPON (622 Mbps / 155 Mbps) |
epon |
EPON (1 Gbps) |
10g-epon |
10G-EPON (10 Gbps) |
gpon |
GPON (2.5 Gbps / 1.25 Gbps) |
xg-pon |
XG-PON (10 Gbps / 2.5 Gbps) |
xgs-pon |
XGS-PON (10 Gbps) |
ng-pon2 |
NG-PON2 (TWDM-PON) (4x10 Gbps) |
25g-pon |
25G-PON (25 Gbps) |
50g-pon |
50G-PON (50 Gbps) |
cisco-stackwise |
Cisco StackWise |
cisco-stackwise-plus |
Cisco StackWise Plus |
cisco-flexstack |
Cisco FlexStack |
cisco-flexstack-plus |
Cisco FlexStack Plus |
cisco-stackwise-80 |
Cisco StackWise-80 |
cisco-stackwise-160 |
Cisco StackWise-160 |
cisco-stackwise-320 |
Cisco StackWise-320 |
cisco-stackwise-480 |
Cisco StackWise-480 |
cisco-stackwise-1t |
Cisco StackWise-1T |
juniper-vcp |
Juniper VCP |
extreme-summitstack |
Extreme SummitStack |
extreme-summitstack-128 |
Extreme SummitStack-128 |
extreme-summitstack-256 |
Extreme SummitStack-256 |
extreme-summitstack-512 |
Extreme SummitStack-512 |
other |
Other |
|
label
|
—
|
— |
Physical label
|
parent
|
—
|
name |
Parent interface
|
bridge
|
—
|
name |
Bridged interface
|
lag
|
—
|
name |
Parent LAG interface
|
speed
|
—
|
— |
Speed (Kbps)
|
duplex
|
—
|
— |
Duplex
Import Value |
Label |
half |
Half |
full |
Full |
auto |
Auto |
|
enabled
|
—
|
— |
Enabled
Specify true or false
|
mark_connected
|
—
|
— |
Treat as if a cable is connected
Specify true or false
|
mac_address
|
—
|
— |
MAC address
|
wwn
|
—
|
— |
64-bit World Wide Name
|
vdcs
|
—
|
name |
VDC names separated by commas, encased with double quotes. Example: vdc1,vdc2,vdc3
|
mtu
|
—
|
— |
MTU
|
mgmt_only
|
—
|
— |
This interface is used only for out-of-band management
Specify true or false
|
description
|
—
|
— |
Description
|
poe_mode
|
—
|
— |
PoE mode
Import Value |
Label |
pd |
PD |
pse |
PSE |
|
poe_type
|
—
|
— |
PoE type
Import Value |
Label |
type1-ieee802.3af |
802.3af (Type 1) |
type2-ieee802.3at |
802.3at (Type 2) |
type3-ieee802.3bt |
802.3bt (Type 3) |
type4-ieee802.3bt |
802.3bt (Type 4) |
passive-24v-2pair |
Passive 24V (2-pair) |
passive-24v-4pair |
Passive 24V (4-pair) |
passive-48v-2pair |
Passive 48V (2-pair) |
passive-48v-4pair |
Passive 48V (4-pair) |
|
mode
|
—
|
— |
IEEE 802.1Q operational mode (for L2 interfaces)
Import Value |
Label |
access |
Access |
tagged |
Tagged |
tagged-all |
Tagged (All) |
|
vrf
|
—
|
rd |
Assigned VRF
|
rf_role
|
—
|
— |
Wireless role (AP/station)
Import Value |
Label |
ap |
Access point |
station |
Station |
|
rf_channel
|
—
|
— |
Wireless channel
|
rf_channel_frequency
|
—
|
— |
Populated by selected channel (if set)
|
rf_channel_width
|
—
|
— |
Populated by selected channel (if set)
|
tx_power
|
—
|
— |
Transmit power (dBm)
|
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.