Parcourir la source

Updated circuits documentation

Jeremy Stretch il y a 8 ans
Parent
commit
73ae87aa57
1 fichiers modifiés avec 13 ajouts et 12 suppressions
  1. 13 12
      docs/data-model/circuits.md

+ 13 - 12
docs/data-model/circuits.md

@@ -4,29 +4,30 @@ The circuits component of NetBox deals with the management of long-haul Internet
 
 
 A provider is any entity which provides some form of connectivity. This obviously includes carriers which offer Internet and private transit service. However, it might also include Internet exchange (IX) points and even organizations with whom you peer directly.
 A provider is any entity which provides some form of connectivity. This obviously includes carriers which offer Internet and private transit service. However, it might also include Internet exchange (IX) points and even organizations with whom you peer directly.
 
 
-Each provider may be assigned an autonomous system number (ASN) for reference. Each provider can also be assigned account and contact information, as well as miscellaneous comments.
+Each provider may be assigned an autonomous system number (ASN), an account number, and contact information.
 
 
 ---
 ---
 
 
 # Circuits
 # Circuits
 
 
-A circuit represents a single physical data link connecting two endpoints. Each circuit belongs to a provider and must be assigned circuit ID which is unique to that provider. Each circuit must also be assigned to a site, and may optionally be connected to a specific interface on a specific device within that site.
-
-NetBox also tracks miscellaneous circuit attributes (most of which are optional), including:
-
-* Date of installation
-* Port speed
-* Commit rate
-* Cross-connect ID
-* Patch panel information
+A circuit represents a single physical data link connecting two endpoints. Each circuit belongs to a provider and must be assigned a circuit ID which is unique to that provider.
 
 
 ### Circuit Types
 ### Circuit Types
 
 
-Circuits can be classified by type. For example:
+Circuits are classified by type. For example:
 
 
 * Internet transit
 * Internet transit
 * Out-of-band connectivity
 * Out-of-band connectivity
 * Peering
 * Peering
 * Private backhaul
 * Private backhaul
 
 
-Each circuit must be assigned exactly one circuit type.
+Circuit types are fully customizable.
+
+### Circuit Terminations
+
+A circuit may have one or two terminations, annotated as the "A" and "Z" sides of the circuit. A single-termination circuit can be used when you don't know (or care) about the far end of a circuit (for example, an Internet access circuit which connects to a transit provider). A dual-termination circuit is useful for tracking circuits which connect two sites.
+
+Each circuit termination can be tied to a site, or to a specific device and interface within that site. Each termination can be assigned a separate downstream and upstream speed independent from one another. Fields are also available to track cross-connect and patch panel details.
+
+!!! note
+    A circuit represents a physical link, and cannot have more than two endpoints. When modeling a multi-point topology, each leg of the topology must be defined as a discrete circuit.