Console Ports

console-ports

Console Port interfaces provide connectivity to the physical console of a device. These are typically used for temporary access by someone who is physically near the device, or for remote out-of-band access provided via a networked console server.

Head on over to the NetBox Documentation if you would like to read more about Console Ports.

---

Required Keys

• name: (String) Port Name
• type: (String) Value is the Port type slug - API value from NetBox, see Value Options for the available key values

Optional Keys

• label: (String) Label

Value Options

• Key: type
• Value:
  • de-9
  • db-25
  • rj-11
  • rj-12
  • rj-45
  • mini-din-8
  • usb-a
  • usb-b
  • usb-c
  • usb-mini-a
  • usb-mini-b
  • usb-micro-a
  • usb-micro-b
  • usb-micro-ab
  • other

⚠️ other is a reserved type that should sparingly be used. If a port type does not exist, please create an issue.

Valid Example

console-ports:
  - name: Console
    label: RJ-45 Console
    type: rj-45
  - name: USB
    label: USB Console
    type: usb-mini-b