Table of Contents
NAME
snm_discover - Site/SunNet/Domain Manager network element discoverer/monitor
SYNOPSIS
snm_discover [ options ]
DESCRIPTION
snm_discover dynamically creates Site/SunNet/Domain Manager runtime database records for devices it finds on a network. When an element is discovered, some analysis is done on it to determine its host name, type, and capabilities. Then it is added to the database.
snm_discover allows you to perform a "targeted" search, looking for machines of a certain class, such as routers or machines running SNMP. See the -d option below for details.
snm_discover has, in addition to its discover function, a monitor function. This function compares the elements stored in the runtime database with the elements it finds at a specified interval or specified time. If new elements are detected, the monitor function stores the elements in a "holding area" view and records these elements in a log file. Through the same log file, the monitor function can also notify you if a previously discovered host is down or was down within a given period.
The hosts found by the monitor function are then added to a network since the last running of the discover function and hosts that the discover function did not find.
snm_discover has a command line version, described in this man page, and "window" version, invoked from the Site/SunNet/Domain Manager Console's Tool menu. The functions of the two versions are identical. The window version is described in the Site/SunNet/Domain Manager Administra_tion Guide.
Before snm_discover can be started, the runtime database must be available. The easiest way to do this is to run the Console, snm. When snm is started for the first time, you have the choice of a "Head Start" option, in which Discover uses the arp table to find no more than 10 elements on the local subnetwork, or "Basic Start", in which no discovery is performed.
Once a record is added to the database, the record is never changed by snm_discover. The tool's monitor function can, however, detect the change, allowing you to revise your database through the Console's graphical editor function.
OPTIONS
The snm_discover program offers a rich set of configuration options for both the discover and monitor functions. These options allow you to fine-tune the extent and depth of the tool's search and monitoring activities. Most of the options determine the operation of the discover function of snm_discover. The ICMP- and SNMP-related discover parameters also apply to the monitor function.
In addition to use of the options described here, snm_discover uses a configuration file, discover.conf , that allows you to perform even more specialized configuration than is provided by the options described here. See discover.conf(5) for details.
Each option is recognized as a separate argument.
- -a
- Creates networks and subnets with IP addresses as names.
- -c <community>
- Use <community> for the SNMP community string. The discover function limits its search for SNMP devices to devices that have the community name(s) you specify here. You can specify up to five SNMP community names. Use a colon to delimit multiple names. Note that using multiple community names makes the discover function take a longer time than it would with a single name. This is because the discover function tries each device with each community name until a response is received.
- -d <objects>
- Where <objects> is one or a combination of snmp, snm, router, and network. A given object must be an SNMP device, a machine running SNM agents, a router, or a network. Separate multiple objects with colons. By default, snm_discover finds all types of objects. Routers are defined as systems that have multiple network interfaces to different IP networks. When the discover function finds a router, it fills in IP addresses for the first two interfaces and uses the alias feature to give a name to each interface (if, indeed, each interface has a unique name), including those beyond the first two. You can then specify any of these aliases when sending a data or event request. If you specify network , the discover function finds networks and subnetworks, If you specify network , in combination with the -l option, described below, the discover function manageable connections and routers, in addition to networks and subnetworks.
- -F <num>
Specifies the number of fast ping retries. This is used for SNMP requests when the user selects "Fast Ping Search" method for discovery.
- -f <secs>
- Specifies the fast ping timeout in seconds. This is the timeout value discover waits between ping requests sent in by the "Fast Ping Search" method.
- -h <hops>
- An integer specifying the maximum number of hops the discover function will make (with the Console machine as the starting point). For a given route from the machine running snm_discover, this parameter specifies the maximum number of routers the packets sent by the discover function will traverse. The default for this parameter is zero hops, which means that the discover function limits its searches to the local subnetwork.
Setting the hops option to a value above zero can result in very long searches. For example, on a moderately burdened machine, using the default of 0 hops and a local subnetwork with 200 hosts, the discover function would take about 20 minutes to complete.
- -l
- Add link information. When you use this option, the discover function creates manageable connections between discovered elements and adds the connection information to the /var/opt/SUNWconn/snm/linkmap file for Solaris 2.x and to the /var/adm/snm/linkmap file for Solaris 1.x.
- -m <netmask>
- Specifies the netmask used for the discover function. By default, the discover function uses the netmask number used on the local subnetwork. Enter the netmask number in hexadecimal (preceded by 0x) or dotted decimal notation (for example, 255.255.255.0). The netmask parameter has two uses: one is for situations in which you want discovery to begin in a subnetwork other than the local subnetwork. In this case, the discover functions needs to know the netmask used on that subnetwork. The second use is as a limit to the number of hosts the discover function will add to the runtime database. While the latter use can be helpful in certain networks, most users need not be concerned with setting limits. If the tool is about to ping more than 1024 elements, the discover function informs you of the number and displays an estimate of the time it will take to add all of those hosts to the runtime database. The discover function will ping a maximum of 2048 network elements per subnetwork.
For limiting the number of elements found, the discover function uses the inverse of the host portion of the subnet mask. For example, if you have a netmask of 0xffffff00, the host portion of the netmask, 0x00, becomes 0xff, or decimal 255.
- -M
- Starts the monitor function, using the default or current configuration options.
- -N <num>
- Specifies the number of fast pings. This is the number of ping requests sent between timeouts. The requested number of ping requests are sent simultaneously. The default value is 1.
- -n <network>
- Limits the discover function to the specified network. By default, the discover uses the network number used by the local machine. When specifying a network number, be sure to enter a value for each byte within the number. For example, specify 129.144.41.0, not 129.144.41. If you enter a network name or number outside of the local subnetwork, the discover function limits its search to the subnetwork you specify.
- -o
- Add to only one view, rather than to all views in the runtime database, which is the default behavior. The default behavior of snm_discover is to add to all views in the runtime database and not preserve the uniqueness of an element as it appears in one view or another. If you specify this option, the discover function adds discovered elements to all views within the runtime database and appends the view name to all views (that is, elements of category view) within the specified view. For an element that is in multiple, high-level views, this feature allows you to distinguish that element as it exists in different views.
- -p <num>
- Specifies the number of ICMP retries. The discover function uses the Internet Control Message Protocol (ICMP) to find network elements that are not SNMP devices. This parameter determines the number of times the tool will retry "finding" an element using ICMP following an initial non-response. If your network is very busy, you might want to increase this value.
- -q
- Perform a quick discovery: 10 or fewer nodes on the local subnetwork. Used in the HeadStart option in the Quick Start window. This option uses the arp table to find a small number of hosts.
- -r <IPAddress1:IPAddress2>
- A range of addresses for discover to ping. By default, discover attempts to probe the first 2048 hosts on a network. This can be a problem for networks that are unsubnetted class B addresses, or Class A and Class B addresses with more than 12 bits in the host portion of the address. This option takes a colon separated pair of IP addresses as the first and last addresses in the range that should be probed.
- -s <seconds>
- A timeout used when sending SNMP requests. Determines how long (in seconds) the discover function waits for a response to an SNMP packet before giving up or, for routers, sending another SNMP packet.
- -S <num>
- Number of SNMP retries when sending SNMP requests to routers. For SNMP devices, the discover function uses SNMP for discovery purposes. This parameter determines the number of times the tool will retry contacting an element using SNMP following an initial response. This parameter comes into play primarily when querying routers. ARP and routing tables are often large and sometimes require multiple retries to obtain complete tables.
- -t <seconds>
- Time between sending ICMP packets. Determines how long (in seconds) the discover function waits after sending an ICMP packet that did not receive a response, before sending another ICMP packet. To speed up the discovery process, reduce this value.
- -T
- Bring up the Discover Tool window interface.
- -v
- Use verbose mode. Prints analysis information to the standard error file (usually the shell where the program was started).
- -V viewname
- Put all discovered devices in the specified view. If viewname doesn't exist, it is created as a view.subnet in the Home view. If you do not specify the -o option (see above), the viewname you specify here is the only view for which the discover function preserves the uniqueness of discovered elements.
- -x
- Do not add coordinates to elements. By default, the discover function performs minimal layout of elements within a view. Specify -x to have the discover function perform no layout of elements.
- -P
- Use the PING search method for discovery. If this option is specified with the options -N and -n, then the "Fast Ping Search" method is used.
- -A
- Use the ARP search method for discovery.
- -G filename
- Specifies a list of gateway names for discovery. Discover uses the gateways listed in the file <filename> for discovery.
- -D <level>
- This option is used to print debug messages. A value of 1 is for high level messages and a value of 2 is for detailed level messages.
- -D config
- This option is used to print out configuration information from the discover.conf file.
- -D <snmp | traceroute hostname>
- This option is used to test the SNMP or traceroute information on the specified host.
If environment variable SNMDBDIR is set, it is used as the location of the runtime database file. Otherwise, /var/opt/SUNWconn/snm on Solaris 2.x or /var/adm/snm on Solaris 1.x is used.
NOTES
If you start the Console with the -i flag after running snm_discover, you will reinitialize the runtime database. You will lose the results of snm_discover unless you first save the database to an ASCII file.
SEE ALSO
discover.conf(5) linkmap(5)
Table of Contents