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-extension [2019/10/26 11:07] – [Data entry] cnaud | extensions:teemip-ip-discovery-extension [2023/09/14 22:08] – [IP Discovery - Extension] 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 | description_wiki | ||
index_hidden | index_hidden | ||
- | level_hidden | + | level_hidden |
- | version | + | collector_hidden |
- | release_dt | + | version |
- | TeemIp | + | release_dt |
+ | TeemIp | ||
+ | iTop : 3.x | ||
code : teemip-ip-discovery | code : teemip-ip-discovery | ||
+ | localization | ||
state : stable | state : stable | ||
diffusion_hidden | diffusion_hidden | ||
Line 15: | Line 19: | ||
keyword_tags | keyword_tags | ||
dependencies_s | dependencies_s | ||
- | download_url | + | download_wiki |
+ | github_wiki | ||
+ | php-max | ||
---- | ---- | ||
- | |||
- | |||
- | |||
- | |||
Line 31: | Line 33: | ||
===== Revision History ===== | ===== Revision History ===== | ||
^ Version | ^ Version | ||
+ | | 3.1.0 | 2023-06-21 | ||
+ | | 3.0.1 | 2022-09-01 | ||
+ | | 1.0.0 | 2021-04-01 | ||
+ | | 0.6.0 | 2020-10-20 | ||
+ | | 0.5.1 | 2020-04-14 | ||
| 0.4.0 | 2019-10-11 | | 0.4.0 | 2019-10-11 | ||
| 0.3.0 | 2019-08-29 | | 0.3.0 | 2019-08-29 | ||
Line 43: | Line 50: | ||
The solution is made of 2 components: | The solution is made of 2 components: | ||
- | * a [[extensions: | + | |
* a [[extensions: | * a [[extensions: | ||
- | {{ | + | {{ |
Line 60: | Line 67: | ||
===== Licensing ===== | ===== Licensing ===== | ||
- | TeemIp IP Discovery | + | TeemIp IP Discovery |
The nice binocular icon attached to the IP Discovery Application in TeemIp has been found on [[https:// | The nice binocular icon attached to the IP Discovery Application in TeemIp has been found on [[https:// | ||
Line 84: | Line 91: | ||
===== 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 |
+ | 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 106: | Line 120: | ||
| Organization | Foreign key to a(n) Organization | Yes | | | Organization | Foreign key to a(n) Organization | Yes | | ||
| Status | Possible values: implementation, | | Status | Possible values: implementation, | ||
- | | Business | + | | Business |
| Location | Foreign key to a(n) Location | No | | | Location | Foreign key to a(n) Location | No | | ||
| Description | Multiline character string | | Description | Multiline character string | ||
| 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 |
+ | | **Operations** || | ||
+ | | DHCP ranges discovery enabled | Possible values: yes, no | No | | ||
+ | | Last discovery date | Date (year-month-day hours: | ||
+ | | Duration | Time ( hours: | ||
| **Ping Function** ||| | | **Ping Function** ||| | ||
| Ping enabled | Possible values: yes, no| No | | | Ping enabled | Possible values: yes, no| No | | ||
- | | Ping timeout | Integer | No | | + | | Ping timeout |
| **IP lookup Function** ||| | | **IP lookup Function** ||| | ||
| IP lookup enabled | Possible values: yes, no| No | | | IP lookup enabled | Possible values: yes, no| No | | ||
Line 123: | Line 141: | ||
| 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 |
+ | | Consider " | ||
==== Tabs ==== | ==== Tabs ==== | ||
Line 130: | Line 149: | ||
| 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 141: | Line 154: | ||
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 154: | Line 167: | ||
===== 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 160: | Line 173: | ||
==== Properties ==== | ==== Properties ==== | ||
^ Name ^ Type ^ Mandatory? | ^ Name ^ Type ^ Mandatory? | ||
- | | **Discovery | + | | **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 " | ||
+ | | **Discovery: | ||
| Discovery activated | Possible values: yes, no | No | | | Discovery activated | Possible values: yes, no | No | | ||
- | | Last discovery | + | | DHCP ranges |
- | | IP discovery ping enabled | Foreign attribute of the application | + | | Ping enabled |
- | | Ping enabled for subnet | Possible values: yes, no| No | | + | | IP lookup |
- | | 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 | + | | Considers scan " |
- | | IP lookup enabled for subnet | Possible values: yes, no| No | | + | | **Discovery: |
- | | 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 | + | | Ping duration | Time it took to ping the subnet | Read only | |
- | | Scan enabled for subnet | Possible values: yes, no| No | | + | | Ping # | Number |
- | | 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 | ||
+ | | 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 | + | IP discovery attributes alter the subnet |
- | {{ 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' | The 3 attributes Ping, IP lookup and Scan enabled for subnet may change the way the subnet' | ||
Line 195: | Line 217: | ||
From the detailed display of a subnet, selecting 'List & Pick' under 'Other Actions' | From the detailed display of a subnet, selecting 'List & Pick' under 'Other Actions' | ||
- | {{ 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 210: | Line 232: | ||
==== 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 217: | Line 239: | ||
^ 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: |
- | | 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 | + | IP discovery attributes alter the address |
- | {{ 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" | ||
+ | |||
+ | 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 warning> | ||
+ | The **Explode discovered FQDN** menu will not appear if there is no domain name that can match with the discovered FQDN ! | ||
+ | </ | ||