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 [2024/02/22 16:00] – [Cross Connect] cnaudextensions:teemip-cable-mgmt [2024/05/16 17:27] (current) – [Network Socket] cnaud
Line 27: Line 27:
 This extension brings to TeemIp objects from the cabling world that will allow you to document the physical connections between CIs. This extension brings to TeemIp objects from the cabling world that will allow you to document the physical connections between CIs.
  
-<note>Vocabulary: by "TeemIp solution" or "TeemIP", it should be understood: TeemIp standalone or the iTop solution on top of which TeemIp as a module has been installed.+<note>Vocabulary: by "TeemIp solution" or "TeemIP", it should be understood: TeemIp standalone or the iTop solution on top of which [[extensions:teemip-core-ip-mgmt|IPAM for iTop]] has been installed.
 </note> </note>
  
 ===== 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.0  |  3.1.0  | 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 \\ 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-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.2.0**  |  2023-12-07  |  Supported  |  3.1.0  |  3.1.0  | 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 67: Line 67:
 ===== Configuration ===== ===== Configuration =====
  
-No specific configuration is required in TeemIp's configuration file or in IP configs for that extension.+No specific configuration is required in TeemIp's configuration file or in IP configs for that extension to work. However, some default settings may be changed:
  
 +==== Configuration file ====
 +Under the **Modules specific settings** section, default parameters used by the **Find wiring** action on Cross Connects may be overwritten by the following configuration lines.
 +<code>
 + 'teemip-cable-mgmt' => array (
 + 'find_wiring_paths' => array (
 +   'max_rack_levels_to_cross' => 5,
 +   'max_offers_to_display' => 32,
 + ),
 + ),
 +</code>
 + 
 +==== 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.
 +
 +{{ cabling_ipsettings.png }}
 ===== Patch Panel  ===== ===== Patch Panel  =====
 {{icons8-toolbar.svg  }}  {{icons8-toolbar.svg  }} 
Line 79: 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 |
-| Connector | Foreign key to a(n) Interface Connector \\ Brought by the [[extensions:teemip-network-mgmt-extended|Network Management Extended]] extension | 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 | 
 +| External reference | Alphanumeric string | No |
 | Description | Multiline character string | No | | Description | Multiline character string | No |
 | **Rack Information** ||| | **Rack Information** |||
Line 118: Line 136:
  
 === Creating back end network cables === === Creating back end network cables ===
-If some network sockets are already attached to the patch panel, TeemIP will offer to automatically connect the back end interface of these network sockets to remote sockets located in another patch panel of another Rack. Purpose of this action is remove to TeemIP administrator the burden of creatinf back end network cables for each network socket of a patch panel.+If some network sockets are already attached to the patch panel, TeemIP will offer to automatically connect the back end interface of these network sockets to remote sockets located in another patch panel of another Rack. This action removes to TeemIP administrator the burden of creating back end network cables for each of the network sockets attached to a patch panel.
  
 When action is launched, TeemIP offers first to select the remote patch panel... When action is launched, TeemIP offers first to select the remote patch panel...
Line 126: Line 144:
 .. before creting the links in accordance with the number of available sockets in the remote rack. .. before creting the links in accordance with the number of available sockets in the remote rack.
  
-===== Network Socket =====+<note tip> 
 +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> 
 + ===== 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 139: Line 160:
 | Patch panel | Foreign key to a(n) Patch Panel | No | | Patch panel | Foreign key to a(n) Patch Panel | No |
 | Organization | Organization that the patch panel belongs to | N/A | | Organization | Organization that the patch panel belongs to | N/A |
 +| External reference | Alphanumeric string | No |
 | Comment | Multiline character string | No | | Comment | Multiline character string | No |
 | **Front End Information** ||| | **Front End Information** |||
Line 145: 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 166: Line 189:
 <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, a 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: 
 +^  Physical interface  ^  Network socket  ^  Cross connect  ^  Back end network socket  ^  Status  ^ 
 +|  *  |  *  |  *  |  unset  |  Inactive  |  
 +|  unset  |  *  |  set and active  |  set  |  Active  | 
 +|  unset  |  set  |  *  |  set  |  Active  | 
 +|  set  |  unset  |  unset  |  set  |  Active  | 
 +|  All other cases  |||  set  |  Ready  | 
  
 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 230: Line 264:
  
 === 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. This 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 }}
  
 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.
 +
 +<note tip>
 +The **Find wiring paths** action doesn't scan the entire CMDB. By default:
 +  * The number of racks that the paths may cross is limited to **5**,
 +  * The maximum of offers or proposals made by the tool is set to **32**.
 +
 +These value can be overwritten through the configuration file, as described [[extensions:teemip-cable-mgmt#configuration_file|here]].
 +</note>
 ===== Physical Interface ===== ===== Physical Interface =====
 {{icons8-globe-wire.png  }}  {{icons8-globe-wire.png  }} 
Line 285: Line 327:
 === Tabs === === Tabs ===
 ^  Tab  ^  Description  ^ ^  Tab  ^  Description  ^
-| Documents | All documents linked to the network cable |+| Documents | All documents linked to the front end network cable |
  
 <note warning> <note warning>
Line 319: Line 361:
 === Tabs === === Tabs ===
 ^  Tab  ^  Description  ^ ^  Tab  ^  Description  ^
-| Documents | All documents linked to the network cable |+| Documents | All documents linked to the back end network cable |
  
 <note warning> <note warning>
Line 354: Line 396:
 === Tabs === === Tabs ===
 ^  Tab  ^  Description  ^ ^  Tab  ^  Description  ^
-| Documents | All documents linked to the network cable |+| Documents | All documents linked to the device network cable |
  
 <note warning> <note warning>
Line 389: Line 431:
 === Tabs === === Tabs ===
 ^  Tab  ^  Description  ^ ^  Tab  ^  Description  ^
-| Documents | All documents linked to the network cable |+| Documents | All documents linked to the direct network cable |
  
 <note warning> <note warning>
Line 425: Line 467:
 === Tabs === === Tabs ===
 ^  Tab  ^  Description  ^ ^  Tab  ^  Description  ^
-| Patch Panels | All the patch panels that the cable is connected to |+| Documents | All documents linked to the breakout cable  | 
 +| Patch Panels * | All the patch panels that the cable is connected to |
  
-The relation holds a "UsedLinks" attribute which documents the number of wires consummed by the link.+(*) The relation holds a "UsedLinks" attribute which documents the number of wires consummed by the link.
  
 <note tip> <note tip>
extensions/teemip-cable-mgmt.1708614023.txt.gz · Last modified: 2024/02/22 16:00 by cnaud

Page Tools