User Tools

Site Tools


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 [2024/05/16 15:43] – [Cable Management] cnaudextensions:teemip-cable-mgmt [2024/06/26 15:33] (current) – [Cable Management] cnaud
Line 7: Line 7:
 level_hidden        : 1 level_hidden        : 1
 collector_hidden    : no collector_hidden    : no
-version             : 1.2.0 +version             : 1.3.0 
-release_dt          : 2023-12-07+release_dt          : 2024-06-26
 TeemIp              : 3.1+ TeemIp              : 3.1+
 iTop                : 3.1+ iTop                : 3.1+
Line 19: Line 19:
 keyword_tags        : cmdb, cable keyword_tags        : cmdb, cable
 dependencies_s      : teemip-framework, teemip-config-mgmt-adaptor dependencies_s      : teemip-framework, teemip-config-mgmt-adaptor
-download_wiki       : [[https://sourceforge.net/projects/teemip/files/teemip%20-%20extensions/Cable%20Management/1.2.0/teemip-cable-mgmt-1.2.0-124.zip/download|teemip-cable-mgmt-1.2.0-124.zip]]+download_wiki       : [[https://sourceforge.net/projects/teemip/files/teemip%20-%20extensions/Cable%20Management/1.3.0/teemip-cable-mgmt-1.3.0-125.zip/download|teemip-cable-mgmt-1.3.0-125.zip]]
 github_wiki         : [[https://github.com/TeemIp/teemip-cable-mgmt|teemip-cable-mgmt]] github_wiki         : [[https://github.com/TeemIp/teemip-cable-mgmt|teemip-cable-mgmt]]
-php-max             : 8.1+php-max             : 8.3
 ---- ----
  
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.3.0  |  2024-0x-xx     |  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   Supported  |  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.2.0**   2023-12-07  |  Supported  |  3.1.1  |  3.1.4  | - A new Direct Cable class enables the connection between 2 physical interfaces together \\ - The direct connection of 2 CIs is visible in the wiring diagram \\ - Audit rules have been enhanced \\ - Data samples have been added \\ - Objects brought by the extension have their summary card \\ - Add Chinese (simplified) translation |+|  1.2.0  |  2023-12-07  |  Supported  |  3.1.1  |  3.1.4  | - A new Direct Cable class enables the connection between 2 physical interfaces together \\ - The direct connection of 2 CIs is visible in the wiring diagram \\ - Audit rules have been enhanced \\ - Data samples have been added \\ - Objects brought by the extension have their summary card \\ - Add Chinese (simplified) translation |
 |  1.1.0  |  2023-07-24  |  Obsolete  |  3.1.0  |  3.1.0  | - Interfaces with no connections have been removed from the wiring diagram \\ - Network cable class has been split into Backend, Frontend and Device network cable classes \\ - An audit rule identifies the cables connected to one end only \\ - Modelization of cables, sockets and interfaces have been enhanced \\ - A socket can be attached to a location or a patch panel \\ - A tab displays the list of patch panels mounted in a rack \\ - Patch panels can be handled by [[https://store.itophub.io/en_US/products/molkobain-datacenter-view-extended|Molkobain DC view extended]] | |  1.1.0  |  2023-07-24  |  Obsolete  |  3.1.0  |  3.1.0  | - Interfaces with no connections have been removed from the wiring diagram \\ - Network cable class has been split into Backend, Frontend and Device network cable classes \\ - An audit rule identifies the cables connected to one end only \\ - Modelization of cables, sockets and interfaces have been enhanced \\ - A socket can be attached to a location or a patch panel \\ - A tab displays the list of patch panels mounted in a rack \\ - Patch panels can be handled by [[https://store.itophub.io/en_US/products/molkobain-datacenter-view-extended|Molkobain DC view extended]] |
 |  1.0.0  |  2022-12-04  |  Obsolete  |  3.1.0  |  3.1.0  | - Initial revision | |  1.0.0  |  2022-12-04  |  Obsolete  |  3.1.0  |  3.1.0  | - Initial revision |
  
 ===== Features ===== ===== Features =====
-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: 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 }}
Line 81: Line 81:
    
 ==== Global IP Settings ==== ==== Global IP Settings ====
-Under the **Other Settings** fieldset, the **Allow cabling toward another organizations** parameters 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 }}
Line 94: Line 94:
 | Name | Alphanumeric string | Yes | | Name | Alphanumeric string | Yes |
 | Organization | Foreign key to a(n) Organization | Yes |  | Organization | Foreign key to a(n) Organization | Yes | 
-| Status| Possible values: Implementation, Production No |+| Status| Possible values: Implementation, Production Automatically computed |
 | Location | Foreign key to a(n) Location | Yes | | Location | Foreign key to a(n) Location | Yes |
 | Capacity | Number of network sockets that the panel can host | No | | Capacity | Number of network sockets that the panel can host | No |
 +| Free sockets | Number of network sockets still available on the panel | Automatically computed |
 +| Ready sockets | Number of network sockets with status 'ready' | Automatically computed |
 | Connector | Foreign key to a(n) Interface Connector \\ Brought by the [[extensions:teemip-network-mgmt-extended|Network Management Extended]] extension | No | | Connector | Foreign key to a(n) Interface Connector \\ Brought by the [[extensions:teemip-network-mgmt-extended|Network Management Extended]] extension | No |
 | External reference | Alphanumeric string | No | | External reference | Alphanumeric string | No |
Line 131: Line 133:
  
 === Creating network sockets === === Creating network sockets ===
-If the capacity is set, to value c for instance, TeemIP will offer to automatically create c network sockets and to attach them to the patch panel. If n network socket do already exist, with n < c, then the menu will still be displayed but only (c - n) network sockets will be created. When created, network socket will be set to inactive mode and will inherit of attributes location, rack, patch panel (obviously) and interface connector (if exists) from the patch panel.+If the capacity is set, to value c for instance, TeemIP will offer to automatically create c network sockets and to attach them to the patch panel. If n network sockets do already exist, with n < c, then the menu will still be displayed but only (c - n) network sockets will be created. When created, network socket will be set to inactive mode and will inherit of attributes location, rack, patch panel (obviously) and interface connector (if exists) from the patch panel.
  
 === Creating back end network cables === === Creating back end network cables ===
Line 145: Line 147:
 By default, the remote patch panel must belong to the same organization as the source one. This behaviour may be changed through the parameter **Allow cabling toward another organizations** of the Global IP setting of the source organization, as described [[extensions:teemip-cable-mgmt#global_ip_settings|here]]. By default, the remote patch panel must belong to the same organization as the source one. This behaviour may be changed through the parameter **Allow cabling toward another organizations** of the Global IP setting of the source organization, as described [[extensions:teemip-cable-mgmt#global_ip_settings|here]].
 </note> </note>
-===== Network Socket =====+ ===== Network Socket =====
 {{icons8-wired-network.png  }}  {{icons8-wired-network.png  }} 
 A network socket is the passive physical piece of hardware where you plug a network cable to establish a link between different network devices. A network socket is the passive physical piece of hardware where you plug a network cable to establish a link between different network devices.
Line 165: Line 167:
 | Physical interface | Foreign key to a(n) Physical Interface | No | | Physical interface | Foreign key to a(n) Physical Interface | No |
 | Network socket | Foreign key to a(n) Network Socket | No | | Network socket | Foreign key to a(n) Network Socket | No |
 +| Cross Connect | Foreign key to a(n) Cross Connect | Automatically computed |
 | **Back End Information** ||| | **Back End Information** |||
 | Back end network socket | Foreign key to a(n) Network Socket | No | | Back end network socket | Foreign key to a(n) Network Socket | No |
Line 179: Line 182:
   * When standing alone, attribute Location is mandatory but Rack and Patch panel must **NOT** be set.   * When standing alone, attribute Location is mandatory but Rack and Patch panel must **NOT** be set.
 </note> </note>
 +
 +=== Displaying a Network Socket ===
 +In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Network Socket dashlet, click on it and select the item you are interested in or select it directly from the Patch panel detailed display :
 +
 +{{ classdisplay_networksocket3x.png }}
  
 Network Sockets have 2 sides: Network Sockets have 2 sides:
Line 186: Line 194:
 <note warning> <note warning>
 A few rules are enforced at front and back ends' levels. A few rules are enforced at front and back ends' levels.
-  * On the front end side, network socket cannot be connected to both a remote network socket and a connectable CI.+  * On the front end side, 
 +    * A network socket cannot be connected to both a remote network socket and a connectable CI
 +    * A network socket may belong to a Cross Connect and may be connected to a remote network socket at the same time.
   * The front end network socket and the back end one cannot be the same.   * The front end network socket and the back end one cannot be the same.
 </note> </note>
  
-Attribute Status is read only and automatically computed:+Attribute **Status** is read only and automatically computed:
   * If no back end network socket is set, status is set to **Inactive**,   * If no back end network socket is set, status is set to **Inactive**,
   * If a back end network socket is set but if no physical interface nor network socket is set, status is set to **Ready**,    * If a back end network socket is set but if no physical interface nor network socket is set, status is set to **Ready**, 
-  * If a back end network socket is set and if a physical interface or a network socket is set, status is set to **Active**. +  * If a Cross Connect is set and if it is Active, status is set to **Active** 
 +  * If a back end network socket is set and if a physical interface or a network socket is set, status is set to **Active**. 
 +In other words: 
 +^  Front End Information  ^^^  Back End Information  ^  Status 
 +^  Physical interface  ^  Network socket  ^  Cross connect  ^  Back end network socket  ^  ^ 
 +|  *  |  *  |  *  |  unset  |  Inactive  |  
 +|  unset  |  *  |  set and active  |  set  |  Active 
 +|  unset  |  set  |  *  |  set  |  Active 
 +|  set  |  unset  |  unset  |  set  |  Active 
 +|  All other cases  |||  set  |  Ready  | 
 + 
 + 
 +Attribute **Cross Connect**, is set or unset from the Cross Connect objet, at the time where the Network Socket is attached to the Cross Connect, as part of the local or peer unit information. See [[extensions:teemip-cable-mgmt#cross_connect|below]]
  
 Network sockets implements three 1:1 relations. As the datamodel doesn't provide such attributes by default, these 1:1 relations are automatically computed when objects are created, modified or deleted: when one side of the relation is changed, the other sides (new and old when appropriate) are changed. These relations are:  Network sockets implements three 1:1 relations. As the datamodel doesn't provide such attributes by default, these 1:1 relations are automatically computed when objects are created, modified or deleted: when one side of the relation is changed, the other sides (new and old when appropriate) are changed. These relations are: 
Line 200: Line 222:
   * 1:1 relation between the network socket and a back end one.   * 1:1 relation between the network socket and a back end one.
  
-=== Displaying a Network Socket === 
-In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Network Socket dashlet, click on it and select the item you are interested in or select it directly from the Patch panel detailed display : 
- 
-{{ classdisplay_networksocket3x.png }} 
  
 ===== Cross Connect ===== ===== Cross Connect =====
Line 275: Line 293:
  
 <note warning> <note warning>
-A physical interface cannot be connected to both a network socket and another physical interface+A physical interface cannot be connected to both a network socket and another physical interface.
 </note> </note>
  
extensions/teemip-cable-mgmt.1715867009.txt.gz · Last modified: 2024/05/16 15:43 by cnaud