User Tools

Site Tools


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 [2021/03/23 16:47] cnaudextensions:teemip-network-mgmt-extended [2024/03/22 14:11] (current) – [Revision History] cnaud
Line 1: Line 1:
-{{ classicon_clusternetwork.png}}+{{ picto_networkmanagementextended.png}}
 ====== Network Management Extended ====== ====== Network Management Extended ======
 ---- dataentry summary ---- ---- dataentry summary ----
 name                : Network management extended name                : Network management extended
-description_wiki    : Provides advanced classes for network management+description_wiki    : Provides advanced classes and solutions for network management
 index_hidden        : yes index_hidden        : yes
 level_hidden        : 1 level_hidden        : 1
-version             : 1.0.0 +collector_hidden    : no 
-release_dt          : 2020-12-11 +version             : 3.1.2 
-TeemIp              : 2.7+release_dt          : 2023-12-14 
 +TeemIp              : 3.1+ 
 +iTop                : 3.1+
 code                : teemip-network-mgmt-extended code                : teemip-network-mgmt-extended
 +localization        : English, French
 state               : stable state               : stable
 diffusion_hidden    : TeemIp wiki diffusion_hidden    : TeemIp wiki
-product_hidden      : included (standalone)+product_hidden      : Included
 module-lists_hidden :  module-lists_hidden : 
 keyword_tags        : CMDB, Network keyword_tags        : CMDB, Network
-dependencies_s      : 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/1.0.0/teemip-network-mgmt-extended-1.0.0-201.zip/download|teemip-network-mgmt-extended-1.0.0-201.zip]] +download_wiki       : [[https://sourceforge.net/projects/teemip/files/teemip%20-%20extensions/Network%20Management%20Extended/3.1.2/teemip-network-mgmt-extended-3.1.2-208.zip/download|teemip-network-mgmt-extended-3.1.2-208.zip]] 
-git hub_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.1
 ---- ----
- 
- 
- 
  
 This extension adds to TeemIp data model a few advanced classes dedicated to the network world. This extension adds to TeemIp data model a few advanced classes dedicated to the network world.
Line 30: Line 31:
  
 ===== Revision History ===== ===== Revision History =====
-^  Version  ^  Release Date  ^  Comments +^  Version  ^  Release Date   Status  ^  iTop \\ Min  ^  IPAM for iTop \\ Min   Comments  ^ 
-|  1.1.0  |  2021-04-01  | 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 | +|  **3.1.2**  |  2023-12-14  |  Supported  |  3.1.0  |  3.1.0  | Add Chinese (simplified) translation \\ Data samples have been added | 
-|  1.0.0  |  2020-12-11  | Initial revision |+|  3.1.1  |  2023-09-13  |  Supported  |  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.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 | 
 +|  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 |
  
 ===== Features ===== ===== Features =====
Line 42: Line 48:
  
 ===== 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 under certain conditions. Read the ’license.txt’ file in the TeemIp distribution. TeemIp 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 50: Line 56:
 There is no specific requirement with that extension. TeemIp Network Management Extended is anyway already embedded in TeemIp standalone starting with TeemIp 2.7. There is no specific requirement with that extension. TeemIp Network Management Extended is anyway already embedded in TeemIp standalone starting with TeemIp 2.7.
  
-When installed on an iTop application, make sure that 'IPAM for iTopis installed as well.+When installed on an iTop application, make sure that [[extensions:teemip-core-ip-mgmt|IPAM for iTop]] is installed as well.
  
  
Line 64: Line 70:
  
 ===== Aggregate Link ===== ===== Aggregate Link =====
-{{classicon_aggregatelink.png  }} +{{icons8-bursts-48.png  }} 
  
 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.
-FIXME 1:1 relation to be documented 
  
 === Aggregate Link Properties === === Aggregate Link Properties ===
Line 77: Line 82:
 | Status| Possible values: Active, Inactive  | No | | Status| Possible values: Active, Inactive  | No |
 | Device | Foreign key to a(n) Network Device | Yes | | Device | Foreign key to a(n) Network Device | Yes |
 +| Device->Location | Field of Device | N/A |
 +| Device->Organization | Field of Device | N/A | 
 | Peer aggregate | Foreign key to a(n) peer aggregate | No | | Peer aggregate | Foreign key to a(n) peer aggregate | No |
 | Description | Multiline character string  | No | | Description | Multiline character string  | No |
Line 87: Line 94:
 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_aggregatelink.png }}+{{ classdisplay_aggregatelink3x.png }}
  
 <note tip> <note tip>
Line 94: Line 101:
  
 ===== Cluster Network ===== ===== Cluster Network =====
-{{classicon_clusternetwork.png  }} +{{icons8-stack.png  }} 
 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 109: Line 116:
 | **Dates** ||| | **Dates** |||
 | Move to production date | Date (year-month-day) | No | | Move to production date | Date (year-month-day) | No |
 +| Replacement date | Date (year-month-day) | No |
 | **Other information ** ||| | **Other information ** |||
 | Description | Multiline character string  | No | | Description | Multiline character string  | No |
Line 129: Line 137:
 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_selectionform.png }}+{{ classcreate_clusternetwork_selectionform3x.png }}
  
 And click “Apply” to display the Cluster Network creation form: And click “Apply” to display the Cluster Network creation form:
  
-{{ classcreate_clusternetwork.png }}+{{ classcreate_clusternetwork3x.png }}
  
 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_ha.png }}+{{ classdisplay_clusternetwork_ha3x.png }}
  
 <note warning> <note warning>
Line 143: Line 151:
 </note> </note>
  
-{{ classdisplay_clusternetwork_impact.png }}+{{ classdisplay_clusternetwork_impact3x.png }} 
 ===== Network Device Component ===== ===== Network Device Component =====
-{{classicon_networkdevicecomponent.png  }} +{{icons8-slave-48.png  }} 
  
 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 179: Line 188:
 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_networkdevicecomponent.png }}+{{ classdisplay_networkdevicecomponent3x.png }}
  
 +===== Network Device =====
 +{{icons8-switch.png  }}
 +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 ===
 +^  Name  ^  Type  ^  Mandatory?  ^
 +| **General Information** |||
 +| Cluster network | Foreign key to a(n) Cluster Network | No |
 +| Cluster role | Possible values: Active, Standby | No |
 +| **More Information** |||
 +| SNMP Credentials | Foreign key to a(n) SNMP Credentials | No | 
 +| **Dates** |||
 +| Replacement date | Date (year-month-day) | No |
  
 +=== Tabs ===
 +^  Tab  ^  Description  ^
 +| Components | List of all network device components attached to this device |
 +| Aggregat links | List of all aggregate links attached to this device |
 +
 +=== Displaying a Network Device ===
 +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 }}
 +
 +===== Network Flow =====
 +
 +{{icons8-flow.png  }}
 +
 +Network Flows will help you to document the key flows that go through your network and to visualize them in a diagram.
 +
 +=== Network Flow Properties ===
 +^  Name  ^  Type  ^  Mandatory?  ^
 +| **General Information** |||
 +| Common Name | Alphanumeric string | Yes |
 +| Organization | Foreign key to a(n) Organization | Yes | 
 +| Status| Possible values: Implementation, Obsolete, Production  | No |
 +| Business criticality | Possible values: Low, Medium; High | No |
 +| Move to production date | Date (year-month-day) | No |
 +| Description | Multiline character string  | No |
 +| **Flow Details** |||
 +| Protocol | Possible values: UDP, TCP, UDP/TCP, Other | No |
 +| Source CI| Foreign key to a(n) FunctionalCI | No |
 +| Source port | Alphanumeric string | No |
 +| Destination CI | Foreign key to a(n) FunctionalCI | No |
 +| Destination port | Alphanumeric string | No |
 +| Capacity | Foreign key to a(n) Flow Capacity | No |
 +
 +<note>
 +Name of the object is automatically computed as the concatenation of Protocol - Name of the Source CI / Source port - Name of the Destination CI / Destination port
 +</note>
 +<note tip>
 +Access to this class of objects is protected by the [[extensions:teemip-network-mgmt-extended#network_security_manager_profile|Network Security Manager]] profile.
 +</note>
 +
 +=== 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:
 +
 +{{ classdisplay_networkflow.png }}
 +
 +
 +=== Outgoing Flow ===
 +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_outgoingflow2.png }}
 +
 +<note tip>
 +Only outgoing flows, i.e. flows from a source CI to a destination CI can be documented. Incoming flows cannot be drawn.
 +</note>
 ===== VLAN ===== ===== VLAN =====
-{{classicon_vlan.png  }} +{{icons8-hierarchy.png  }}  
 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 202: Line 278:
 | Logical network interfaces | Logical interfaces which are part of 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) |
 +
 +<note>
 +  * (1) This tab is brought by the [[extensions:teemip-dhcp-mgmt|TeemIp DHCP Management]] extension
 +</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 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_vlan.png }}+{{ classdisplay_vlan3x.png }}
  
  
 <note warning> <note warning>
-When migrating from previous version, the extension will copy the old 'VLAN tag' attribute in the name and will preset the tag to '0'. A CSV export / import needs to be done in order to correct the VLAN's name and set the proper Tag value. +When migrating from version **1.0.0**, the extension will copy the old 'VLAN tag' attribute in the name and will preset the tag to '0'. A CSV export / import needs to be done in order to correct the VLAN's name and set the proper Tag value. 
 </note> </note>
  
 +===== SNMP Credentials =====
 +{{icons8-switch-48-lock.png  }} 
 +This class allows you to document the different SNMP credentials that are used within your organization.
 +
 +=== SNMP Credentials Properties ===
 +^  Name  ^  Type  ^  Mandatory?  ^
 +| **General Information** |||
 +| Name | Alphanumeric string | Yes |
 +| Organization | Foreign key to a(n) Organization | Yes | 
 +| Description | Multiline character string  | No |
 +| **SNMP V1 / V2c** |||
 +| Community | Alphanumeric string | (*) |
 +| **SNMP V3** |||
 +| Security level | Possible values: None, NoAuthNoPriv, AuthNoPrivAuthPriv | No |
 +| Security name | Alphanumeric string | (*) |
 +| Authentication protocol | Possible values: MD5, SHA | (*) |
 +| Authentication passphrase | Encrypted alphanumeric string | (*) |
 +| Privacy Protocol | Possible values: DES, AES | (*) |
 +| Privacy Passphrase | Encrypted alphanumeric string | (*) |
 +| Context name | Alphanumeric string | No |
 +
 +(*) The mandatory nature of the attribute actually depends on the Security level value. [[extensions:teemip-network-mgmt-extended#Creating new SNMP Credentials|See below]].
 +
 +=== Tabs ===
 +^  Tab  ^  Description  ^
 +| Devices | List of all the devices using these credentials |
 +
 +<note tip>
 +Access to this class of objects is protected by the [[extensions:teemip-network-mgmt-extended#network_security_manager_profile|Network Security Manager]] profile.
 +</note>
 +
 +=== 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.
 +
 +{{ classcreate_snmpcredentials.png }}
 +
 +According to the selected value for the Security level, the attributes that are relevant for this level become mandatory :
 +
 +^  Security level  ^  Attributes  ^  Comment  ^
 +| None | Community | Basic SNMP V1 / V2C |
 +| NoAuthNoPriv | Security name | Basic SNMP V3 |
 +| AuthNoPriv | Security name \\ Authentication protocol, Authentication passphrase | SNMP V3 with authentication only |
 +| AuthPriv | Security name \\ Authentication protocol, Authentication passphrase \\ Privacy protocol, Privacy passphrase | SNMP V3 with authentication and privacy |
 ===== Typology Elements ===== ===== Typology Elements =====
  
-{{classicon_network_typology.png }} +{{icons8-new-item-48.png }} 
  
-Three new typological elements are brought by the extension:+Four new typological elements are brought by the extension:
  
 ^  Name  ^  Description  ^  Attributes  ^  Example  ^ ^  Name  ^  Description  ^  Attributes  ^  Example  ^
-| Interface Connector | Physical connector used on a physical interface | Name, Description, List of physical interfaces using it | RJ45 | 
-| Layer 2 Protocol | Layer 2 protocol used on a network interface | Name, Description, List of network interfaces using it | Ethernet, Trunking | 
 | Interface Speed | Speed available on a network interface | Name, Description, List of network interfaces using it | 10 Gb/s | | Interface Speed | Speed available on a network interface | Name, Description, List of network interfaces using it | 10 Gb/s |
 +| Layer 2 Protocol | Layer 2 protocol used on a network interface | Name, Description, List of network interfaces using it | Ethernet, Trunking | 
 +| Interface Connector | Physical connector used on a physical interface | Name, Description, List of physical interfaces using it | RJ45 | 
 +| Flow Capacity | Capacity provided by a network Flow | Name, Description, List of Network Flows using it | 256 Mb/s |
  
 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_typology.png }}+{{ overview_group_network_typology3x.png }}
  
 These typological elements change the different interfaces as follows: These typological elements change the different interfaces as follows:
Line 235: Line 359:
   * Foreign key toward Layer 2 Protocol is added   * Foreign key toward Layer 2 Protocol is added
  
-{{ classdisplay_logicalinterface.png }} +{{ classdisplay_logicalinterface3x.png }} 
  
  
Line 243: Line 367:
   * Foreign key toward Layer 2 Protocol is added   * Foreign key toward Layer 2 Protocol is added
  
-{{ classdisplay_networkdevicevirtualinterface.png }} +{{ classdisplay_networkdevicevirtualinterface3x.png }} 
  
  
Line 253: Line 377:
 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.
  
-{{ classdisplay_physicalinterface.png }}  +{{ classdisplay_physicalinterface3x.png }} 
  
 +===== Network Security Manager profile =====
 +Next to the CIs described here above, the extension brings a new User Profile: **Network Security Manager** which enables R/W access to Flow capacity, Network flow and SNMP Credentials objects. All persons in charge of network security should endorse this profile.
  
 +<note tip>
 +Not that the profile mus be used in conjunction with **Configuration Manager** profile. 
 +</note>
extensions/teemip-network-mgmt-extended.1616514444.txt.gz · Last modified: 2021/03/23 16:47 by cnaud