Documentation

User Tools

Site Tools

Trace:
extensions:teemip-network-mgmt-extended

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-network-mgmt-extended [2025/01/30 16:18] – [Revision History] cnaudextensions:teemip-network-mgmt-extended [2025/05/23 16:07] (current) – [Revision History] cnaud
Line 1: Line 1:
-{{ picto_networkmanagementextended.png}}+{{ picto_networkmanagementextended.png?nolink}}
 ====== Network Management Extended ====== ====== Network Management Extended ======
 ---- dataentry summary ---- ---- dataentry summary ----
Line 7: Line 7:
 level_hidden        : 1 level_hidden        : 1
 collector_hidden    : no collector_hidden    : no
-version             : 3.2.0 +version             : 3.2.2 
-release_dt          : 2024-11-13 +release_dt          : 2025-05-23 
-TeemIp              : 3.2+ +TeemIp              : 3.2.1+ 
-iTop                : 3.1++iTop                : 3.2.1+
 code                : teemip-network-mgmt-extended code                : teemip-network-mgmt-extended
-localization        : English, French+localization        : English, French, Brazilian Portuguese 
 state               : stable state               : stable
 diffusion_hidden    : TeemIp wiki diffusion_hidden    : TeemIp wiki
Line 19: Line 19:
 keyword_tags        : CMDB, Network keyword_tags        : CMDB, Network
 dependencies_s      : teemip-ip-mgmt, teemip-network-mgmt, teemip-config-mgmt-adaptor dependencies_s      : teemip-ip-mgmt, teemip-network-mgmt, teemip-config-mgmt-adaptor
-download_wiki       : [[https://sourceforge.net/projects/teemip/files/teemip%20-%20extensions/Network%20Management%20Extended/3.2.0/teemip-network-mgmt-extended-3.2.0-210.zip/download|teemip-network-mgmt-extended-3.2.0-210.zip]]+download_wiki       : [[https://sourceforge.net/projects/teemip/files/teemip%20-%20extensions/Network%20Management%20Extended/3.2.2/teemip-network-mgmt-extended-3.2.2-212.zip/download|teemip-network-mgmt-extended-3.2.2-212.zip]]
 github_wiki         : [[https://github.com/TeemIp/teemip-network-mgmt-extended|teemip-network-mgmt-extended]] github_wiki         : [[https://github.com/TeemIp/teemip-network-mgmt-extended|teemip-network-mgmt-extended]]
-php-max             : 8.3+php-max             : 8.4
 ---- ----
  
-This extension adds to TeemIp data model a few advanced classes dedicated to the network world.+This extension adds to TeemIp data model advanced classes dedicated to the network world, like clusters of network device, aggregate links, network components and modules and enhance network related classes that are part of TeemIp core extensions, like VLANs and network interfaces.
  
 <note> <note>
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  ^
-|  **3.2.0**  |  2024-11-13   |  Supported  |  3.1.0  |  3.2.0  | - Transform Aggregate Link class into IPInterface child class \\ - VRFs and VLANs can be attached to Aggregates \\ - Obsolete status has been  added to Cluster Networks \\ - Add source and destination IPs to Network Flows |+|  **3.2.2**  |  2025-05-23  |  Supported  |  3.2.1  |  3.2.1  | - Correct bugs on Network Module and Network Module Type modelization | 
 +|  3.2.1  |  2025-05-21  |  Obsolete  |  3.2.1  |  3.2.1  | - Add Network Module class to be hosted by Physical Interfaces \\ - Add MTU attribute to IPInterface \\ - Add raw value attribute to InterfaceSpeed \\ - PR [[https://github.com/TeemIp/teemip-network-mgmt-extended/pull/12|#12]] - Fix AggregateLink inconsistency \\ - Add summary cards to main classes \\ - Replace legacy CRUD methods by new CRUD events | 
 +|  3.2.0  |  2024-11-13   |  Supported  |  3.1.0  |  3.2.0  | - Transform Aggregate Link class into IPInterface child class \\ - VRFs and VLANs can be attached to Aggregates \\ - Obsolete status has been  added to Cluster Networks \\ - Add source and destination IPs to Network Flows |
 |  3.1.3  |  2024-06-26  |  Obsolete  |  3.1.0 |  3.1.0  | - Add a logo attribute to the Brand typology \\ - Add a picture attribute to the Model typology \\ - Add bandwidth, next to capacity, to Network Flows | |  3.1.3  |  2024-06-26  |  Obsolete  |  3.1.0 |  3.1.0  | - Add a logo attribute to the Brand typology \\ - Add a picture attribute to the Model typology \\ - Add bandwidth, next to capacity, to Network Flows |
 |  3.1.2  |  2023-12-14  |  Obsolete  |  3.1.0  |  3.1.0  | - Add Chinese (simplified) translation \\ - Data samples have been added | |  3.1.2  |  2023-12-14  |  Obsolete  |  3.1.0  |  3.1.0  | - Add Chinese (simplified) translation \\ - Data samples have been added |
Line 44: Line 46:
 ===== Features ===== ===== Features =====
 With TeemIp Network Management Extended: With TeemIp Network Management Extended:
-  * Group interfaces together through Aggregate Links, +  * **Group interfaces** together through **Aggregate Links**, 
-  * Manage high availability, high performance or load balancing clusters, +  * Manage **clusters** of network devices in high availability, high performance or load balancing mode, 
-  * Add components like power supplies, management boards... to network devices, +  * Add **components** like power supplies, management boards... to **network devices**, 
-  * Use topological object to manage speeds, layer 2 protocols and connectors on your IP Interfaces.+  * Document **network modules** like transceivers that are attached to physical interface to provide fiber connectivity, 
 +  * Use topological object to manage **speeds**, **layer 2 protocols** and **connectors** on your **IP Interfaces**, 
 +  * Store your **SNMP credentials** to ease network device management, 
 +  * Document your **network flows**.
  
 ===== Licensing ===== ===== Licensing =====
Line 56: Line 61:
  
 ===== Requirements ===== ===== Requirements =====
-There is no specific requirement with that extension. TeemIp Network Management Extended is anyway already embedded in TeemIp standalone starting with TeemIp 2.7. +//**TeemIp standalone:**// The extension is embedded in TeemIp standalone. \\ 
- +//**iTop:**// When installed on an iTop application, you need [[extensions:teemip-core-ip-mgmt|IPAM for iTop]] to be installed as well.
-When installed on an iTop application, make sure that [[extensions:teemip-core-ip-mgmt|IPAM for iTop]] is installed as well. +
  
 ===== Installation ===== ===== Installation =====
-Installation on a TeemIp standalone is done with the application itself, through the setup. +//**TeemIp standalone:**// Installation is done with the application itself, through the setup. \\ 
- +//**iTop:**// When adding the extension on an iTop application, follow the [[https://wiki.openitop.org/doku.php?id=extensions:installation|Standard installation process]].
-When adding the module on an iTop application, follow the [[https://wiki.openitop.org/doku.php?id=extensions:installation|Standard installation process]].+
  
 ===== Configuration ===== ===== Configuration =====
Line 72: Line 74:
  
 ===== Aggregate Link ===== ===== Aggregate Link =====
-{{icons8-bursts-48.png  }} +{{icons8-bursts-48.png ?nolink }} 
  
 Should you need to group several physical interfaces on your network device to model trunking in the HP world or Ether Channel in the Cisco one, the Aggregate Link class will allow you to do so. Should you need to group several physical interfaces on your network device to model trunking in the HP world or Ether Channel in the Cisco one, the Aggregate Link class will allow you to do so.
Line 88: Line 90:
 | **More Information** ||| | **More Information** |||
 | MAC address | Formated alphanumeric string | No | | MAC address | Formated alphanumeric string | No |
 +| Speed | Foreign key to a(n) Interface speed | No |
 | Protocol | Foreign key to a(n) Layer 2 Protocol | No | | Protocol | Foreign key to a(n) Layer 2 Protocol | No |
 +| MTU | Integer | No |
  
 === Tabs === === Tabs ===
Line 100: Line 104:
 In the Overview menu of the Configuration Management module, find the Network group and the Aggregate Link dashlet within that group. Click on it and select the item you are interested in: In the Overview menu of the Configuration Management module, find the Network group and the Aggregate Link dashlet within that group. Click on it and select the item you are interested in:
  
-{{ classdisplay_aggregatelink3x.png }}+{{ classdisplay_aggregatelink3x.png ?nolink }}
  
 <note tip> <note tip>
Line 107: Line 111:
  
 ===== Cluster Network ===== ===== Cluster Network =====
-{{icons8-stack.png  }} +{{icons8-stack.png ?nolink }} 
 This class allows you to group network devices together to create a high availability, high performance or load balancing cluster. This class allows you to group network devices together to create a high availability, high performance or load balancing cluster.
  
Line 143: Line 147:
 Click on the “New CI” menu, then select “Cluster Network” in the form below: Click on the “New CI” menu, then select “Cluster Network” in the form below:
  
-{{ classcreate_clusternetwork_selectionform3x.png }}+{{ classcreate_clusternetwork_selectionform3x.png ?nolink }}
  
 And click “Apply” to display the Cluster Network creation form: And click “Apply” to display the Cluster Network creation form:
  
-{{ classcreate_clusternetwork3x.png }}+{{ classcreate_clusternetwork3x.png ?nolink }}
  
 When listing the nodes, redundancy parameters can be set so that impact analysis can take availability of all cluster members into consideration. When listing the nodes, redundancy parameters can be set so that impact analysis can take availability of all cluster members into consideration.
  
-{{ classdisplay_clusternetwork_ha3x.png }}+{{ classdisplay_clusternetwork_ha3x.png ?nolink }}
  
 <note warning> <note warning>
Line 157: Line 161:
 </note> </note>
  
-{{ classdisplay_clusternetwork_impact3x.png }}+{{ classdisplay_clusternetwork_impact3x.png ?nolink }}
  
 ===== Network Device Component ===== ===== Network Device Component =====
-{{icons8-slave-48.png  }} +{{icons8-slave-48.png  ?nolink }} 
  
 Network devices may be made of different components: power supplies, management board... That class allow you to register them in TeemIp's CMDB. Network devices may be made of different components: power supplies, management board... That class allow you to register them in TeemIp's CMDB.
Line 194: Line 198:
 In the Overview menu of the Configuration Management module, find the Network Device Component dashlet, click on it and select the item you are interested in: In the Overview menu of the Configuration Management module, find the Network Device Component dashlet, click on it and select the item you are interested in:
  
-{{ classdisplay_networkdevicecomponent3x.png }}+{{ classdisplay_networkdevicecomponent3x.png ?nolink }} 
 + 
 +===== Network Module ===== 
 +{{icons8-laser-beam-hazard-48.png  ?nolink }} 
 +A Network Module or transceiver or interface converter is a small, most of the time optical, Tx / Rx device that get plugged in a physical network interface. 
 + 
 +=== Network Module Properties === 
 +^  Name  ^  Type  ^  Mandatory?  ^ 
 +| **General Information** ||| 
 +| Name | Alphanumeric string | Yes | 
 +| Organization | Foreign key to a(n) Organization | Yes |  
 +| Status| Possible values: Implementation, Production, Obsolete  | No | 
 +| Business criticality | Possible values: Low, Medium, High | No | 
 +| Location | Foreign key to a(n) Location| No |  
 +| Device | Foreign key to a(n) Connectable CI | No |  
 +| Physical interface | Foreign key to a(n) Physical interface | No |  
 +| **More Information** ||| 
 +| Brand | Foreign key to a(n) Brand | No | 
 +| Model | Foreign key to a(n) Model | No | 
 +| Serial number | Alphanumeric string | No | 
 +| Asset number | Alphanumeric string | No | 
 +| **Dates** ||| 
 +| Move to production date | Date (year-month-day) | No | 
 +| Purchase date | Date (year-month-day) | No | 
 +| End of warranty | Date (year-month-day) | No | 
 +| **Other information ** ||| 
 +| Physical interface speed | Speed attribute of the interface | No | 
 +| Module type | Foreign key to a(n) [[teemip-network-mgmt-extended#network_module_type|Network Module Type]] | No | 
 +| Max Data Rate | Speed attribute o the module type  | No | 
 +| Description | Multiline character string  | No | 
 + 
 +=== Tabs === 
 +^  Tab  ^  Description  ^ 
 +| Contacts | All the contacts for this configuration item | 
 +| Documents | All the documents linked to this configuration item | 
 + 
 + 
 +=== Displaying a Network Module === 
 +In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Network Module dashlet in the Interfaces section, click on it and select the item you are interested in: 
 + 
 +{{ classdisplay_networkmodule3x.png ?nolink }}
  
 ===== Network Device ===== ===== Network Device =====
-{{icons8-switch.png  }}+{{icons8-switch.png ?nolink }}
 This class of CIs is brought by iTop CMDB. It models any type of network device: router, switch, hub, load balancer, firewall… TeemIp Network Management Extended enriches it with additional attributes and relations as shown below. This class of CIs is brought by iTop CMDB. It models any type of network device: router, switch, hub, load balancer, firewall… TeemIp Network Management Extended enriches it with additional attributes and relations as shown below.
  
Line 218: Line 262:
 In the Overview menu of the Configuration Management module, find the Network Device dashlet, click on it and select the item you are interested in: In the Overview menu of the Configuration Management module, find the Network Device dashlet, click on it and select the item you are interested in:
  
-{{ classdisplay_networkdevice_extended.png }}+{{ classdisplay_networkdevice_extended.png ?nolink }}
  
 ===== Network Flow ===== ===== Network Flow =====
  
-{{icons8-flow.png  }}+{{icons8-flow.png  ?nolink }}
  
 Network Flows will help you to document the key flows that go through your network and to visualize them in a diagram. Network Flows will help you to document the key flows that go through your network and to visualize them in a diagram.
Line 259: Line 303:
 In the Network dashboard that is accessible from a submenu of the standard CMDB overview menu, find the Network Flow 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 Network Flow dashlet, click on it and select the item you are interested in:
  
-{{ classdisplay_networkflow.png }}+{{ classdisplay_networkflow.png ?nolink }}
  
  
Line 265: Line 309:
 Once network flows between CIs are documented, the logical path that connects them all can be visualized through the menu **Outgoing Flow…** displayed under the **Other Actions** menu of Network Flow or Functional CI (see above). Once network flows between CIs are documented, the logical path that connects them all can be visualized through the menu **Outgoing Flow…** displayed under the **Other Actions** menu of Network Flow or Functional CI (see above).
  
-{{ network_outgoingflow1.png }} +{{ network_outgoingflow1.png ?nolink }} 
-{{ network_outgoingflow2.png }}+{{ network_outgoingflow2.png ?nolink }}
  
 <note tip> <note tip>
Line 272: Line 316:
 </note> </note>
 ===== VLAN ===== ===== VLAN =====
-{{icons8-hierarchy.png  }}  +{{icons8-hierarchy.png  ?nolink }}  
 TeemIp Network Management Extended alters and enhances the Virtual LAN class properties but leaves the tabs unchanged. TeemIp Network Management Extended alters and enhances the Virtual LAN class properties but leaves the tabs unchanged.
  
Line 299: Line 343:
 In the Overview menu of the Configuration Management module, find the Network group, click on it and select the item you are interested in the list: In the Overview menu of the Configuration Management module, find the Network group, click on it and select the item you are interested in the list:
  
-{{ classdisplay_vlan3x.png }}+{{ classdisplay_vlan3x.png ?nolink }}
  
  
Line 307: Line 351:
  
 ===== SNMP Credentials ===== ===== SNMP Credentials =====
-{{icons8-switch-48-lock.png  }} +{{icons8-switch-48-lock.png  ?nolink }} 
 This class allows you to document the different SNMP credentials that are used within your organization. This class allows you to document the different SNMP credentials that are used within your organization.
  
Line 340: Line 384:
 From the listing view or from any create action of a SNMP Credentials badge, click on the {{2_x:datamodel:plus-button.png?nolink|Edit icon}} to display the creation form. From the listing view or from any create action of a SNMP Credentials badge, click on the {{2_x:datamodel:plus-button.png?nolink|Edit icon}} to display the creation form.
  
-{{ classcreate_snmpcredentials.png }}+{{ classcreate_snmpcredentials.png ?nolink }}
  
 According to the selected value for the Security level, the attributes that are relevant for this level become mandatory : According to the selected value for the Security level, the attributes that are relevant for this level become mandatory :
Line 351: Line 395:
 ===== Typology Elements ===== ===== Typology Elements =====
  
-{{icons8-new-item-48.png }}  +{{icons8-new-item-48.png ?nolink }}  
-The extension enhances the Brand and Model typological elements and brings four new ones.+The extension enhances the Brand and Model typological elements and brings new ones.
  
 ==== Brand ==== ==== Brand ====
 A logo attribute is added to the class and is also used as image attribute, which ease the search of a Brand in a list.  A logo attribute is added to the class and is also used as image attribute, which ease the search of a Brand in a list. 
  
-{{classdisplay_brand.png}}{{classlist_brand.png}}+{{classdisplay_brand.png?nolink}}{{classlist_brand.png?nolink}}
  
 ==== Model ==== ==== Model ====
 A picture attribute is added to the class and is also used as image_attribute. A picture attribute is added to the class and is also used as image_attribute.
  
-{{ classdisplay_model.png }}+{{ classdisplay_model.png ?nolink }} 
 + 
 +==== Network Module Type ==== 
 +This typology element provides technical details on the network modules that different providers may offer. 
 + 
 +=== Network Module Type Properties === 
 +^  Name  ^  Type  ^  Mandatory?  ^ 
 +| **General Information** ||| 
 +| Name | Alphanumeric string | Yes | 
 +| Form factor | Possible values: Integrated, SFP, SFP+, OSFP, QSFP, QSFP+, XFP, GBIC, Mini GBIC, Other | Yes | 
 +| Speed | Foreign key to a(n) Interface Speed | No | 
 +| Connector | Foreign key to a(n) Interface Connector | Yes | 
 +| Description | Multiline character string  | No | 
 +| **Optical Details** ||| 
 +| Optical reach | Possible values: SR, LR, LRM, ER, XR, ZR, DWDM, CWDM, Other | Yes | 
 +| Tx lambda | Alphanumeric string  | No |  
 +| Rx lambda | Alphanumeric string  | No | 
 + 
 +=== Tabs === 
 +^ Tab ^ Description ^ 
 +| Network modules | Dashboard listing all the network modules of this type | 
 + 
 +=== Managing network module Types === 
 +These are accessible from the typology configuration dashboard. 
 + 
 +{{ classdisplay_networkmoduletype3x.png ?nolink }}
 ==== Additional elements ==== ==== Additional elements ====
-These four elements are:+These are:
  
 ^  Name  ^  Description  ^  Attributes  ^  Example  ^ ^  Name  ^  Description  ^  Attributes  ^  Example  ^
Line 374: Line 443:
 The extension groups network specific typological elements in a dedicated dashlet. The extension groups network specific typological elements in a dedicated dashlet.
  
-{{ overview_group_network_typology3x.png }}+{{ overview_group_network_typology3x.png ?nolink }}
  
 These typological elements change the different interfaces as follows: These typological elements change the different interfaces as follows:
Line 380: Line 449:
 ==== Logical Interface ==== ==== Logical Interface ====
   * Speed attribute (string) is replaced by a foreign key toward a Interface Speed,   * Speed attribute (string) is replaced by a foreign key toward a Interface Speed,
-  * Foreign key toward Layer 2 Protocol is added+  * Foreign key toward Layer 2 Protocol is added, 
 +  * A maximum transmission unit (MTU) parameter is added as well.
  
-{{ classdisplay_logicalinterface3x.png }} +{{ classdisplay_logicalinterface3x.png ?nolink }} 
  
  
Line 388: Line 458:
 ==== Network Device Virtual Interface ==== ==== Network Device Virtual Interface ====
   * Speed attribute (string) is replaced by a foreign key toward a Interface Speed,   * Speed attribute (string) is replaced by a foreign key toward a Interface Speed,
-  * Foreign key toward Layer 2 Protocol is added+  * Foreign key toward Layer 2 Protocol is added, 
 +  * A maximum transmission unit (MTU) parameter is added as well.
  
-{{ classdisplay_networkdevicevirtualinterface3x.png }} +{{ classdisplay_networkdevicevirtualinterface3x.png ?nolink }} 
  
  
 ==== Physical Interface ==== ==== Physical Interface ====
   * Speed attribute (string) is replaced by a foreign key toward a Interface Speed,   * Speed attribute (string) is replaced by a foreign key toward a Interface Speed,
-  * Foreign key toward Layer 2 Protocol is added +  * Foreign key toward Layer 2 Protocol is added, 
-  * Foreign key toward Connector is added+  * Foreign key toward Connector is added, 
 +  * A maximum transmission unit (MTU) parameter is added too.
  
-Note that the extension adds as well a foreign key toward an Aggregate Link.+Note that the extension adds as well: 
 +  * A foreign key toward an Aggregate Link, 
 +  * A foreign key toward a Network Module. 
 + 
 +<note tip> 
 +A physical interface cannot host a connector and a network module at the same time. 
 +</note>
  
-{{ classdisplay_physicalinterface3x.png }} +{{ classdisplay_physicalinterface3x.png ?nolink }} 
  
 ===== Network Security Manager profile ===== ===== Network Security Manager profile =====
extensions/teemip-network-mgmt-extended.1738250311.txt.gz · Last modified: by cnaud

Page Tools