Differences

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

--- extensions:teemip-cable-mgmt [2024/02/22 15:55] – [Cross Connect] cnaud
+++ extensions:teemip-cable-mgmt [2024/05/14 13:04] (current) – [Patch Panel] cnaud
@@ Line 32: / Line 32: @@
 ===== Revision History =====
 ^  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 \\ - 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 =====
@@ Line 67: / Line 67: @@
 ===== 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  =====
 {{icons8-toolbar.svg  }}
@@ Line 82: / Line 97: @@
 | Location | Foreign key to a(n) Location | Yes |
 | 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 |
+| 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 |
 | **Rack Information** |||
@@ Line 118: / Line 134: @@
 === 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...
@@ Line 126: / Line 142: @@
 .. before creting the links in accordance with the number of available sockets in the remote rack.
+<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  }}
@@ Line 139: / Line 158: @@
 | Patch panel | Foreign key to a(n) Patch Panel | No |
 | Organization | Organization that the patch panel belongs to | N/A |
+| External reference | Alphanumeric string | No |
 | Comment | Multiline character string | No |
 | **Front End Information** |||
@@ Line 187: / Line 207: @@
 ===== Cross Connect =====
 {{icons8-data-transfer.svg  }}
-FIXME
 A cross connect represents the cabling necessary to establish a direct link between two separate organizations in a data center, thus allowing the establishment of a private network link and eliminating the need to connect them using the internet.
@@ Line 231: / Line 250: @@
 === 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 }}
+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 =====
 {{icons8-globe-wire.png  }}
@@ Line 284: / Line 313: @@
 === Tabs ===
 ^  Tab  ^  Description  ^
-| Documents | All documents linked to the network cable |
+| Documents | All documents linked to the front end network cable |
 <note warning>
@@ Line 318: / Line 347: @@
 === Tabs ===
 ^  Tab  ^  Description  ^
-| Documents | All documents linked to the network cable |
+| Documents | All documents linked to the back end network cable |
 <note warning>
@@ Line 353: / Line 382: @@
 === Tabs ===
 ^  Tab  ^  Description  ^
-| Documents | All documents linked to the network cable |
+| Documents | All documents linked to the device network cable |
 <note warning>
@@ Line 388: / Line 417: @@
 === Tabs ===
 ^  Tab  ^  Description  ^
-| Documents | All documents linked to the network cable |
+| Documents | All documents linked to the direct network cable |
 <note warning>
@@ Line 424: / Line 453: @@
 === Tabs ===
 ^  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>

Documentation

User Tools

Site Tools

Differences

Page Tools