User Tools

Site Tools


collectors:teemip-ip-discovery-collector

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
Last revisionBoth sides next revision
collectors:teemip-ip-discovery-collector [2023/10/03 17:37] cnaudcollectors:teemip-ip-discovery-collector [2024/06/10 16:20] – [IP Discovery Data collector] cnaud
Line 7: Line 7:
 level_hidden        : 1 level_hidden        : 1
 collector_hidden    : yes collector_hidden    : yes
-version             : 3.1.1 +version             : 3.1.3 
-release_dt          : 2023-08-07+release_dt          : 2024-06-10
 TeemIp              : 3.x TeemIp              : 3.x
 iTop                : 3.x iTop                : 3.x
Line 20: Line 20:
 keyword_tags        : discovery, ping, fping, lookup, scan keyword_tags        : discovery, ping, fping, lookup, scan
 dependencies_s      :  dependencies_s      : 
-download_wiki       : [[https://sourceforge.net/projects/teemip/files/teemip%20-%20extensions/IP%20Discovery/IP%20Discovery%20-%20Collector/3.1.1/teemip-ip-discovery-collector-3.1.1-354.zip/download|teemip-ip-discovery-collector-3.1.1-354.zip]]+download_wiki       : [[https://sourceforge.net/projects/teemip/files/teemip%20-%20extensions/IP%20Discovery/IP%20Discovery%20-%20Collector/3.1.3/teemip-ip-discovery-collector-3.1.3-356.zip/download|teemip-ip-discovery-collector-3.1.3-356.zip]]
 github_wiki         : [[https://github.com/TeemIp/teemip-ip-discovery-collector|teemip-ip-discovery-collector]] github_wiki         : [[https://github.com/TeemIp/teemip-ip-discovery-collector|teemip-ip-discovery-collector]]
 php-max             : 8.1 php-max             : 8.1
Line 34: Line 34:
 ===== Revision History ===== ===== Revision History =====
 ^  Version  ^  Release Date  ^  Comments  ^ ^  Version  ^  Release Date  ^  Comments  ^
-|  3.1.1  |  2023-08-07  | Use fping as an option \\ Make sure collection order is respected \\ Complete list of optional attributes | +|  3.2.0  |  2024-xx-yy  | - Includes iTop Data Collector Base 1.4.0 \\ - PR [[https://github.com/TeemIp/teemip-ip-discovery-collector/pull/8|#8]] Fix fping command to not output stderr \\ - PR [[https://github.com/TeemIp/teemip-ip-discovery-collector/pull/7|#7]] Correctly call parent Prepare method for IPv4Collector | 
-|  3.1.0  |  2023-07-25  | Includes iTop Data Collector Base 1.3.0 \\ Implement collection plan feature of that collector base \\ Insure compatibility with PHP 8.1 | +|  **3.1.2**  |  2023-10-30  | - PR [[https://github.com/TeemIp/teemip-ip-discovery-collector/pull/6|#6]] IPv4SubnetCollector cleanup \\ - PR [[https://github.com/TeemIp/teemip-ip-discovery-collector/pull/5|#5]] Change IP Discovery Application synchro to use the primary_key as reconciliation  \\ - PR [[https://github.com/TeemIp/teemip-ip-discovery-collector/pull/4|#4]] Various cleanup\\ - Correct SF Bug [[https://sourceforge.net/p/teemip/tickets/140/|#140]]| 
-|  3.0.1  |  2022-09-21  | Align data model to TeemIp 3.x \\ Report number of discovered IPs at subnet level \\ Allow DHCP ranges to be skipped during discovery  |  +|  3.1.1  |  2023-08-07 Use fping as an option \\ Make sure collection order is respected \\ Complete list of optional attributes | 
-|  0.5.0  |  2020-10-20  | Improves reporting - Consider “connection refused” for scans | +|  3.1.0  |  2023-07-25 Includes iTop Data Collector Base 1.3.0 \\ Implement collection plan feature of that collector base \\ Insure compatibility with PHP 8.1 | 
-|  0.4.0  |  2019-10-11  | Improves IP lookup and handles DNS views | +|  3.0.1  |  2022-09-21 Align data model to TeemIp 3.x \\ Report number of discovered IPs at subnet level \\ Allow DHCP ranges to be skipped during discovery  |  
-|  0.3.0  |  2019-02-09  | Initial production release |+|  0.5.0  |  2020-10-20 Improves reporting - Consider “connection refused” for scans | 
 +|  0.4.0  |  2019-10-11 Improves IP lookup and handles DNS views | 
 +|  0.3.0  |  2019-02-09 Initial production release |
  
 ===== Features ===== ===== Features =====
Line 47: Line 49:
 The solution is made of 2 components: The solution is made of 2 components:
   * a [[collectors:teemip-ip-discovery-collector|discovery engine]], called the IP Discovery Data collector or the IP Discovery Application, that discovers IPs through pings, DNS reverse lookups and port scanning,   * a [[collectors:teemip-ip-discovery-collector|discovery engine]], called the IP Discovery Data 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 Data model, 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|TeemIp extension]], called the IP Discovery Data model, 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.
  
-{{  ipdiscoveryprinciples3x.png  }}+{{  extensions:ipdiscoveryprinciples3x.png?0x550  }}
  
 The IP Discovery Application is a standalone PHP software that extends iTop's collectors principles. It has been built on top of [[https://wiki.openitop.org/doku.php?id=extensions:itop-data-collector-base| iTop data collector base]] extension. TeemIp administrators may deploy one or several IP Discovery Collectors on different servers, including the one that hosts TeemIp. Each of these remote applications connects to TeemIp to retrieve: The IP Discovery Application is a standalone PHP software that extends iTop's collectors principles. It has been built on top of [[https://wiki.openitop.org/doku.php?id=extensions:itop-data-collector-base| iTop data collector base]] extension. TeemIp administrators may deploy one or several IP Discovery Collectors on different servers, including the one that hosts TeemIp. Each of these remote applications connects to TeemIp to retrieve:
Line 78: Line 80:
 ===== Installation ===== ===== Installation =====
  
-<note important>Do not install this extension in your webserver directories (like apache). otherwise your configuration files (with URLs, credentials) may be accessible from outside</note>+<note important> 
 +Do not install this extension in your webserver directories (like apache). otherwise your configuration files (with URLs, credentials) may be accessible from outside 
 +</note>
  
 Expand the content of the zip archive in a folder of the server that will run the discovery. Expand the content of the zip archive in a folder of the server that will run the discovery.
 +
 +<note warning>
 +When upgrading from the 3.1.1 version or older toward the 3.1.2 version, you must **delete** the 2 existing synchro data source **TeemIp Discovery Application** and **TeemIp IPv4 Subnet Discovery** that you can reach under the "Configuration / Synchronization Data Sources" menu.
 +</note>
 ===== Configuration ===== ===== Configuration =====
  
Line 159: Line 167:
 | ipv4_synchro_name | Name of the data IPv4 synchro that the discovery application will create in TeemIp. By default, the UUID will be appended to that string. | TeemIp IPv4 Discovery | | ipv4_synchro_name | Name of the data IPv4 synchro that the discovery application will create in TeemIp. By default, the UUID will be appended to that string. | TeemIp IPv4 Discovery |
 |subnetv4_synchro_name | Name of the IPv4 subnet data synchro that the discovery application will create in TeemIp. By default, the UUID will be appended to that string.| TeemIp IPv4 Subnet Discovery | |subnetv4_synchro_name | Name of the IPv4 subnet data synchro that the discovery application will create in TeemIp. By default, the UUID will be appended to that string.| TeemIp IPv4 Subnet Discovery |
-| ip_default_status | Status of IPs when create by the discovery application. Possible values: allocated, released, reserved, unassigned | unassigned |+| ip_default_status | Status of IPs when create by the discovery application. Possible values: allocated, discovered(*), released, reserved, unassigned | unassigned |
 | ip_default_view | String that defines the default view to be set on discovered IPs (if relevant) | "" | | ip_default_view | String that defines the default view to be set on discovered IPs (if relevant) | "" |
 | ping_absolute_path | Absolute path of the ping tool | /bin/ | | ping_absolute_path | Absolute path of the ping tool | /bin/ |
Line 166: Line 174:
 | fping_enable | Enable usage of fping command | yes | | fping_enable | Enable usage of fping command | yes |
  
 +(*) the **discovered** status is available with version 3.2+ of the [[extensions:teemip-ip-discovery|IP Discovery Data model]] extension  
  
 <note tip>The [[https://www.itophub.io/wiki/page?id=extensions%3Aitop-data-collector-base|Itop data collector]] documentation describes the configuration process in details</note> <note tip>The [[https://www.itophub.io/wiki/page?id=extensions%3Aitop-data-collector-base|Itop data collector]] documentation describes the configuration process in details</note>
  
-<note warning>Since TeemIp 2.3 or iTop 2.5, access to the REST web services is now restricted to the users having the profile REST Services User.</note>+<note warning>Access to the REST web services is restricted to the users having the profile REST Services User.</note>
  
 ===== Run the discovery ===== ===== Run the discovery =====
Line 217: Line 226:
 **//FPing//** **//FPing//**
  
-If it has been installed on the server and if it has not been disabled through the [[extensions:teemip-ip-discovery-collector#configuration|configuration file]], the [[https://fping.org/|fping]] command is used by default to ping IPs. Compared to ping, it provides enhanced performances and drastically reduces the time it takes to ping a network. it is called with the following parameters:+If it has been installed on the server and if it has not been disabled through the [[collectors:teemip-ip-discovery-collector#configuration|configuration file]], the [[https://fping.org/|fping]] command is used by default to ping IPs. Compared to ping, it provides enhanced performances and drastically reduces the time it takes to ping a network. it is called with the following parameters:
  
 ^ Parameter ^ Defined in ^ Default value ^ ^ Parameter ^ Defined in ^ Default value ^
collectors/teemip-ip-discovery-collector.txt · Last modified: 2024/06/10 16:21 by cnaud