User Tools

Site Tools


extensions:teemip-ip-discovery-extension

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-ip-discovery-extension [2020/04/16 12:36] – [Data entry] cnaudextensions:teemip-ip-discovery-extension [2024/01/24 10:15] (current) – [Revision History] cnaud
Line 1: Line 1:
 +{{ icons8-binoculars-48.png}}
 ====== IP Discovery - Extension ====== ====== IP Discovery - Extension ======
 ---- dataentry summary ---- ---- dataentry summary ----
Line 4: Line 5:
 description_wiki    : TeemIp solution to discover IP addresses description_wiki    : TeemIp solution to discover IP addresses
 index_hidden        : no index_hidden        : no
-level_hidden        : 2 +level_hidden        : 
-version             : 0.5.1 +collector_hidden    : no 
-release_dt          : 2020-04-14 +version             : 3.1.1 
-TeemIp              : 2.6+release_dt          : 2023-12-11 
 +TeemIp              : 3.1+ 
 +iTop                : 3.1+
 code                : teemip-ip-discovery code                : teemip-ip-discovery
 +localization        : English, French, German
 state               : stable state               : stable
 diffusion_hidden    : TeemIp wiki diffusion_hidden    : TeemIp wiki
Line 15: Line 19:
 keyword_tags        : discovery, ping, lookup, scan keyword_tags        : discovery, ping, lookup, scan
 dependencies_s      : teemip-ip-mgmt, teemip-ipv6-mgmt, teemip-network-mgmt dependencies_s      : teemip-ip-mgmt, teemip-ipv6-mgmt, teemip-network-mgmt
-download_url        : https://sourceforge.net/projects/teemip/files/teemip%20-%20extensions/IP%20Discovery/IP%20Discovery%20-%20Extension/0.5.1/teemip-ip-discovery-0.5.1-567.zip/download+download_wiki       [[https://sourceforge.net/projects/teemip/files/teemip%20-%20extensions/IP%20Discovery/IP%20Discovery%20-%20Extension/3.1.1/teemip-ip-discovery-3.1.1-303.zip/download|teemip-ip-discovery-3.1.1-303.zip]] 
 +github_wiki         : [[https://github.com/TeemIp/teemip-ip-discovery|teemip-ip-discovery]] 
 +php-max             : 8.1
 ---- ----
- 
- 
- 
- 
- 
- 
  
  
Line 33: Line 33:
 ===== Revision History ===== ===== Revision History =====
 ^  Version  ^  Release Date  ^  Comments  ^ ^  Version  ^  Release Date  ^  Comments  ^
 +|  3.1.1  |  2023-12-11  | Add Chinese (simplified) translation |
 +|  3.1.0  |  2023-06-21  | XML structure has moved to 3x |
 +|  3.0.1  |  2022-09-01  | Adopt 3.x icon style \\ Report number of discovered IPs at subnet level \\ Allow DHCP ranges to be skipped during discovery \\ Explode FQDN of discovered IPs into short name and domain name |
 +|  1.0.0  |  2021-04-01  | Align extension structure with new guidelines |
 +|  0.6.0  |  2020-10-20  | Enhance discovery reporting - consider "connection refused" for scans |
 |  0.5.1  |  2020-04-14  | Move IP Application menu under the new Tools shortcut | |  0.5.1  |  2020-04-14  | Move IP Application menu under the new Tools shortcut |
 |  0.4.0  |  2019-10-11  | Enable / disable discovery of subnet attached to an IP Discovery application | |  0.4.0  |  2019-10-11  | Enable / disable discovery of subnet attached to an IP Discovery application |
Line 46: Line 51:
  
 The solution is made of 2 components: The solution is made of 2 components:
-   * a [[extensions:teemip-ip-discovery-collector|discovery engine]], called the IP Discovery Collector or the IP Discovery Application, that discovers IPs through pings, DNS reverse lookups and port scanning,+  * a [[extensions:teemip-ip-discovery-collector|discovery engine]], called the IP Discovery Collector or the IP Discovery Application, that discovers IPs through pings, DNS reverse lookups and port scanning,
   * a [[extensions:teemip-ip-discovery-extension|TeemIp extension]], called the IP Discovery Extension, that adapts TeemIp's standard data model to store the discovery outputs and enables communication between a TeemIp instance and the different discovery engines deployed on the network.   * a [[extensions:teemip-ip-discovery-extension|TeemIp extension]], called the IP Discovery Extension, that adapts TeemIp's standard data model to store the discovery outputs and enables communication between a TeemIp instance and the different discovery engines deployed on the network.
  
-{{  ipdiscoveryprinciples.png  }}+{{  ipdiscoveryprinciples3x.png  }}
  
  
Line 63: Line 68:
 ===== Licensing ===== ===== Licensing =====
  
-TeemIp IP Discovery solution 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 it under certain conditions. Read the ’license.txt’ file in the distribution. TeemIp IP Discovery is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.  +TeemIp IP Discovery 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 IP Discovery under certain conditions. Read the ’license.txt’ file in the distribution. TeemIp IP Discovery is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.  
  
 The nice binocular icon attached to the IP Discovery Application in TeemIp has been found on [[https://www.iconfinder.com/|IconFinder]] and [[http://http://www.icons-land.com/|Icons Land]]. The nice binocular icon attached to the IP Discovery Application in TeemIp has been found on [[https://www.iconfinder.com/|IconFinder]] and [[http://http://www.icons-land.com/|Icons Land]].
Line 87: Line 92:
 ===== IP Discovery menu ===== ===== IP Discovery menu =====
  
-Once installed, the extension will alter the IP Management menu by adding a sub menu group next to the IPv6 Shorcuts+Once installed, the extension will alter the IP Management menu by adding a sub menu group under the Tools section
  
-{{ details_menu_ipdiscovery.png }}+{{ details_menu_ipdiscovery3x.png }}
  
-The "IP Discovery" link provides statistics on IP addresses and discovery results.+==== IP Discovery menu ==== 
 +It provides statistics on IP addresses and discovery results.
  
-{{ ipdiscovery_dashboard.png }}+{{ ipdiscovery_dashboard3x.png }}
  
 Clicking on the count figure next to an IP Discovery application provides the list of subnets discovered by the given application. Clicking on the count figure next to an IP Discovery application provides the list of subnets discovered by the given application.
 +
 +==== Listing IP Discovery applications ====
 +
 +The IP Discovery applications shorcut displays all the applications that belong to the selected organization. 
 +
 +{{ classlist_ipdiscovery3x.png }}
  
 ===== IP Discovery applications ===== ===== IP Discovery applications =====
  
-{{classicon_ipdiscovery.png  }}+{{icons8-binoculars-48.png  }}
  
 These objects define the remote applications that actually perform the discovery work. They enable these remote applications to communicate with TeemIp, list the subnets to be discovered and define how they should be discovered. These objects define the remote applications that actually perform the discovery work. They enable these remote applications to communicate with TeemIp, list the subnets to be discovered and define how they should be discovered.
Line 109: Line 121:
 | Organization | Foreign key to a(n) Organization | Yes | | Organization | Foreign key to a(n) Organization | Yes |
 | Status | Possible values: implementation, production, obsolete | No | | Status | Possible values: implementation, production, obsolete | No |
-| Business criticity | Possible values: medium, high, low | No |+| Business criticality | Possible values: medium, high, low | No |
 | Location | Foreign key to a(n) Location | No | | Location | Foreign key to a(n) Location | No |
 | Description | Multiline character string  | No | | Description | Multiline character string  | No |
 | Requestor | Foreign key to a(n) Person | No | | Requestor | Foreign key to a(n) Person | No |
 | Move to production date | Date (year-month-day) | No | | Move to production date | Date (year-month-day) | No |
-| UUID | Alphanumeric string | No |+| UUID | Alphanumeric string | Read Only | 
 +| **Operations** || 
 +| DHCP ranges discovery enabled | Possible values: yes, no | No 
 +| Last discovery date | Date (year-month-day hours:minutes:seconds) | Read Only |   
 +| Duration | Time ( hours:minutes:seconds) | Read Only |
 | **Ping Function** ||| | **Ping Function** |||
 | Ping enabled | Possible values: yes, no| No | | Ping enabled | Possible values: yes, no| No |
-| Ping timeout | Integer | No |+| Ping timeout (s) | Integer | No |
 | **IP lookup Function** ||| | **IP lookup Function** |||
 | IP lookup enabled | Possible values: yes, no| No | | IP lookup enabled | Possible values: yes, no| No |
Line 126: Line 142:
 | Port number | Integer | No | | Port number | Integer | No |
 | Protocol | Possible values: tcp, udp, both | No | | Protocol | Possible values: tcp, udp, both | No |
-| Scan timeout | Integer | No |+| Scan timeout (s) | Integer | No | 
 +| Consider "connection refused" as valid | Possible values: yes, no| No |
  
 ==== Tabs ==== ==== Tabs ====
Line 133: Line 150:
 | Documents | All the documents linked to this object | | Documents | All the documents linked to this object |
 | Managed IPv4 subnets | All the IPv4 subnets that the application must discover | | Managed IPv4 subnets | All the IPv4 subnets that the application must discover |
- 
-==== Listing IP Discovery applications ==== 
- 
-The IP Discovery applications shorcut displays all the applications that belong to the selected organization.  
- 
-{{ classlist_ipdiscovery.png }} 
  
 ==== Creating a new IP Discovery application ==== ==== Creating a new IP Discovery application ====
Line 144: Line 155:
 From the listing view, click on the “New…” menu to display the creation form. From the listing view, click on the “New…” menu to display the creation form.
  
-{{ classcreate_ipdiscovery.png }}+{{ classcreate_ipdiscovery3x.png }}
    
   * UUID attribute uniquely identifies the remote IP Discovery application and must be unique across TeemIp, regardless the organization it belongs to. UUID is automatically generated by TeemIp when the application is created.   * UUID attribute uniquely identifies the remote IP Discovery application and must be unique across TeemIp, regardless the organization it belongs to. UUID is automatically generated by TeemIp when the application is created.
   * Ping, IP Lookup and Scan functions can be enabled or disabled globally for the application. If enabled, these function can be disabled individually for each subnets to be scanned.   * Ping, IP Lookup and Scan functions can be enabled or disabled globally for the application. If enabled, these function can be disabled individually for each subnets to be scanned.
-  * DNS Server #1 and 2 can either be an IP address or a domain name.+  * DNS Server #1 and #2 can either be an IP address or a domain name.
  
  
Line 157: Line 168:
 ===== Subnets ===== ===== Subnets =====
  
-{{classicon_ipv4subnet.png  }} +{{icons8-subnet-48.png  }} 
  
 The extension enhances the IP Subnet datamodel so that an IP discovery application can look after them. For that purpose, the following attributes are added: The extension enhances the IP Subnet datamodel so that an IP discovery application can look after them. For that purpose, the following attributes are added:
Line 163: Line 174:
 ==== Properties ==== ==== Properties ====
 ^  Name  ^  Type  ^  Mandatory?  ^ ^  Name  ^  Type  ^  Mandatory?  ^
-| **Discovery Information** |||+| **Discovery: application parameters** |||
 | IP Discovery application | Foreign key to a(n) IP Discovery application | No | | IP Discovery application | Foreign key to a(n) IP Discovery application | No |
 +| IP discovery DHCP ranges discovery enabled | Possible values: yes, no | Read only |
 +| IP discovery ping enabled | Foreign attribute of the application | Read only |
 +| IP discovery IP lookup enabled | Foreign attribute of the application | Read only | 
 +| IP discovery scan enabled | Foreign attribute of the application | Read only |
 +| IP discovery considers scan "connection refused" as valid | Foreign attribute of the application | Read only | 
 +| **Discovery: subnet parameters** |||
 | Discovery activated | Possible values: yes, no | No | | Discovery activated | Possible values: yes, no | No |
-Last discovery date Date when the last discovery run for that subnet | No | +DHCP ranges discovery enabled for subnet Possible values: yes, no | No | 
-| IP discovery ping enabled | Foreign attribute of the application | No| +| Ping enabled for subnet | Possible values: yes, no | No | 
-Ping enabled for subnet | Possible values: yes, no| No | +| IP lookup enabled for subnet Possible values: yes, no | No | 
-| Ping duration | Time it took to ping the whole subnet | No +Scan enabled for subnet | Possible values: yes, no | No 
-IP discovery IP lookup enabled Foreign attribute of the application No|  +| Considers scan "connection refused" as valid | Possible values: yes, no | No |  
-| IP lookup enabled for subnet | Possible values: yes, no| No +| **Discovery: statistics** ||| 
-| IP lookup duration | Time it took to lookup the whole subnet | No +| Last discovery date | Date and time (year-month-day hh:mm:ss) | Read only 
-| IP discovery scan enabled Foreign attribute of the application No| +| Ping duration | Time it took to ping the subnet | Read only 
-| Scan enabled for subnet | Possible values: yes, no| No +Ping # Number of IPs discovered by ping Read only 
-| Scan duration | Time it took to scan the whole subnet | No |+| IP lookup duration | Time it took to lookup the whole subnet | Read only 
 +| IP lookup # Number of IPs discovered by IP lookup Read only 
 +| Scan duration | Time it took to scan the whole subnet | Read only | 
 +| Scan # | Number of IPs discovered by scan | Read only |
  
-==== Creating a new subnet ====+==== Details of an IPv4 subnet ====
  
-IP discovery attributes alter the subnet creation form as follows:+IP discovery attributes alter the subnet detailed page as follows:
  
-{{ classcreate_ipv4subnet_ipdiscovery.png }}+{{ classdetails_ipv4subnet3x_ipdiscovery.png }}
  
 The 3 attributes Ping, IP lookup and Scan enabled for subnet may change the way the subnet's IP discovery application will discover the subnet: The 3 attributes Ping, IP lookup and Scan enabled for subnet may change the way the subnet's IP discovery application will discover the subnet:
Line 198: Line 218:
 From the detailed display of a subnet, selecting 'List & Pick' under 'Other Actions' menu will show: From the detailed display of a subnet, selecting 'List & Pick' under 'Other Actions' menu will show:
  
-{{ classlistips_ipv4subnet_ipdiscovery.png }}+{{ classlistips_ipv4subnet_ipdiscovery3x.png }}
  
 The following image may appear next to each IP of the subnet: The following image may appear next to each IP of the subnet:
Line 213: Line 233:
 ==== IP Addresses ==== ==== IP Addresses ====
  
-{{classicon_ipv4address.png  }} +{{icons8-rj45-48.png  }} 
  
 The IP Discovery Module alters as well the IPAddress datamodel so that discovery informations related to IP addresses can be displayed at their level. The following attributes are added: The IP Discovery Module alters as well the IPAddress datamodel so that discovery informations related to IP addresses can be displayed at their level. The following attributes are added:
Line 220: Line 240:
 ^  Name  ^  Type  ^  Can be edited?  ^ ^  Name  ^  Type  ^  Can be edited?  ^
 | **Discovery Information** ||| | **Discovery Information** |||
-| IP Discovery application name | Alphanumeric string | No +| IP Discovery application name | Alphanumeric string | Read only 
-| Last date of discovery | Date [ No |  +| Last date of discovery | Date (year-month-day hours:minutes:seconds) | Read only |  
-| Responds to ping | Possible values: yes, no | No+| Responds to ping | Possible values: yes, no | Read only 
-| Responds to IP lookup| Possible values: yes, no | No+| Responds to IP lookup| Possible values: yes, no | Read only 
-| FQDN from IP lookup |Alphanumeric string | No +| FQDN from IP lookup |Alphanumeric string | Read only
-| Responds to scan | Possible values: yes, no | No|+| Responds to scan | Possible values: yes, no | Read only |
  
-=== Creating a new IP address === +=== Details of an IP address === 
-IP discovery attributes alter the address creation form as follows:+IP discovery attributes alter the address details screen as follows:
  
-{{ classcreate_ipv4address_ipdiscovery.png }}+{{ classdetails_ipv4address_ipdiscovery3x.png }}
  
   * The IP discovery application is inherited from the subnet that that IP belongs to.   * The IP discovery application is inherited from the subnet that that IP belongs to.
-  * All other IP discovery parameters are, of course, **read only** as they are the result of the discovery process.+  * All IP discovery parameters are, of course, **read only** as they are the result of the discovery process. 
 + 
 +=== Explode discovered FQDN === 
 +In the case where IP lookup has been enabled for a subnet, discovery operations may return FQDN for IPs and it may happen that these FQDNs differs from the registered one. In such case, the "Other Actions" menu offers the possibility to explode this FQDN into a short name and a domain name and to register them as IP attributes. This action is highlighted in the red circle of the image above. 
 + 
 +When the action is launched, TeemIp will try to best match a registered domain name within the FQDN. If found, the preceding characters in the FQDN will be considered as the IP's short name, as long as it complies with the hostname format. Our above example will give: 
 + 
 +{{ classdetails_ipv4address_ipdiscovery3x_nomenu.png }} 
 + 
 +<note tip> 
 +  * The **Explode discovered FQDN** menu is available at Subnet, IP range and IP levels... as long as the IP Lookup has been authorized in the discovery parameters of the related subnet. 
 +  * When applied at Subnet or IP range level, all IPs contained in them will have their discovered FQDN exploded, if feasible. 
 +</note> 
 +<note warning> 
 +The **Explode discovered FQDN** menu will not appear if there is no domain name that can match with the discovered FQDN ! 
 +</note>
  
extensions/teemip-ip-discovery-extension.1587033362.txt.gz · Last modified: 2020/04/16 12:36 by cnaud