Documentation

User Tools

Site Tools

Trace: • teemip-request-mgmt • teemip-network-mgmt-extended
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 [2026/04/13 15:00] – [Network Management Extended] cnaudextensions:teemip-network-mgmt-extended [2026/04/15 10:07] (current) – [Revision History] cnaud
Line 9: Line 9:
 version             : 3.3.0 version             : 3.3.0
 release_dt          : 2026-04-13 release_dt          : 2026-04-13
-TeemIp              : 3.2.1++teemIP              : 3.2.1+
 iTop                : 3.2.2+ iTop                : 3.2.2+
 code                : teemip-network-mgmt-extended code                : teemip-network-mgmt-extended
Line 24: Line 24:
 ---- ----
  
-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.+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>
-This module is embedded by default in TeemIp standalone. It can be deployed as an extension with TeemIp as a module.+This module is embedded by default in teemIP standalone. It can be deployed as an extension with teemIP as a module.
 </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  ^
-|  3.3.0  |  2026-04-15  |  Supported  |  3.2.2  |  3.2.1  | - Add VPN Link and associated VPN Protocol classes \\ - PR [[https://github.com/TeemIp/teemip-network-mgmt-extended/pull/16|#16]] - Aggregate Links: align naming with PhysicalInterface naming \\ - PR [[https://github.com/TeemIp/teemip-network-mgmt-extended/pull/17|#17]] - Interface Speed: define logical ordering and uniqueness rule  \\ - PR [[https://github.com/TeemIp/teemip-network-mgmt-extended/pull/19|#19]] - NetworkDevice: align aggregatelinks list with physicalinterfaces list \\ - PR [[https://github.com/TeemIp/teemip-network-mgmt-extended/pull/20|#20]] - VLAN: Ensure proper ordering on tag |  +|  3.3.1  |  2026  |  |  3.2.2  |  3.2.1  | - Correct detail screen of Aggregate link class | 
-|  **3.2.2**  |  2025-05-23  |  Supported  |  3.2.1  |  3.2.1  | - Add Brazilian translation \\ - Correct bugs on Network Module and Network Module Type modelization |+|  **3.3.0**  |  2026-04-15  |  Supported  |  3.2.2  |  3.2.1  | - Add VPN Link and associated VPN Protocol classes \\ - PR [[https://github.com/TeemIp/teemip-network-mgmt-extended/pull/16|#16]] - Aggregate Links: align naming with PhysicalInterface naming \\ - PR [[https://github.com/TeemIp/teemip-network-mgmt-extended/pull/17|#17]] - Interface Speed: define logical ordering and uniqueness rule  \\ - PR [[https://github.com/TeemIp/teemip-network-mgmt-extended/pull/19|#19]] - NetworkDevice: align aggregatelinks list with physicalinterfaces list \\ - PR [[https://github.com/TeemIp/teemip-network-mgmt-extended/pull/20|#20]] - VLAN: Ensure proper ordering on tag |  
 +|  3.2.2  |  2025-05-23  |  Obsolete  |  3.2.1  |  3.2.1  | - Add Brazilian translation \\ - 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.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.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 |
Line 40: Line 41:
 |  3.1.1  |  2023-09-13  |  Obsolete  |  3.1.0  |  3.1.0  | - Add a "replacement date" attribute to Network Devices and Cluster Networks \\ - Add Network Flow class with flaw drawing \\ - Add SNMP Credentials class | |  3.1.1  |  2023-09-13  |  Obsolete  |  3.1.0  |  3.1.0  | - Add a "replacement date" attribute to Network Devices and Cluster Networks \\ - Add Network Flow class with flaw drawing \\ - Add SNMP Credentials class |
 |  3.1.0  |  2023-06-21  |  Obsolete  |  3.0.0  |  3.1.0  | - Location and organization fields inherited from Device have been added to Aggregate links \\ - Some objects have been redispatched to Overview / Networking menu \\ - XML structure has moved to 3x | |  3.1.0  |  2023-06-21  |  Obsolete  |  3.0.0  |  3.1.0  | - Location and organization fields inherited from Device have been added to Aggregate links \\ - Some objects have been redispatched to Overview / Networking menu \\ - XML structure has moved to 3x |
-|  3.0.1  |  2022-09-09  |  Obsolete  |  2.7.0  |  3.0.1  | - Adopt 3.x icon style \\ - Add TeemIp core modules as a dependency | +|  3.0.1  |  2022-09-09  |  Obsolete  |  2.7.0  |  3.0.1  | - Adopt 3.x icon style \\ - Add teemIP core modules as a dependency | 
-|  3.0.0  |  2022-01-11  |  Obsolete  |  2.7.0  |  3.0.0  | - TeemIp / iTop 3.x compatible version  \\ - Status of IPs is now handled when attached to or detached from a Network Cluster |+|  3.0.0  |  2022-01-11  |  Obsolete  |  2.7.0  |  3.0.0  | - teemIP / iTop 3.x compatible version  \\ - Status of IPs is now handled when attached to or detached from a Network Cluster |
 |  1.1.0  |  2021-04-01  |  Obsolete  |  2.7.0  |  2.7.0  | - Sample data have been added to the extension. \\  - VLAN model has been enhanced with new attributes \\ - Tag is now an integer: beware when migrating ! \\ - Align extension structure with new guidelines | |  1.1.0  |  2021-04-01  |  Obsolete  |  2.7.0  |  2.7.0  | - Sample data have been added to the extension. \\  - VLAN model has been enhanced with new attributes \\ - Tag is now an integer: beware when migrating ! \\ - Align extension structure with new guidelines |
 |  1.0.0  |  2020-12-11  |  Obsolete  |  2.7.0  |  2.7.0  | - Initial revision | |  1.0.0  |  2020-12-11  |  Obsolete  |  2.7.0  |  2.7.0  | - Initial revision |
  
 ===== 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 **clusters** of network devices in high availability, high performance or load balancing mode,   * 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**,
   * Document **network modules** like transceivers that are attached to physical interface to provide fiber connectivity,   * 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**,   * Use topological object to manage **speeds**, **layer 2 protocols** and **connectors** on your **IP Interfaces**,
 +  * Enhance the way **VLANs** are documented,
 +  * Manage you **VPN links** next to your WAN links,
   * Store your **SNMP credentials** to ease network device management,   * Store your **SNMP credentials** to ease network device management,
   * Document your **network flows**.   * Document your **network flows**.
  
 ===== Licensing ===== ===== Licensing =====
-The TeemIp Network Management Extended extension is licensed under the terms of the GNU Affero General Public License Version 3 as published by the Free Software Foundation. This gives you legal permission to copy, distribute and/or modify TeemIp Network Management Extended under certain conditions. Read the ’license.txt’ file in the TeemIp distribution. TeemIp Network Management Extended is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.+The teemIP Network Management Extended extension is licensed under the terms of the GNU Affero General Public License Version 3 as published by the Free Software Foundation. This gives you legal permission to copy, distribute and/or modify teemIP Network Management Extended under certain conditions. Read the ’license.txt’ file in the teemIP distribution. teemIP Network Management Extended is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
  
 ===== Limitations ===== ===== Limitations =====
Line 62: Line 65:
  
 ===== Requirements ===== ===== Requirements =====
-//**TeemIp standalone:**// The extension is embedded in TeemIp standalone. \\+//**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. //**iTop:**// When installed on an iTop application, you need [[extensions:teemip-core-ip-mgmt|IPAM for iTop]] to be installed as well.
  
 ===== Installation ===== ===== Installation =====
-//**TeemIp standalone:**// Installation 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]]. //**iTop:**// When adding the extension on an iTop application, follow the [[https://wiki.openitop.org/doku.php?id=extensions:installation|Standard installation process]].
  
 ===== 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.
  
  
Line 89: Line 92:
 | **Peer Information** ||| | **Peer Information** |||
 | Peer aggregate | Foreign key to a(n) peer aggregate | No | | Peer aggregate | Foreign key to a(n) peer aggregate | No |
-| **More Information** |||+| **Layer 2 Information** |||
 | MAC address | Formated alphanumeric string | No | | MAC address | Formated alphanumeric string | No |
 | Speed | Foreign key to a(n) Interface speed | 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 | | MTU | Integer | No |
 +| **Layer 3 Information** |||
 +| IP Addresses | List of all IP addresses used by the aggregate | No |
 +| VRFs | VRFs that the aggregate belongs to | No |
 +
  
 === Tabs === === Tabs ===
 ^  Tab  ^  Description  ^ ^  Tab  ^  Description  ^
 | VLANs | VLANs that the aggregate is part of | | VLANs | VLANs that the aggregate is part of |
-| VRFs | VRFs that the aggregate belongs to | 
-| IP Addresses | List of all IP addresses used by the aggregate | 
 | IP Interfaces | All the IP interfaces that make the aggregate | | IP Interfaces | All the IP interfaces that make the aggregate |
  
 === Displaying an Aggregate Link === === Displaying an Aggregate Link ===
-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 Networking dashboard that is accessible from a submenu of the standard CMDB Overview menu, find the Interfaces group and the Aggregate Link dashlet within that group. Click on it and select the item you are interested in:
  
 {{ classdisplay_aggregatelink3x.png ?nolink }} {{ classdisplay_aggregatelink3x.png ?nolink }}
  
 <note tip> <note tip>
-TeemIp will handle the relation with a peer aggregate like a 1:1 relation. When the link is set on one Aggregate Link, it is automatically set on the other side and when it is removed, it is automatically removed from the other side as well.+teemIP handles the relation with a peer aggregate like a 1:1 relation. When the link is set on one Aggregate Link, it is automatically set on the other side and when it is removed, it is automatically removed from the other side as well.
 </note> </note>
  
Line 142: Line 147:
 <note> <note>
   * (1) The role (Ative or Standby) that appears on the link between a node and the cluster is defined at the node side.   * (1) The role (Ative or Standby) that appears on the link between a node and the cluster is defined at the node side.
-  * (2) This list is actually automatically computed from the list of CIs connected to each of the nodes of the cluster. The list doesn't check if the CIs are connected to each of the nodes. This is however what TeemIp considers for its impact analysis. +  * (2) This list is actually automatically computed from the list of CIs connected to each of the nodes of the cluster. The list doesn't check if the CIs are connected to each of the nodes. This is however what teemIP considers for its impact analysis. 
 </note> </note>
  
Line 167: Line 172:
 {{icons8-slave-48.png  ?nolink }}  {{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 allows you to register them in teemIP's CMDB.
  
 === Network Device Component Properties === === Network Device Component Properties ===
Line 197: Line 202:
  
 === Displaying a Network Device Component === === Displaying a Network Device Component ===
-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 in the Infrastructure group, click on it and select the item you are interested in:
  
 {{ classdisplay_networkdevicecomponent3x.png ?nolink }} {{ classdisplay_networkdevicecomponent3x.png ?nolink }}
Line 237: Line 242:
  
 === Displaying a Network Module === === 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:+In the Networking dashboard that is accessible from a submenu of the standard CMDB Overview menu, find Network Module dashlet in the Interfaces section, click on it and select the item you are interested in:
  
 {{ classdisplay_networkmodule3x.png ?nolink }} {{ classdisplay_networkmodule3x.png ?nolink }}
Line 243: Line 248:
 ===== Network Device ===== ===== Network Device =====
 {{icons8-switch.png ?nolink }} {{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.
  
 === Network Device additional Properties === === Network Device additional Properties ===
Line 302: Line 307:
  
 === Displaying a Network Flow === === Displaying a Network Flow ===
-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 Networking dashboard that is accessible from a submenu of the standard CMDB Overview menu, find the Connectivity section and the Network Flow dashlet within that section, click on it and select the item you are interested in:
  
 {{ classdisplay_networkflow.png ?nolink }} {{ classdisplay_networkflow.png ?nolink }}
Line 318: Line 323:
 ===== VLAN ===== ===== VLAN =====
 {{icons8-hierarchy.png  ?nolink }}   {{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.
  
 === VLAN Properties === === VLAN Properties ===
Line 332: Line 337:
 ^  Tab  ^  Description  ^ ^  Tab  ^  Description  ^
 | Subnets | Subnets (v4 or v6) which are part of this VLAN | | Subnets | Subnets (v4 or v6) which are part of this VLAN |
-| Physical network interfaces | Physical interfaces which are part of this VLAN | +| Network interfaces | Dashboard that lists of all network interfaces attached to this VLAN |
-| Logical network interfaces | Logical interfaces which are part of this VLAN |+
 | Interfaces' IPs | IPs of all logical and physical  interfaces attached to the VLAN | | Interfaces' IPs | IPs of all logical and physical  interfaces attached to the VLAN |
 | DHCP Options | Shared Network DHCP Option pointing to the VLAN (1) | | DHCP Options | Shared Network DHCP Option pointing to the VLAN (1) |
  
 <note> <note>
-  * (1) This tab is brought by the [[extensions:teemip-dhcp-mgmt|TeemIp DHCP Management]] extension+  * (1) This tab is brought by the [[extensions:teemip-dhcp-mgmt|teemIP DHCP Management]] extension
 </note> </note>
  
 === Displaying a VLAN === === Displaying a VLAN ===
-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 Networking dashboard that is accessible from a submenu of the standard CMDB Overview menu, find the Connectivity section and the VLAN dashlet within that group, click on it and select the item you are interested in the list:
  
 {{ classdisplay_vlan3x.png ?nolink }} {{ classdisplay_vlan3x.png ?nolink }}
Line 383: Line 387:
  
 === Creating new SNMP Credentials === === Creating new SNMP Credentials ===
-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.+The class is available in the Networking dashboard that is accessible from a submenu of the standard CMDB Overview menu, in the Connectivity group. 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 ?nolink }} {{ classcreate_snmpcredentials.png ?nolink }}
extensions/teemip-network-mgmt-extended.1776092425.txt.gz · Last modified: by cnaud

Page Tools