netbox-community-netbox/docs/models/dcim/cable.md

# Cables

All connections between device components in NetBox are represented using cables. A cable represents a direct physical connection between two sets of endpoints (A and B), such as a console port and a patch panel port, or between two network interfaces. Cables may be connected to the following objects:

* Network interfaces
* Console ports
* Console server ports
* Pass-through ports (front and rear)
* Circuit terminations
* Power ports
* Power outlets
* Power feeds

## Fields

### Status

The cable's operational status. Choices include:

* Active (default)
* Planned
* Decommissioning

### Type

The cable's physical medium or classification.

### Label

An arbitrary label used to identify the cable.

### Color

The color of the cable.

### Length

The numeric length of the cable, including a unit designation (e.g. 100 meters or 25 feet).

## Tracing Cables

A cable may be traced from any of its endpoints by clicking the "trace" button. (A REST API endpoint also provides this functionality.) NetBox will follow the path of connected cables from this termination across the directly connected cable to the far-end termination. If the cable connects to a pass-through port, and the peer port has another cable connected, NetBox will continue following the cable path until it encounters a non-pass-through or unconnected termination point. The entire path will be displayed to the user.
Refactor device docs 2020-03-05 11:05:48 -05:00			`# Cables`

Finish refreshing DCIM models documentation 2022-08-15 15:16:02 -04:00			`All connections between device components in NetBox are represented using cables. A cable represents a direct physical connection between two sets of endpoints (A and B), such as a console port and a patch panel port, or between two network interfaces. Cables may be connected to the following objects:`
Refactor device docs 2020-03-05 11:05:48 -05:00
Finish refreshing DCIM models documentation 2022-08-15 15:16:02 -04:00			`* Network interfaces`
Updated cable documentation 2020-07-28 09:48:55 -04:00			`* Console ports`
			`* Console server ports`
			`* Pass-through ports (front and rear)`
Finish refreshing DCIM models documentation 2022-08-15 15:16:02 -04:00			`* Circuit terminations`
Updated cable documentation 2020-07-28 09:48:55 -04:00			`* Power ports`
Finish refreshing DCIM models documentation 2022-08-15 15:16:02 -04:00			`* Power outlets`
			`* Power feeds`

			`## Fields`

			`### Status`
Refactor device docs 2020-03-05 11:05:48 -05:00
Finish refreshing DCIM models documentation 2022-08-15 15:16:02 -04:00			`The cable's operational status. Choices include:`
Refactor device docs 2020-03-05 11:05:48 -05:00
Updated cable documentation 2020-07-28 09:48:55 -04:00			`* Active (default)`
			`* Planned`
			`* Decommissioning`

Finish refreshing DCIM models documentation 2022-08-15 15:16:02 -04:00			`### Type`

			`The cable's physical medium or classification.`

			`### Label`

			`An arbitrary label used to identify the cable.`

			`### Color`

			`The color of the cable.`

			`### Length`

			`The numeric length of the cable, including a unit designation (e.g. 100 meters or 25 feet).`

Updated cable documentation 2020-07-28 09:48:55 -04:00			`## Tracing Cables`

Finish refreshing DCIM models documentation 2022-08-15 15:16:02 -04:00			A cable may be traced from any of its endpoints by clicking the "trace" button. (A REST API endpoint also provides this functionality.) NetBox will follow the path of connected cables from this termination across the directly connected cable to the far-end termination. If the cable connects to a pass-through port, and the peer port has another cable connected, NetBox will continue following the cable path until it encounters a non-pass-through or unconnected termination point. The entire path will be displayed to the user.