extensions:teemip-ip-discovery-collector
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
| extensions:teemip-ip-discovery-collector [2019/10/09 10:14] – [TeemIp IPv4 Discovery] cnaud | extensions:teemip-ip-discovery-collector [2023/08/08 15:07] – [Discovery functions] cnaud | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | {{ icons8-binoculars-48.png}} | ||
| ====== IP Discovery - Collector ====== | ====== IP Discovery - Collector ====== | ||
| ---- dataentry summary ---- | ---- dataentry summary ---- | ||
| Line 5: | Line 6: | ||
| index_hidden | index_hidden | ||
| level_hidden | level_hidden | ||
| - | version | + | version |
| - | release_dt | + | release_dt |
| - | TeemIp | + | TeemIp |
| + | iTop : 3.x | ||
| code : teemip-ip-discovery-collector | code : teemip-ip-discovery-collector | ||
| - | state : | + | localization |
| + | state : | ||
| diffusion_hidden | diffusion_hidden | ||
| product_hidden | product_hidden | ||
| module-lists_hidden : | module-lists_hidden : | ||
| - | keyword_tags | + | keyword_tags |
| dependencies_s | dependencies_s | ||
| - | download_url | + | download_wiki |
| + | github_wiki | ||
| + | php-max | ||
| ---- | ---- | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 28: | Line 43: | ||
| ===== Revision History ===== | ===== Revision History ===== | ||
| ^ Version | ^ Version | ||
| - | | 0.4.0 | | + | | 3.1.1 | 2023-08-07 |
| + | | 3.1.0 | 2023-07-25 | ||
| + | | 3.0.1 | 2022-09-21 | ||
| + | | 0.5.0 | 2020-10-20 | ||
| + | | 0.4.0 | | ||
| | 0.3.0 | 2019-02-09 | | 0.3.0 | 2019-02-09 | ||
| Line 39: | Line 58: | ||
| * a [[extensions: | * a [[extensions: | ||
| - | {{ | + | {{ |
| The IP Discovery Application is a standalone PHP software that extends iTop's collectors principles. It has been built on top of [[https:// | The IP Discovery Application is a standalone PHP software that extends iTop's collectors principles. It has been built on top of [[https:// | ||
| Line 48: | 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. | ||
| - | < | + | < |
| Should your network be compartmentalized by different firewalls, the different instances will allow you to bypass the restrictions imposed by the firewalls: limited pings or udp / tcp connections, | Should your network be compartmentalized by different firewalls, the different instances will allow you to bypass the restrictions imposed by the firewalls: limited pings or udp / tcp connections, | ||
| </ | </ | ||
| Line 57: | Line 76: | ||
| ===== Licensing ===== | ===== Licensing ===== | ||
| - | TeemIp IP Discovery | + | TeemIp IP Discovery |
| ===== Limitations ===== | ===== Limitations ===== | ||
| Line 65: | Line 84: | ||
| ===== Requirements ===== | ===== Requirements ===== | ||
| - | On the application' | + | On the application' |
| ===== Installation ===== | ===== Installation ===== | ||
| - | + | <note important> | |
| 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. | ||
| Line 86: | Line 104: | ||
| < | < | ||
| + | <!-- Class collection sequence --> | ||
| + | < | ||
| + | <!-- IPv4 addresses --> | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | <!-- IPv4 subnets --> | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | <!-- IP applications --> | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | | ||
| <!-- Synchronization parameters --> | <!-- Synchronization parameters --> | ||
| < | < | ||
| Line 97: | Line 137: | ||
| </ | </ | ||
| - | <!-- IP Addresses Parameters --> | + | |
| < | < | ||
| < | < | ||
| | | ||
| - | < | + | |
| < | < | ||
| - | < | + | |
| + | < | ||
| + | <!-- Absolute path for dig command - " | ||
| + | | ||
| + | |||
| + | <!-- fping usage may be disabled here --> | ||
| + | < | ||
| - | </ | + | |
| </ | </ | ||
| Line 113: | Line 159: | ||
| | itop_login | Login (user account) for connecting to TeemIp. Must have admin rights for executing the data synchro. | admin | | | itop_login | Login (user account) for connecting to TeemIp. Must have admin rights for executing the data synchro. | admin | | ||
| | itop_password | Password for the iTop account. | admin_pwd | | | itop_password | Password for the iTop account. | admin_pwd | | ||
| + | | collectors_launch_sequence | List of collectors to run | N/A | | ||
| + | | collector | Details for a collector class | N/A | | ||
| + | | | ||
| + | | | ||
| + | | | ||
| | 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 120: | 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 | | ||
| <note tip>The [[https:// | <note tip>The [[https:// | ||
| - | <note warning> | + | <note warning> |
| ===== Run the discovery ===== | ===== Run the discovery ===== | ||
| Line 138: | Line 191: | ||
| ^ Option ^ Meaning ^ default value ^ | ^ Option ^ Meaning ^ default value ^ | ||
| - | | < | + | | < |
| - | | < | + | | < |
| - | | < | + | | < |
| - | | < | + | | < |
| + | | < | ||
| + | | < | ||
| | < | | < | ||
| + | | < | ||
| Once invoked through the command line, the discovery application will: | Once invoked through the command line, the discovery application will: | ||
| - | | + | |
| - | - Connect | + | |
| - | | + | |
| - | | + | |
| - | | + | |
| - | | + | * Ping or fping (default) |
| - | | + | |
| - | | + | |
| - | | + | |
| + | * Update statistics of discovery application. | ||
| ==== Scheduling ==== | ==== Scheduling ==== | ||
| Line 165: | 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 189: | 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 | < | ||
| Line 227: | Line 300: | ||
| * If no answered is received, a test is done with TCP. | * If no answered is received, a test is done with TCP. | ||
| - | ===== Synchronize | + | According to the parameter //Consider “connection refused” as valid//, a scan that fails with error 111 (connection is refused) may be considered as valid from a discovery standpoint. |
| + | |||
| + | ===== Synchronize | ||
| Discovery results of an IP Discovery Application are fed back to TeemIp through standard synchro data sources. Every IP discovery application will automatically create its own synchro data sources and will use them to push its finding and statistics into TeemIp, systematically, | Discovery results of an IP Discovery Application are fed back to TeemIp through standard synchro data sources. Every IP discovery application will automatically create its own synchro data sources and will use them to push its finding and statistics into TeemIp, systematically, | ||
| - | These synchro data sources can be listed and managed from the Synchronization Data Sources menu under the Admin tools section. | + | These synchro data sources can be listed and managed from the Synchronization Data Sources menu under the Admin tools section. |
| + | |||
| + | |||
| + | ==== TeemIp Discovery Application ==== | ||
| + | |||
| + | {{ details_synchrodatasource_applicationdiscovery3x.png }} | ||
| + | |||
| + | Default parameters for a given data source are defined in the remote IP Discovery application configuration file. | ||
| + | * The UUID of the application is appended to the name of the synchro data source for an easy identification, | ||
| + | * Statistics on discovery durations are updated. | ||
| + | |||
| + | Reconciliation of the Application is made on the UUID. The following attributes may be affected by this synchro: | ||
| + | |||
| + | ^ Name ^ When ? ^ Comment ^ | ||
| + | | Last discovery date | Creation and update | | | ||
| + | | Duration | Creation and update | | | ||
| ==== TeemIp IPv4 Discovery ==== | ==== TeemIp IPv4 Discovery ==== | ||
| - | {{ details_synchrodatasource_ipdiscovery.png }} | + | {{ details_synchrodatasource_ipdiscovery3x.png }} |
| Default parameters for a given data source are defined in the remote IP Discovery application configuration file. | Default parameters for a given data source are defined in the remote IP Discovery application configuration file. | ||
| Line 257: | Line 348: | ||
| <note tip> | <note tip> | ||
| - | The discovery collector automatically detects if the Zone management | + | The discovery collector automatically detects if the Zone Management |
| * If this is the case: the collector handles the DNS view attribute brought by the extension. | * If this is the case: the collector handles the DNS view attribute brought by the extension. | ||
| - | * If this is NOT the ase: the DNS view attribute is not managed. | + | * If this is NOT the case: the DNS view attribute is not managed. |
| </ | </ | ||
| ==== TeemIp IPv4 Subnet Discovery ==== | ==== TeemIp IPv4 Subnet Discovery ==== | ||
| - | {{ details_synchrodatasource_subnetdiscovery.png }} | + | {{ details_synchrodatasource_subnetdiscovery3x.png }} |
| Default parameters for a given data source are defined in the remote IP Discovery application configuration file. | Default parameters for a given data source are defined in the remote IP Discovery application configuration file. | ||
| Line 274: | Line 365: | ||
| | Last discovery date | Update | | | Last discovery date | Update | | ||
| | Ping duration | Update | | | Ping duration | Update | | ||
| + | | Ping # | Update | | ||
| | IP lookup duration | Update | | | IP lookup duration | Update | | ||
| + | | IP Lookup # | Update | | ||
| | Scan duration | Update | | | Scan duration | Update | | ||
| - | + | | Scan # | Update | | |
| - | + | ||
| - | As usual with synchro data sources, the Status tab will provide information on every synchronization that occurred between the remote IP Discovery application and TeemIp. | + | |
| - | + | ||