User Tools

Site Tools


extensions:teemip-ip-discovery-extension

IP Discovery - Extension

name:
IP Discovery - Extension
description:
TeemIp solution to discover IP addresses
version:
0.5.1
release:
2020-04-14
TeemIp:
2.6
code:
teemip-ip-discovery
state:
stable
keyword:
discovery, ping, lookup, scan
dependencies:
teemip-ip-mgmt, teemip-ipv6-mgmt, teemip-network-mgmt
download:
teemip-ip-discovery-0.5.1-567.zip

TeemIp IP Discovery Extension represents the TeemIp side of TeemIp IP Discovery solution. It defines the discovery parameters and allows discovery results to be fed back and displayed.

Vocabulary: by “TeemIp solution” or “TeemIP”, it should be understood: TeemIp standalone or the iTop solution on top of which TeemIp as a module has been installed.

Revision History

Version Release Date Comments
0.6.0 ?? Enhance discovery reporting - consider “connection refused” for scans
0.5.1 2020-04-14 Move IP Application menu under the new Tools shortcut
0.4.0 2019-10-11 Enable / disable discovery of subnet attached to an IP Discovery application
0.3.0 2019-08-29 Move generic methods to IP Application level
0.2.2 2019-02-09 Initial production release
0.2.0 2018-09-24 Release candidate
0.1.1 2017-08-11 Beta version 2
0.1.0 2017-06-12 Beta version 1

Features

Reminder: 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 discovery engine, called the IP Discovery Collector or the IP Discovery Application, that discovers IPs through pings, DNS reverse lookups and port scanning,
  • a TeemIp extension, called the IP Discovery Extension, 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.

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: ie deny ping, IP lookup or scan if these have been enabled globally.

Licensing

TeemIp IP Discovery solution 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 it 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, AND FITNESS FOR A PARTICULAR PURPOSE.  

The nice binocular icon attached to the IP Discovery Application in TeemIp has been found on IconFinder and Icons Land.

Limitations

Discovery of IPv6 networks is not handled at this stage.

Requirements

The extension doesn't require anything more than what is necessary to install and run TeemIp.

Installation

When adding the extension on an TeemIp standalone or iTop application, just use the standard installation process.

Configuration

No specific configuration is required in TeemIp's configuration file or in IP configs for that extension.

IP Discovery menu

Once installed, the extension will alter the IP Management menu by adding a sub menu group under the Tools section.

The “IP Discovery” link provides statistics on IP addresses and discovery results.

Clicking on the count figure next to an IP Discovery application provides the list of subnets discovered by the given application.

IP Discovery applications

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, production, obsolete No
Business criticity Possible values: medium, high, low No
Location Foreign key to a(n) Location No
Description Multiline character string No
Requestor Foreign key to a(n) Person No
Move to production date Date (year-month-day) No
UUID Alphanumeric string Read Only
Operations
Last discovery date Date (year-month-day hours:minutes:seconds) Read Only
Duration Time ( hours:minutes:seconds) Read Only
Ping Function
Ping enabled Possible values: yes, no No
Ping timeout 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 Integer No
Consider “connection refused” as valid Possible values: yes, no No

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

Listing IP Discovery applications

The IP Discovery applications shorcut displays all the applications that belong to the selected organization.

Creating a new IP Discovery application

From the listing view, click on the “New…” menu to display the creation form.

  • 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.
For a given Discovery Application, the UUID defined in TeemIp MUST match the discovery_application_uuid parameter defined in the configuration file of the remote application.

Subnets

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: application parameters
IP Discovery application Foreign key to a(n) IP Discovery application No
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 “connection refused” as valid Foreign attribute of the application Read only
Discovery: subnet parameters
Discovery activated 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
IP discovery considers scan “connection refused” as valid Possible values: yes, no No
Discovery: statistics
Last discovery date 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

Creating a new subnet

IP discovery attributes alter the subnet creation form as follows:

The 3 attributes Ping, IP lookup and Scan enabled for subnet may change the way the subnet's IP discovery application will discover 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.
Though attached to a discovery application, you may activate or deactivate the subnet's discovery with the parameter “Discovery activated”.

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' menu will show:

The following image may appear next to each IP of the subnet:

  • indicates that an IP pings,
  • indicates that an answer is received when IP is scanned,
  • 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't ping anymore, then the ping image will not be shown anymore.

Discovery flags (, , ) will never appear next to an IP that doesn't exist within TeemIp. This is due to the default behaviour of the application: newly discovered IPs that don't exist in TeemIp are automatically created with the status “unassigned”.

IP Addresses

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:minutes:seconds) Read only
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:

  • 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.
extensions/teemip-ip-discovery-extension.txt · Last modified: 2020/08/26 11:27 by cnaud