This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
extensions:teemip-ip-discovery-collector [2023/03/15 17:39] – [Discovery functions] cnaud | extensions:teemip-ip-discovery-collector [2023/08/08 15:06] – [Discovery functions] cnaud | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | {{ icons8-binoculars-48.png}}====== IP Discovery - Collector ====== | + | {{ icons8-binoculars-48.png}} |
+ | ====== IP Discovery - Collector ====== | ||
---- dataentry summary ---- | ---- dataentry summary ---- | ||
name : IP Discovery - Collector | name : IP Discovery - Collector | ||
Line 5: | Line 6: | ||
index_hidden | index_hidden | ||
level_hidden | level_hidden | ||
- | version | + | version |
- | release_dt | + | release_dt |
TeemIp | TeemIp | ||
iTop : 3.x | iTop : 3.x | ||
Line 15: | Line 16: | ||
product_hidden | product_hidden | ||
module-lists_hidden : | module-lists_hidden : | ||
- | keyword_tags | + | keyword_tags |
dependencies_s | dependencies_s | ||
- | download_wiki | + | download_wiki |
github_wiki | github_wiki | ||
php-max | php-max | ||
Line 42: | Line 43: | ||
===== Revision History ===== | ===== Revision History ===== | ||
^ Version | ^ Version | ||
- | | 3.1.0 | 2023-04-01 | Includes iTop Data Collector Base 1.3.0 \\ Implement collection plan feature of that collector base \\ Insure compatibility with PHP 8.1 | | + | | 3.1.1 | 2023-08-07 |
+ | | 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.0.1 | 2022-09-21 | | 3.0.1 | 2022-09-21 | ||
| 0.5.0 | 2020-10-20 | | 0.5.0 | 2020-10-20 | ||
Line 65: | Line 67: | ||
At regular interval (defined by the administrator through a CRON command) the remote collector retrieves in TeemIp the list of networks that it has to discover and, for each of them, the list of IPs already registered. It, then, scans the network, computes | At regular interval (defined by the administrator through a CRON command) the remote collector retrieves in TeemIp the list of networks that it has to discover and, for each of them, the list of IPs already registered. It, then, scans the network, computes | ||
* New discovered IPs are created, | * New discovered IPs are created, | ||
- | * Ping, IP lookup or scan statuses are updated, | + | * Ping / fping, IP lookup or scan statuses are updated, |
* A few statics on the discovery are documented within each subnet. | * A few statics on the discovery are documented within each subnet. | ||
Line 82: | Line 84: | ||
===== Requirements ===== | ===== Requirements ===== | ||
- | On the application' | + | On the application' |
===== Installation ===== | ===== Installation ===== | ||
Line 139: | Line 141: | ||
< | < | ||
| | ||
- | < | + | < |
< | < | ||
- | < | + | |
+ | < | ||
+ | <!-- Absolute path for dig command - " | ||
+ | | ||
+ | |||
+ | <!-- fping usage may be disabled here --> | ||
+ | < | ||
- | </ | + | |
</ | </ | ||
Line 153: | Line 161: | ||
| collectors_launch_sequence | List of collectors to run | N/A | | | collectors_launch_sequence | List of collectors to run | N/A | | ||
| collector | Details for a collector class | N/A | | | collector | Details for a collector class | N/A | | ||
- | | name | Name of the collector class | TeemIpDiscoveryIPv4Collector | | + | | |
- | | | + | | |
- | | rank | Order of the collect amongst allother collectors | 1 | | + | | |
| contact_to_notify | The email address of an existing contact in TeemIp to be notified of the results of the synchronization. | john.doe@demo.com | | | contact_to_notify | The email address of an existing contact in TeemIp to be notified of the results of the synchronization. | john.doe@demo.com | | ||
| discovery_application_uuid | String that uniquely identifies the remote the IP Discovery Application in TeemIp. The string is automatically created at creation time of the IP Discovery object| FFF3_60D8_FEE6_520D | | | discovery_application_uuid | String that uniquely identifies the remote the IP Discovery Application in TeemIp. The string is automatically created at creation time of the IP Discovery object| FFF3_60D8_FEE6_520D | | ||
Line 163: | Line 171: | ||
| 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/ | | ||
+ | | fping_absolute_path | Absolute path of the fping tool | /usr/bin/ | | ||
| dig_absolute_path | Absolute path of the dig tool | /usr/bin/ | | | dig_absolute_path | Absolute path of the dig tool | /usr/bin/ | | ||
+ | | fping_enable | Enable usage of fping command | yes | | ||
Line 196: | Line 206: | ||
* The list of IPs already configured in TeemIp and their attributes, | * The list of IPs already configured in TeemIp and their attributes, | ||
* Connect to TeemIp to create the related Synchronization Data Sources (or check their definition if they already exist and update them if needed) | * Connect to TeemIp to create the related Synchronization Data Sources (or check their definition if they already exist and update them if needed) | ||
- | * Ping and / or look up and / or scan all subnets' | + | * Ping or fping (default) |
* Upload the collected data into TeemIp, | * Upload the collected data into TeemIp, | ||
* Synchronize the collected data with the existing TeemIp IPs, | * Synchronize the collected data with the existing TeemIp IPs, | ||
Line 212: | Line 222: | ||
==== Discovery functions ==== | ==== Discovery functions ==== | ||
- | The IP Discovery application discovers networks through | + | The IP Discovery application discovers networks through |
+ | |||
+ | **// | ||
+ | |||
+ | If it has been installed on the server and if it has not been disabled through the [[extensions: | ||
+ | |||
+ | ^ Parameter ^ Defined in ^ Default value ^ | ||
+ | | fping_absolute_path | / | ||
+ | | Ping timeout (s) | IP Discovery Application in TeemIp | 1 s | | ||
+ | |||
+ | The command is invoked through the exec PHP function. | ||
+ | |||
+ | < | ||
+ | |||
+ | For instance: | ||
+ | |||
+ | / | ||
**// | **// | ||
- | This is the standard and well known command based on icmp request. It is called | + | This is the standard and well known command based on icmp request. It is called |
^ Parameter ^ Defined in ^ Default value ^ | ^ Parameter ^ Defined in ^ Default value ^ | ||
- | | ping_absolute_path | / | + | | ping_absolute_path | / |
| Ping timeout (s) | IP Discovery Application in TeemIp | 1 s | | | Ping timeout (s) | IP Discovery Application in TeemIp | 1 s | | ||
The command is invoked through the exec PHP function. | The command is invoked through the exec PHP function. | ||
- | < | + | < |
For instance: | For instance: | ||
Line 236: | Line 262: | ||
^ Parameter ^ Defined in ^ Default value ^ | ^ Parameter ^ Defined in ^ Default value ^ | ||
- | | dig_absolute_path | / | + | | dig_absolute_path | / |
| DNS server #1 |IP Discovery Application in TeemIp - Can be a FQDN or an IP | < | | DNS server #1 |IP Discovery Application in TeemIp - Can be a FQDN or an IP | < | ||
| DNS server #1 |IP Discovery Application in TeemIp - Can be a FQDN or an IP | < | | DNS server #1 |IP Discovery Application in TeemIp - Can be a FQDN or an IP | < |