UM:Network Discovery - Revision history

AlexKirhenshtein: Text replacement - "^" to "{{deprecated}}"

2022-09-13T16:13:55Z

Text replacement - "^" to "{{deprecated}}"

← Older revision		Revision as of 16:13, 13 September 2022
Line 1:		Line 1:
	Information moved to documentation:		{{deprecated}}Information moved to documentation:

	https://www.netxms.org/documentation/adminguide/network-discovery.html		https://www.netxms.org/documentation/adminguide/network-discovery.html

TatjanaDubrovica at 14:07, 24 November 2017

2017-11-24T14:07:56Z

← Older revision		Revision as of 14:07, 24 November 2017
Line 1:		Line 1:
	Information moved to documentation:		Information moved to documentation:

	https://www.netxms.org/documentation/adminguide		https://www.netxms.org/documentation/adminguide/network-discovery.html

TatjanaDubrovica at 14:04, 24 November 2017

2017-11-24T14:04:57Z

← Older revision		Revision as of 14:04, 24 November 2017
Line 1:		Line 1:
	Information moved to documentation:		Information moved to documentation:

	https://www.netxms.org/documentation/~~userguide~~		https://www.netxms.org/documentation/adminguide

TatjanaDubrovica: Replaced content with "Information moved to documentation: https://www.netxms.org/documentation/userguide"

2017-11-24T14:03:56Z

Replaced content with "Information moved to documentation: https://www.netxms.org/documentation/userguide"

← Older revision		Revision as of 14:03, 24 November 2017
Line 1:		Line 1:
	~~{{DISPLAYTITLE:Network Discovery}}~~		Information moved to documentation:
	~~= Introduction =~~
	NetXMS is capable of discovering your network automatically. Network discovery module can operate in two modes - passive and active. In passive mode, information about new hosts and devices obtained from [http://en.wikipedia.org/wiki/Address_Resolution_Protocol ARP] tables and [http://en.wikipedia.org/wiki/Routing_table routing tables] of already known devices. NetXMS starts with it's own ARP cache and routing table. In active discovery mode, NetXMS server will send an ICMP echo requests to all IP addresses in given range, and consider each responding address for adding to database. For each new device found NetXMS server tries to gather additional information using SNMP and NetXMS agent, and then adds it to database. By default NetXMS server will add all discovered devices to database, but you can limit it by using discovery filters.

	~~= Configuring Network Discovery =~~		https://www.netxms.org/documentation/userguide
	~~To change network discovery settings, go to main menu of management console and choose ''Configuration'', then ''Network Discovery''. Network discovery configuration form will open:~~

	~~[[File:Network_discovery_config.png]]~~

	~~== "General" Section ==~~
	~~In this section, you can choose network discovery mode and set default SNMP community string.~~

	~~== "Filter" Section ==~~
	~~In this section, you can define filter for adding new nodes to NetXMS database. Filtering options are following:~~

	~~'''No filtering'''~~

	~~Any new device found will be added to database. This is the default setting.~~

	~~'''Custom script'''~~

	~~You can choose [[UM:NetXMS_Scripting_Language_(NXSL)\|NXSL]] script from the Script Library to work as discovery filter. Custom filtering script will get object of class [[NXSL~~:~~NewNode\|NewNode]] as first parameter (special variable $1), and should return '''true''' to allow node inclusion into database.~~

	~~'''Automatically generated script'''~~

	~~This option can be used if you need only simple filtering. When selected, additional options coontrols what nodes will be added to database:~~
	~~{\| class="wikitable"~~
	\|-
	~~\| Accept node if it has NetXMS agent \|\| If checked, nodes with NetXMS agent detected will pass the filter.~~
	\|-
	~~\| Accept node if it has SNMP agent \|\| If checked, nodes with SNMP agent detected will pass the filter.~~
	\|-
	~~\| Accept node if it is within given range or subnet \|\| Only accept nodes withing given address range or subnet. Address ranges can be configured in '''Address Filters''' section.~~
	\|}

	Please note that first two options (NetXMS agent presence and SNMP agent presence) forms OR condition - if both are checked, any node with either SNMP agent or NetXMS agent will pass. Address range check and first two options forms AND condition - so if potential node does pass agent presence check, but is not in allowed IP address range, it will not be accepted. In other words, if all three options are checked, condition for new node to pass filter can be written as following:

	~~'''if''' (''node has NetXMS agent'' '''or''' ''node has SNMP agent'') '''and''' ''node within given range'' '''then pass'''~~

	~~== "Active Discovery Targets" Section ==~~
	In this section, you can define address ranges for active discovery. NetXMS server will periodically send ICMP echo requests to these addresses, and consider for addition to database every responding device. This list has no effect if active discovery is off.

	~~== "Address Filters" Section ==~~
	~~In this section you can define address ranges for automatically generated discovery filter. This list has no effect if discovery is off or filter is not set to "Automatically generated script".~~

	~~== "SNMP Communities" Section ==~~
	In this section you can add SNMP community strings to be tested during configuration polls. NetXMS server first will try default community string defined in "General" section, and then all community strings from this list.

	~~== "SNMP USM Credentials" Section ==~~
	~~In this section you can add SNMP version 3 credentials to be tested during configuration polls~~.

Victor: Created page with "{{DISPLAYTITLE:Network Discovery}} = Introduction = NetXMS is capable of discovering your network automatically. Network discovery module can operate in two modes - passive an..."

2012-11-04T21:09:57Z

Created page with "{{DISPLAYTITLE:Network Discovery}} = Introduction = NetXMS is capable of discovering your network automatically. Network discovery module can operate in two modes - passive an..."

New page

{{DISPLAYTITLE:Network Discovery}}
= Introduction =
NetXMS is capable of discovering your network automatically. Network discovery module can operate in two modes - passive and active. In passive mode, information about new hosts and devices obtained from [http://en.wikipedia.org/wiki/Address_Resolution_Protocol ARP] tables and [http://en.wikipedia.org/wiki/Routing_table routing tables] of already known devices. NetXMS starts with it's own ARP cache and routing table. In active discovery mode, NetXMS server will send an ICMP echo requests to all IP addresses in given range, and consider each responding address for adding to database. For each new device found NetXMS server tries to gather additional information using SNMP and NetXMS agent, and then adds it to database. By default NetXMS server will add all discovered devices to database, but you can limit it by using discovery filters.

= Configuring Network Discovery =
To change network discovery settings, go to main menu of management console and choose ''Configuration'', then ''Network Discovery''. Network discovery configuration form will open:

[[File:Network_discovery_config.png]]

== "General" Section ==
In this section, you can choose network discovery mode and set default SNMP community string.

== "Filter" Section ==
In this section, you can define filter for adding new nodes to NetXMS database. Filtering options are following:

'''No filtering'''

Any new device found will be added to database. This is the default setting.

'''Custom script'''

You can choose [[UM:NetXMS_Scripting_Language_(NXSL)|NXSL]] script from the Script Library to work as discovery filter. Custom filtering script will get object of class [[NXSL:NewNode|NewNode]] as first parameter (special variable $1), and should return '''true''' to allow node inclusion into database.

'''Automatically generated script'''

This option can be used if you need only simple filtering. When selected, additional options coontrols what nodes will be added to database:
{| class="wikitable"
|-
| Accept node if it has NetXMS agent || If checked, nodes with NetXMS agent detected will pass the filter.
|-
| Accept node if it has SNMP agent || If checked, nodes with SNMP agent detected will pass the filter.
|-
| Accept node if it is within given range or subnet || Only accept nodes withing given address range or subnet. Address ranges can be configured in '''Address Filters''' section.
|}

Please note that first two options (NetXMS agent presence and SNMP agent presence) forms OR condition - if both are checked, any node with either SNMP agent or NetXMS agent will pass. Address range check and first two options forms AND condition - so if potential node does pass agent presence check, but is not in allowed IP address range, it will not be accepted. In other words, if all three options are checked, condition for new node to pass filter can be written as following:

'''if''' (''node has NetXMS agent'' '''or''' ''node has SNMP agent'') '''and''' ''node within given range'' '''then pass'''

== "Active Discovery Targets" Section ==
In this section, you can define address ranges for active discovery. NetXMS server will periodically send ICMP echo requests to these addresses, and consider for addition to database every responding device. This list has no effect if active discovery is off.

== "Address Filters" Section ==
In this section you can define address ranges for automatically generated discovery filter. This list has no effect if discovery is off or filter is not set to "Automatically generated script".

== "SNMP Communities" Section ==
In this section you can add SNMP community strings to be tested during configuration polls. NetXMS server first will try default community string defined in "General" section, and then all community strings from this list.

== "SNMP USM Credentials" Section ==
In this section you can add SNMP version 3 credentials to be tested during configuration polls.