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 [2019/03/06 18:40] – cnaud | extensions:teemip-ip-discovery [2024/04/04 14:44] – [Revision History] cnaud | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | {{ picto_ipdiscoverydatamodel.png}} | ||
+ | ====== IP Discovery Data model ====== | ||
+ | ---- dataentry summary ---- | ||
+ | name : IP Discovery Data model | ||
+ | description_wiki | ||
+ | index_hidden | ||
+ | level_hidden | ||
+ | collector_hidden | ||
+ | version | ||
+ | release_dt | ||
+ | TeemIp | ||
+ | iTop : 3.x | ||
+ | code : teemip-ip-discovery | ||
+ | localization | ||
+ | state : stable | ||
+ | diffusion_hidden | ||
+ | product_hidden | ||
+ | module-lists_hidden : | ||
+ | keyword_tags | ||
+ | dependencies_s | ||
+ | download_wiki | ||
+ | github_wiki | ||
+ | php-max | ||
+ | ---- | ||
+ | |||
+ | TeemIp IP Discovery Data model represents the TeemIp side of TeemIp IP Discovery solution. It defines the discovery parameters and allows discovery results to be fed back and displayed. | ||
+ | |||
+ | < | ||
+ | </ | ||
+ | |||
+ | |||
+ | ===== Revision History ===== | ||
+ | ^ Version | ||
+ | | **3.1.1** | ||
+ | | 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.3.0 | 2019-08-29 | ||
+ | | 0.2.2 | 2019-02-09 | ||
+ | |||
+ | ===== Features ===== | ||
+ | |||
+ | TeemIp IP Discovery provides a solution to TeemIp administrators to discover or scan their IP networks and to document within TeemIp the results of these discoveries and scans. | ||
+ | |||
+ | The solution is made of 2 components: | ||
+ | * a [[collectors: | ||
+ | * a [[extensions: | ||
+ | |||
+ | {{ ipdiscoveryprinciples3x.png? | ||
+ | |||
+ | The IP Discovery extension, which is described in this page, is installed on a TeemIp instance. It models the IP Discovery applications that are connected to TeemIp and display the output provided by these applications. | ||
+ | |||
+ | Each instance of a remote IP Discovery Application defines: | ||
+ | * what discovery method to use (ping and / or IP lookup and / or port scanning), | ||
+ | * what subnets to discover. | ||
+ | |||
+ | A given subnet can only be discovered by one remote application and the functions to be used for its discovery can be restricted: | ||
+ | |||
+ | |||
+ | ===== Licensing ===== | ||
+ | |||
+ | 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, | ||
+ | |||
+ | The nice binocular icon attached to the IP Discovery Application in TeemIp has been found on [[https:// | ||
+ | ===== Limitations ===== | ||
+ | |||
+ | Discovery of IPv6 networks is not handled at this stage. | ||
+ | |||
+ | ===== Requirements ===== | ||
+ | |||
+ | The extension doesn' | ||
+ | |||
+ | ===== Installation ===== | ||
+ | |||
+ | |||
+ | |||
+ | When adding the extension on an TeemIp standalone or iTop application, | ||
+ | |||
+ | ===== Configuration ===== | ||
+ | |||
+ | No specific configuration is required in TeemIp' | ||
+ | |||
+ | |||
+ | ===== IP Discovery menu ===== | ||
+ | |||
+ | Once installed, the extension will alter the IP Management menu by adding a sub menu group under the Tools section. | ||
+ | |||
+ | {{ details_menu_ipdiscovery3x.png? | ||
+ | |||
+ | ==== IP Discovery menu ==== | ||
+ | It provides statistics on IP addresses and discovery results. | ||
+ | |||
+ | {{ ipdiscovery_dashboard3x.png }} | ||
+ | |||
+ | 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 ===== | ||
+ | |||
+ | {{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. | ||
+ | |||
+ | ==== Properties ==== | ||
+ | ^ Name ^ Type ^ Mandatory? | ||
+ | | **General Information** ||| | ||
+ | | Name | Alphanumeric string | Yes | | ||
+ | | Organization | Foreign key to a(n) Organization | Yes | | ||
+ | | Status | Possible values: implementation, | ||
+ | | Business criticality | Possible values: medium, high, low | No | | ||
+ | | Location | Foreign key to a(n) Location | No | | ||
+ | | Description | Multiline character string | ||
+ | | Requestor | Foreign key to a(n) Person | No | | ||
+ | | Move to production date | Date (year-month-day) | No | | ||
+ | | UUID | Alphanumeric string | Read Only | | ||
+ | | **Operations** || | ||
+ | | DHCP ranges discovery enabled | Possible values: yes, no | No | | ||
+ | | Last discovery date | Date (year-month-day hours: | ||
+ | | Duration | Time ( hours: | ||
+ | | **Ping Function** ||| | ||
+ | | Ping enabled | Possible values: yes, no| No | | ||
+ | | Ping timeout (s) | Integer | No | | ||
+ | | **IP lookup Function** ||| | ||
+ | | IP lookup enabled | Possible values: yes, no| No | | ||
+ | | DNS server #1 | Alphanumeric string | No | | ||
+ | | DNS server #2 | Alphanumeric string | No | | ||
+ | | **Scan Function** ||| | ||
+ | | Scan enabled | Possible values: yes, no| No | | ||
+ | | Port number | Integer | No | | ||
+ | | Protocol | Possible values: tcp, udp, both | No | | ||
+ | | Scan timeout (s) | Integer | No | | ||
+ | | Consider " | ||
+ | |||
+ | ==== Tabs ==== | ||
+ | ^ Tab ^ Description | ||
+ | | Contacts | All the contacts for this application | | ||
+ | | Documents | All the documents linked to this object | | ||
+ | | Managed IPv4 subnets | All the IPv4 subnets that the application must discover | | ||
+ | |||
+ | ==== Creating a new IP Discovery application ==== | ||
+ | |||
+ | From the listing view, click on the “New…” menu to display the creation form. | ||
+ | |||
+ | {{ 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. | ||
+ | * 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. | ||
+ | |||
+ | |||
+ | <note warning> | ||
+ | For a given Discovery Application, | ||
+ | </ | ||
+ | |||
+ | ===== Subnets ===== | ||
+ | |||
+ | {{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: | ||
+ | |||
+ | ==== Properties ==== | ||
+ | ^ Name ^ Type ^ Mandatory? | ||
+ | | **Discovery: | ||
+ | | 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 | | ||
+ | | DHCP ranges discovery 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 | | ||
+ | | Scan enabled for subnet | Possible values: yes, no | No | | ||
+ | | Considers scan " | ||
+ | | **Discovery: | ||
+ | | Last discovery date | Date and time (year-month-day hh:mm:ss) | Read only | | ||
+ | | Ping duration | Time it took to ping the subnet | Read only | | ||
+ | | Ping # | Number of IPs discovered by ping | Read only | | ||
+ | | 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 | | ||
+ | |||
+ | ==== Details of an IPv4 subnet ==== | ||
+ | |||
+ | IP discovery attributes alter the subnet detailed page as follows: | ||
+ | |||
+ | {{ classdetails_ipv4subnet3x_ipdiscovery.png }} | ||
+ | |||
+ | The 3 attributes Ping, IP lookup and Scan enabled for subnet may change the way the subnet' | ||
+ | * If one of these 3 discovery functions is enabled at the application level, it may be denied at the subnet level. | ||
+ | * However, if a function is disabled at the application level, it cannot be enabled at the subnet one. | ||
+ | |||
+ | <note tip> | ||
+ | Though attached to a discovery application, | ||
+ | </ | ||
+ | ===== View results in TeemIp ===== | ||
+ | |||
+ | The IP Discovery Module alters the standard TeemIp datamodel so that discovery results can be visualized at both the subnet and the IP address levels. | ||
+ | |||
+ | ==== Subnets ==== | ||
+ | |||
+ | From the detailed display of a subnet, selecting 'List & Pick' under 'Other Actions' | ||
+ | |||
+ | {{ classlistips_ipv4subnet_ipdiscovery3x.png }} | ||
+ | |||
+ | The following image may appear next to each IP of the subnet: | ||
+ | * {{ipmini-ping-xs.png}} indicates that an IP pings, | ||
+ | * {{ipmini-scan-xs.png}} indicates that an answer is received when IP is scanned, | ||
+ | * {{ipmini-lookup-xs.png}} indicates that a DNS entry exists for that IP and DNS output is provided just after the icon. | ||
+ | |||
+ | These flags reflects the latest status provided by the remote application. If an IP was pinging in the past and if the latest discovery finds out that this IP doesn' | ||
+ | |||
+ | <note important> | ||
+ | Discovery flags ({{ipmini-ping-xs.png}}, | ||
+ | </ | ||
+ | |||
+ | ==== IP Addresses ==== | ||
+ | |||
+ | {{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: | ||
+ | |||
+ | === Properties === | ||
+ | ^ Name ^ Type ^ Can be edited? | ||
+ | | **Discovery Information** ||| | ||
+ | | IP Discovery application name | Alphanumeric string | Read only | | ||
+ | | Last date of discovery | Date (year-month-day hours: | ||
+ | | Responds to ping | Possible values: yes, no | Read only | | ||
+ | | Responds to IP lookup| Possible values: yes, no | Read only | | ||
+ | | FQDN from IP lookup |Alphanumeric string | Read only| | ||
+ | | Responds to scan | Possible values: yes, no | Read only | | ||
+ | |||
+ | === Details of an IP address === | ||
+ | IP discovery attributes alter the address details screen as follows: | ||
+ | |||
+ | {{ classdetails_ipv4address_ipdiscovery3x.png }} | ||
+ | |||
+ | * The IP discovery application is inherited from the subnet that that IP belongs to. | ||
+ | * 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 ! | ||
+ | </ | ||