Documentation

User Tools

Site Tools

Trace:
extensions:teemip-cable-mgmt

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
extensions:teemip-cable-mgmt [2025/05/07 12:50] – [Implementation Scenario] cnaudextensions:teemip-cable-mgmt [2025/05/07 16:35] (current) – [Revision History] cnaud
Line 32: Line 32:
 ===== Revision History ===== ===== Revision History =====
 ^  Version  ^  Release Date  ^  Status  ^  iTop \\ Min  ^  IPAM for iTop \\ Min  ^  Comments  ^ ^  Version  ^  Release Date  ^  Status  ^  iTop \\ Min  ^  IPAM for iTop \\ Min  ^  Comments  ^
-|  1.4.0  |  2025-xx-yy  |  WIP  |  3.2.0  |  3.2.0  | - A Cable Category may be set on a Patch Panel \\ - The creation of Back End Network Cables from a Patch Panel may be limited to a given number \\ - A Cable Category may be set on a Network Socket \\ - Organization of a Network Socket is the one of its Patch Panel (if set) or its Location otherwise \\ - A Back End Network Cable may be attached to a Breakout Cable \\ - Cable names can be automatically computed from a method that may be overloaded \\ - Replace legacy CRUD methods by new CRUD events |+|  1.4.0  |  2025-xx-yy  |  WIP  |  3.2.0  |  3.2.0  | - A Cable Category may be set on a Patch Panel and on a Network Socket\\ - The creation of Back End Network Cables from a Patch Panel may be limited to a given number \\ - The organization of a Network Socket is the one of its Patch Panel (if set) or its Location otherwise \\ - A Back End Network Cable may be attached to a Breakout Cable \\ - Local and peer device and physical interface attributes have been added to Cross Connects \\ - Cables that make the path of a Cross Connect are displayed in a tab \\ - Sockets that make the Cross Connect are automatically set or reset with a pointer to the Cross Connect they belong to \\ - Once in production, all device and front end cables of a Cross Connect may be created \\ - Cable names can be automatically computed from a method that may be overloaded \\ - Replace legacy CRUD methods by new CRUD events |
 |  **1.3.1**  |  2024-10-29  |  Supported  |  3.1.2  |  3.2.0  | - Issue [[https://github.com/TeemIp/teemip-cable-mgmt/issues/6|#6]] - Can't create second direct cable connection between two devices  \\ - Breakout Cable: edit the n:n relations with PatchPanels while on display and not on edition anymore \\ - Breakout Vable: improve automation functions | |  **1.3.1**  |  2024-10-29  |  Supported  |  3.1.2  |  3.2.0  | - Issue [[https://github.com/TeemIp/teemip-cable-mgmt/issues/6|#6]] - Can't create second direct cable connection between two devices  \\ - Breakout Cable: edit the n:n relations with PatchPanels while on display and not on edition anymore \\ - Breakout Vable: improve automation functions |
 |  1.3.0  |  2024-06-26  |  Obsolete  |  3.1.1  |  3.1.4  | - A Patch Panel can be mounted in an enclosure \\ - Network Sockets can be automatically created for a given Patch Panel \\ - Back End Cables can be automatically created between the sockets of 2 Patch Panels \\ - Number of free & ready Network Sockets in Patch Panels are displayed \\ - Cross Connects and Breakout Cables are now modelized \\ - Wiring paths can be proposed to connect the 2 Patch Panels of a Cross Connect \\ - Documents can be attached to Network Cables | |  1.3.0  |  2024-06-26  |  Obsolete  |  3.1.1  |  3.1.4  | - A Patch Panel can be mounted in an enclosure \\ - Network Sockets can be automatically created for a given Patch Panel \\ - Back End Cables can be automatically created between the sockets of 2 Patch Panels \\ - Number of free & ready Network Sockets in Patch Panels are displayed \\ - Cross Connects and Breakout Cables are now modelized \\ - Wiring paths can be proposed to connect the 2 Patch Panels of a Cross Connect \\ - Documents can be attached to Network Cables |
Line 42: Line 42:
 TeemIp cable management allows you to document the cable layouts of your organization. Connect physical interfaces to wall mounted network sockets, to patch panels hosted in racks or to other physical interfaces, document your patch cables and your underlying cabling layout, manage your cross connects: the extension enables a large scope of connection scenarios as the following drawing highlights: TeemIp cable management allows you to document the cable layouts of your organization. Connect physical interfaces to wall mounted network sockets, to patch panels hosted in racks or to other physical interfaces, document your patch cables and your underlying cabling layout, manage your cross connects: the extension enables a large scope of connection scenarios as the following drawing highlights:
  
-{{ cabling_scenarios.png }}+{{ cabling_scenarios.png ?nolink }}
  
 Furthermore, the extension displays the wiring that links devices, physical interfaces and network sockets together, like: Furthermore, the extension displays the wiring that links devices, physical interfaces and network sockets together, like:
  
-{{ cabling_wiring3.png }}+{{ cabling_wiring3.png ?nolink }}
  
 Note that the drawing has been manually rearranged. Note that the drawing has been manually rearranged.
Line 85: Line 85:
 Under the **Other Settings** fieldset, the **Allow cabling toward another organizations** parameter enables patch panels from a given organization to be connected to patch panels of other organizations. Under the **Other Settings** fieldset, the **Allow cabling toward another organizations** parameter enables patch panels from a given organization to be connected to patch panels of other organizations.
  
-{{ cabling_ipsettings.png }}+{{ cabling_ipsettings.png ?nolink }}
 ===== Implementation Scenario ===== ===== Implementation Scenario =====
 This section provides, as an example, a method that can be followed to implement TeemIp Cable Management. This section provides, as an example, a method that can be followed to implement TeemIp Cable Management.
Line 263: Line 263:
 | Primary Network socket | Foreign key to a(n) Network Socket | No | | Primary Network socket | Foreign key to a(n) Network Socket | No |
 | Secondary Network socket | Foreign key to a(n) Network Socket | No | | Secondary Network socket | Foreign key to a(n) Network Socket | No |
 +| Device | Foreign key to a(n) Connectable CI | No |
 +| Physical interface | Foreign key to a(n) Physical interface | No |
 | **Peer Unit Information** ||| | **Peer Unit Information** |||
-| Location | Foreign key to a(n) Location of Peer Organization | Yes | +| Peer location | Foreign key to a(n) Location of Peer Organization | Yes | 
-| Rack | Foreign key to a(n) Rack | Yes | +| Peer rack | Foreign key to a(n) Rack | Yes | 
-| Patch panel | Foreign key to a(n) Patch Panel  | Yes | +| Peer patch panel | Foreign key to a(n) Patch Panel  | Yes | 
-| Primary Network socket | Foreign key to a(n) Network Socket | No | +| Peer primary Network socket | Foreign key to a(n) Network Socket | No | 
-| Secondary Network socket | Foreign key to a(n) Network Socket | No | +| Peer secondary Network socket | Foreign key to a(n) Network Socket | No | 
-| **Back End Information** ||| +| Peer device | Foreign key to a(n) Connectable CI | No | 
-| Back end network socket | Foreign key to a(n) Network Socket | No |+| Peer physical interface | Foreign key to a(n) Physical interface | No |
  
 === Tabs === === Tabs ===
Line 276: Line 278:
 | Contacts | All the contacts for the Cross Connect | | Contacts | All the contacts for the Cross Connect |
 | Documents | All the documents linked to the Cross Connect | | Documents | All the documents linked to the Cross Connect |
 +| Active tickets | All the non closed tickets related to the Cross Connect |
 | Wiring | Wiring diagram | | Wiring | Wiring diagram |
 +| Cables | All the cables that make the Cross Connect |
  
  
Line 282: Line 286:
 In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Cross Connect dashlet, click on it and select the item you are interested in : In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Cross Connect dashlet, click on it and select the item you are interested in :
  
-{{ classdisplay_crossconnect.png }}+{{ classdisplay_crossconnect.png ?nolink }} 
 + 
 +<note tip> 
 +  * When the Cross Connect moves to production state: 
 +    * The cables that make the path between the local and peer end are listed in the **Cables** tab. 
 +    * All the network sockets along the path are set with a pointer to the cross connect 
 +  * When the Cross Connect exits the production state: 
 +    * The **Cables** tab is not displayed anymore. 
 +    * The pointer to the cross connect is reset on all the network sockets along the path 
 +</note>
  
 === Finding Wiring Paths === === Finding Wiring Paths ===
 A cross connect documents a link between one or two network socket hosted in a patch panel sitting in a rack of a given organization and one or two peer network socket hosted in a peer patch panel sitting in a peer rak of a peer organization. The **Find wiring paths** action will display all the available cabling paths that may be establish to connect 2 network sockets that answer to the previous conditions. A cross connect documents a link between one or two network socket hosted in a patch panel sitting in a rack of a given organization and one or two peer network socket hosted in a peer patch panel sitting in a peer rak of a peer organization. The **Find wiring paths** action will display all the available cabling paths that may be establish to connect 2 network sockets that answer to the previous conditions.
  
-{{ classdisplay_crossconnect_find_path.png }}+{{ classdisplay_crossconnect_find_path.png ?nolink }}
  
 Network admin may select one of the offered path and manually create it within TeemIP. Network admin may select one of the offered path and manually create it within TeemIP.
Line 298: Line 311:
 These value can be overwritten through the configuration file, as described [[extensions:teemip-cable-mgmt#configuration_file|here]]. These value can be overwritten through the configuration file, as described [[extensions:teemip-cable-mgmt#configuration_file|here]].
 </note> </note>
 +
 +
 +=== Create Cables ===
 +Once the status of the Cross Connect is set to **Production**, an action available from the Other Actions menu offers to automatically create all the Device and Front End Cables that make the Cross Connect path. However, should it be required, the deletion of these cables remains a manual operation.
 ===== Physical Interface ===== ===== Physical Interface =====
 {{icons8-globe-wire.png  }}  {{icons8-globe-wire.png  }} 
Line 320: Line 337:
 A connection between a physical interface and a network socket will look as follows. A connection between a physical interface and a network socket will look as follows.
  
-{{ classdisplay_networksocket_to_physicalinterface.png }} +{{ classdisplay_networksocket_to_physicalinterface.png ?nolink }} 
-{{ classdisplay_physicalinterface_to_networksocket.png }}+{{ classdisplay_physicalinterface_to_networksocket.png ?nolink }}
  
  
 A connection between two physical interfaces will look as follows. A connection between two physical interfaces will look as follows.
  
-{{ classdisplay_physicalinterface_to_physicalinterface.png }}+{{ classdisplay_physicalinterface_to_physicalinterface.png ?nolink }}
  
 ===== Front End Network Cable ===== ===== Front End Network Cable =====
Line 343: Line 360:
 | Network socket #1 - Front end | Foreign key to a(n) Network Socket | Yes | | Network socket #1 - Front end | Foreign key to a(n) Network Socket | Yes |
 | Network socket #2 - Front end | Foreign key to a(n) Network Socket | Yes |Friendly name of a network cable is automatically computed as the concatenation of the 2 network socket names. | Network socket #2 - Front end | Foreign key to a(n) Network Socket | Yes |Friendly name of a network cable is automatically computed as the concatenation of the 2 network socket names.
- 
-Friendly name of a front end network cable is automatically computed as the concatenation of the two network sockets' name. 
  
 === Tabs === === Tabs ===
 ^  Tab  ^  Description  ^ ^  Tab  ^  Description  ^
 | Documents | All documents linked to the front end network cable | | Documents | All documents linked to the front end network cable |
 +
 +<note tip>
 +  * The friendly name of a front end network cable is automatically computed as the concatenation of the two network sockets' name.
 +  * Its label may be automatically computed through the method SetLabel that can be overloaded.
 +</note>
  
 <note warning> <note warning>
Line 360: Line 380:
 In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Front End Network Cable dashlet, click on it and select the item you are interested in or select it directly from the Patch Panel or Network Socket detailed displays : In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Front End Network Cable dashlet, click on it and select the item you are interested in or select it directly from the Patch Panel or Network Socket detailed displays :
  
-{{ classdisplay_frontendnetworkcable.png }}+{{ classdisplay_frontendnetworkcable.png ?nolink }}
  
 ===== Back End Network Cable ===== ===== Back End Network Cable =====
Line 377: Line 397:
 | Network socket #1 - Back end | Foreign key to a(n) Network Socket | Yes | | Network socket #1 - Back end | Foreign key to a(n) Network Socket | Yes |
 | Network socket #2 - Back end | Foreign key to a(n) Network Socket | Yes |Friendly name of a network cable is automatically computed as the concatenation of the 2 network socket names. | Network socket #2 - Back end | Foreign key to a(n) Network Socket | Yes |Friendly name of a network cable is automatically computed as the concatenation of the 2 network socket names.
- +| **Membership** ||| 
-Friendly name of a back end network cable is automatically computed as the concatenation of the two network sockets' name.+| Breakout cable | Foreign key to a(n)Breakout Cable | No |
  
 === Tabs === === Tabs ===
 ^  Tab  ^  Description  ^ ^  Tab  ^  Description  ^
 | Documents | All documents linked to the back end network cable | | Documents | All documents linked to the back end network cable |
 +
 +<note tip>
 +  * The friendly name of a back end network cable is automatically computed as the concatenation of the two network sockets' name.
 +  * Its label may be automatically computed through the method SetLabel that can be overloaded.
 +  * A back end network cable may belong to a breakout cable 
 +</note>
  
 <note warning> <note warning>
Line 394: Line 420:
 In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Back End Network Cable dashlet, click on it and select the item you are interested in or select it directly from the Patch Panel or Network Socket detailed displays : In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Back End Network Cable dashlet, click on it and select the item you are interested in or select it directly from the Patch Panel or Network Socket detailed displays :
  
-{{ classdisplay_backendnetworkcable.png }}+{{ classdisplay_backendnetworkcable.png ?nolink }}
  
 ===== Device Network Cable ===== ===== Device Network Cable =====
Line 413: Line 439:
 | Physical interface | Foreign key to a(n) PhysicalInterface | No | | Physical interface | Foreign key to a(n) PhysicalInterface | No |
  
-Friendly name of a device network cable is automatically computed as the concatenation of the network socket's name and the interface's name. 
  
 === Tabs === === Tabs ===
 ^  Tab  ^  Description  ^ ^  Tab  ^  Description  ^
 | Documents | All documents linked to the device network cable | | Documents | All documents linked to the device network cable |
 +
 +<note tip>
 +  * The friendly name of a device network cable is automatically computed as the concatenation of the network socket's name and the interface's name.
 +  * Its label may be automatically computed through the method SetLabel that can be overloaded.
 +</note>
  
 <note warning> <note warning>
Line 428: Line 458:
 In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Device Network Cable dashlet, click on it and select the item you are interested in or select it directly from the Patch Panel or Network Socket detailed displays : In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Device Network Cable dashlet, click on it and select the item you are interested in or select it directly from the Patch Panel or Network Socket detailed displays :
  
-{{ classdisplay_devicenetworkcable.png }}+{{ classdisplay_devicenetworkcable.png ?nolink }}
  
 ===== Direct Network Cable ===== ===== Direct Network Cable =====
Line 447: Line 477:
 | Device #2 | Foreign key to a(n) ConnectableCI | Yes | | Device #2 | Foreign key to a(n) ConnectableCI | Yes |
 | Physical interface #2 | Foreign key to a(n) PhysicalInterface | Yes | | Physical interface #2 | Foreign key to a(n) PhysicalInterface | Yes |
- 
-Friendly name of a device network cable is automatically computed as the concatenation of the two interface's name. 
  
 === Tabs === === Tabs ===
 ^  Tab  ^  Description  ^ ^  Tab  ^  Description  ^
 | Documents | All documents linked to the direct network cable | | Documents | All documents linked to the direct network cable |
 +
 +<note tip>
 +  * The friendly name of a device network cable is automatically computed as the concatenation of the two interface's name.
 +  * Its label may be automatically computed through the method SetLabel that can be overloaded.
 +</note>
  
 <note warning> <note warning>
Line 463: Line 496:
 In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Direct Network Cable dashlet, click on it and select the item you are interested in or select it directly from the interace's display : In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Direct Network Cable dashlet, click on it and select the item you are interested in or select it directly from the interace's display :
  
-{{ classdisplay_directnetworkcable.png }}+{{ classdisplay_directnetworkcable.png ?nolink }}
  
 ===== Breakout Cable ===== ===== Breakout Cable =====
Line 483: Line 516:
 | Rack #1 | Foreign key to a(n) Rack | Yes | | Rack #1 | Foreign key to a(n) Rack | Yes |
 | Rack #2 | Foreign key to a(n) Rack | Yes | | Rack #2 | Foreign key to a(n) Rack | Yes |
- 
-Friendly name of a breakout cable is automatically computed as the concatenation of the two rack's name and the cable's label. 
  
 === Tabs === === Tabs ===
Line 494: Line 525:
  
 <note tip> <note tip>
 +  * The friendly name of a breakout cable is automatically computed as the concatenation of the two rack's name and the cable's label.
 +  * Its label may be automatically computed through the method SetLabel that can be overloaded.
 +</note>
 +
 +<note important>
   * The "Free Links" attribute is read only and automatically computed by the application.   * The "Free Links" attribute is read only and automatically computed by the application.
     * Value is computed as the capacity minus the maximum of used links with a given rack.     * Value is computed as the capacity minus the maximum of used links with a given rack.
Line 499: Line 535:
     * When a relation is created, the "Used Links" attribute is initialized with the value of the patch panel's capacity.     * When a relation is created, the "Used Links" attribute is initialized with the value of the patch panel's capacity.
 </note> </note>
 +
 <note warning> <note warning>
 Proper documentation requires that each breakout cable / patch panel relation that concerns a given  rack has a counterpart with the other rack. Proper documentation requires that each breakout cable / patch panel relation that concerns a given  rack has a counterpart with the other rack.
Line 506: Line 543:
 In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Breakout Cable dashlet, click on it and select the item you are interested in or select it directly from the interace's display : In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Breakout Cable dashlet, click on it and select the item you are interested in or select it directly from the interace's display :
  
-{{ classdisplay_breakoutcable.png }}+{{ classdisplay_breakoutcable.png ?nolink }}
  
-{{ classdisplay_breakoutcable2.png }}+{{ classdisplay_breakoutcable2.png ?nolink }}
  
 ===== Wiring diagram ===== ===== Wiring diagram =====
 Once connections between Devices, Physical interfaces and Network Sockets are documented, the physical path that connects them all can be visualized through the menu "Wiring..." displayed under the "Other Actions" menu of Connectable CIs, Physical Interfaces and Network Sockets. Once connections between Devices, Physical interfaces and Network Sockets are documented, the physical path that connects them all can be visualized through the menu "Wiring..." displayed under the "Other Actions" menu of Connectable CIs, Physical Interfaces and Network Sockets.
  
-{{ classdisplay_wiring_menu.png }}+{{ classdisplay_wiring_menu.png ?nolink }}
  
 That action displays the wiring layout that connects the device it has been launch from, and all the elements that are part of the cabling path. For instance, from a backend server application : That action displays the wiring layout that connects the device it has been launch from, and all the elements that are part of the cabling path. For instance, from a backend server application :
  
-{{ cabling_wiring3.png }}+{{ cabling_wiring3.png ?nolink }}
  
 <note tip> <note tip>
Line 534: Line 571:
 The extension groups network specific typological elements in the dashlet "Network typology configuration". The extension groups network specific typological elements in the dashlet "Network typology configuration".
  
-{{ overview_group_network_typology_cable.png }}+{{ overview_group_network_typology_cable.png ?nolink }}
  
extensions/teemip-cable-mgmt.1746615032.txt.gz · Last modified: 2025/05/07 12:50 by cnaud

Page Tools