Guest

CiscoWorks LAN Management Solution 3.2 and earlier

Working with Next-Generation Discovery In LMS 3.1

  • Viewing Options

  • PDF (2.9 MB)
  • Feedback


Contents

Introduction. 3

Working with Common Services Device Discovery. 3

User Privileges for Device Discovery Operations. 3

Configuring Discovery Settings. 4

Starting Device Discovery. 12

Stopping Device Discovery. 13

Viewing Discovery Reports. 14

Scheduling Device Discovery. 15

Using Discovery Features through CLI 17

Starting Discovery through CLI 17

Stopping Discovery through CLI 17

Viewing Device Discovery Status through CLI 17

Viewing Device Discovery Help. 18

DiscoveryCli Errors. 18

Debugging Device Discovery. 18

Use Cases. 20

Use Case 1. 21

Use Case 2. 22

Use Case 3. 23

Use Case 4. 24

Running Device Discovery within NAT Setup. 25

Traceability Matrix Comparing Campus Manager Discovery and NGD.. 25

Features Newly Added in LMS 3.1. 30

Abbreviations, Acronyms, and Definitions. 30


Introduction

In today’s world, complicated networks that consist of devices from different vendors and that use various protocols to communicate between neighbors can spread across continents. A desperate need for a solution arises to handle these complex networks and discover the devices in them.

CiscoWorks Campus Manager, part of the CiscoWorks LAN Management Solution (LMS), discovers only the Cisco devices that support Cisco Discovery Protocol, a Layer 2 protocol. This application does not support discovery of devices from third-party vendors and with different protocols such as Border Gateway Protocol (BGP), Open Shortest Path First (OSPF), and Hot Standby Router Protocol (HSRP). The Cisco device discovery feature is available in versions of Campus Manager prior to LMS 3.0.1.

CiscoWorks Common Services overcomes this limitation by offering a powerful set of web-based features for vendor-independent device discovery with various protocols used to communicate between the neighboring devices. These features are available in the LMS 3.0 December 2007 update and later versions, or LMS 3.0.1.

The network administrator can discover the devices using different protocols, such as Cisco Discovery Protocol, BGP, OSPF, Address Resolution Protocol (ARP), HSRP, cluster, routing table, and ping sweep on IP range, that are activated at different layers of the Open Systems Interconnection (OSI) model in the device.

Common Services device discovery features are based on next-generation discovery (NGD), a discovery engine framework. NGD helps the network administrator to configure modules, seed devices, Simple Network Management Protocol (SNMP), and filter settings to discover the desired devices from the networks. After the devices are discovered from the network, starting from the seed devices, the device information is updated in the Device Credentials Repository (DCR) by Common Services.

Working with Common Services Device Discovery

Common Services device discovery helps you in performing the following operations:

Configuring discovery settings

Starting discovery

Stopping discovery

Viewing discovery reports

Scheduling discovery

Running device discovery through the command-line interface (CLI)

Debugging discovery

Optimizing device discovery

User Privileges for Device Discovery Operations

To configure device discovery settings and start device discovery, you should have network administrator privileges.

To view the device discovery summary, any of the following roles should be assigned to you:

- Network administrator

- Network operator

- System administrator

Configuring Discovery Settings

You should configure the device discovery settings, such as the discovery module, seed device, SNMP, and so on, before you run device discovery.

To configure device discovery settings:

1. Select Common Services > Device and Credentials > Device Discovery > Discovery Settings. Click either the Configure button or the Configure link next to the module settings (see Figure 1).

The Discovery Settings wizard appears.

Figure 1. Common Services Device Discovery Settings

2. Select one, more than one, or all of the discovery modules to run the discovery. See Figure 2 for the list of available modules.

Note: By default, no discovery module is selected. If you are upgrading or migrating to the LMS 3.0 December 2007 update (with Campus Manager) from LMS 3.0, Cisco Discovery Protocol is selected by default.

You must select at least one of the modules to proceed further.

Click Next to proceed further or click Cancel to exit the Discovery Settings wizard.

Example: If you want to perform discovery using the Layer 3 protocols, you can select any one of the options BGP, OSPF, and ROUTING TABLE, or a select combination of them, or all of them.
Figure 2. Device Discovery Module Settings

3. Specify the seed device details for the modules that you have selected in the previous screen (the Module Settings page).

You can specify module-specific seed devices (see Figure 3) or global seed devices (see Figure 4).

Other than specifying the seed devices manually, you can:

Import the seed devices from a text (.txt) or comma-separated value (.csv) file

Select the Use DCR as Seed List option, which considers the devices in DCR as seed devices.

Note: By default, no seed device settings are available. If you are upgrading or migrating to the LMS 3.0 December 2007 update (with Campus Manager) from LMS 3.0, the Use DCR As Seed List option is selected by default.

To enter module-specific seed device information, select a module from the list of displayed modules in the Seed Devices wizard (see Figure 3).

Click Add to introduce a row and add the seed device information. To delete seed devices, select the check boxes corresponding to the seed devices and click Delete.

To restrict device discovery to a particular number of hops or subnets, you must specify:

Hop Count for all the modules except Ping Sweep On IP Range

Subnet Mask for the Ping Sweep On IP Range module only

Enter the following fields, which appear only for the Ping Sweep On IP Range discovery module.

- ICMP Retry: Number of retries to connect to a device using Internet Control Message Protocol (ICMP) if the device is not reachable or the network is down. The default is 1 retry.

- ICMP Timeout: Time within which the device should send its response to the network. The default timeout is 1000 milliseconds.

- InterPacket Timeout: Time delay between two ICMP packets. The default timeout is 20 milliseconds.

To enter global seed device information, click Global from the Seed Devices panel at the left.

You must enter at least one seed device or select the Use DCR As Seed List option to proceed further.

Click Next to proceed further or click Cancel to exit the Discovery Settings wizard.

Example 1: If you selected BGP in the Module Selection screen, you can specify the seed device as 10.77.213.245 and the hop count as 10 if you want to restrict discovery to the 10 next hops. Leave the Hop Count field blank if you do not want to restrict discovery.
Example 2: If you selected Ping Sweep On IP Range, you can specify the seed device as 10.77.209.209 and the subnet mask as 255.255.255.240. Entering a smaller subnet mask value may result in a longer discovery cycle, as discovery has to sweep IP addresses from more networks. It is recommended to enter a Class C mask instead of a Class A or B mask.
Figure 3. Module-Specific Seed Device Settings

Figure 4. Global Seed Device Settings

4. Specify the SNMP settings for the devices to be discovered from the network.

You can specify either SNMPv2 or SNMPv3 credentials.

Select the appropriate radio button to select the SNMP version. The user interface displays the appropriate fields for the SNMP version you selected.

See Figure 5 to view the SNMPv2 user interface and Figure 6 to view the SNMPv3 user interface.

You can also delete the SNMPv2/v3 settings using the Delete button after selecting the SNMP settings.

Note: Multiple community strings are taken into consideration by default, and also the community stings are encrypted by default, whereas in Campus Manager you need to explicitly select the check boxes for this functionality.

By default, no SNMP settings are available. If you are upgrading or migrating to the LMS 3.0 December 2007 update (with Campus Manager) from LMS 3.0, the following are the default SNMPv2 settings:

Target – *.*.*.*

Read Community – public

SNMP Timeout – 3

SNMP Retry – 2

You must configure at least one SNMPv2 or SNMPv3 credential set to proceed further.

You must click any one of the following buttons in this wizard:

Next to proceed further

Cancel to exit the wizard without saving the changes

Back to change the previous settings

Finish to apply the settings and exit the wizard

Example 1: Suppose all of your devices have the read community as public and you have entered the target as *.*.*.* and the read community as public. The Timeout and Retries fields appear with default values. You can change and enter different values for SNMP Timeout and SNMP Retry.
Example 2: If the read community value of some of your devices is public and the read community value of the rest of the devices is cwpublic, you can define two SNMPv2 settings, one for a range of devices with the read community string as public and another for a range of devices with the read community string as cwpublic.
Figure 5. SNMPv2 Settings page

Figure 6. SNMPv3 Settings page

5. Specify the discovery filter settings to include or exclude certain devices from device discovery.

You must select a filter type among the IP Address, SysObjectId, SysLocation, or Domain Name System (DNS) Domain Name filter types and click Add. You must also select Include Devices or Exclude Devices. See Figure 7.

Discovery filters based on DNS domain, SysObjectID, and SysLocation support regular expressions. You can use:

Period (.) to match any character

Opening and closing parentheses, ( and ), to mark the beginning and closing of a group of matched characters

Asterisk (*) to match more than zero occurrences of the regular expression specified

Plus (+) character to match more than one occurrence of the regular expression specified

Trailing slash (\) character to identify a special character within a regular expression

To delete a filter setting or rule, click Delete after you select a filter rule.

By default, no filter settings are available. If you are upgrading or migrating to the LMS 3.0 December 2007 update (with Campus Manager) from LMS 3.0, the filter settings in LMS 3.0 will be preserved.

You must click any one of the following buttons in this wizard:

Next to proceed further

Cancel to exit the wizard without saving the changes

Back to change the previous settings

Finish to apply the settings and exit the wizard

Note: You can specify only one filter type at a time for a discovery job. You can either include or exclude devices based on the filters you have set. You cannot do both.

Figure 7. Filter Settings

6. Specify other discovery settings in the Global Settings page. See Figure 8.

You can configure:

Preferred Management IP: The applications use the Preferred Management IP to manage a particular device. Resolve By Name is the default option. See Figure 8 for available other options.

Preferred DCR Display Name: The applications use the Preferred Management IP to manage a particular device. Resolve By Name is the default option. See Figure 8 for available other options.

Update DCR Display Name option: Select this check box if you want to update the display name of the devices that already exist in DCR in the next device discovery cycle.

Use Default Credentials option: Select this check box if you want to add the discovered devices with the default SNMP and other credentials in DCR. You can enter the default credentials by clicking the Configure button next to this field.

Email: Enter a valid email address to receive notification from the system on the start and completion of device discovery and for new discovery schedules.

Add Discovered Devices to a Group option: Select this option if you want to add all reachable discovered devices to a group.

You must click any one of the following buttons in this wizard:

Next to proceed further

Cancel to exit the wizard without saving the changes

Back to change the previous settings

Finish to apply the settings and exit the wizard

By default, no global settings are available. If you are upgrading or migrating to the LMS 3.0 December 2007 update (with Campus Manager) from LMS 3.0, the settings in LMS 3.0 will be preserved.

Note: To receive email notifications, you must configure the SMTP server name and CiscoWorks server administrator email address in the System Preferences page in Common Services. You can click Common Services > Server > Admin > System Preferences.

Figure 8. Global Settings page.

7. When you click Next in the Global Settings wizard, the Discovery Settings Summary page appears. See Figure 9.

You must click any one of the following buttons in this wizard:

Next to proceed further

Cancel to exit the wizard without saving the changes

Back to change the previous settings

Finish to apply the settings and exit the wizard

When you click Finish or Cancel to exit the wizard, the Discovery Settings page appears.

Figure 9. Device Settings Summary Page in the Discovery Settings Wizard

Starting Device Discovery

After you have configured discovery settings, you can start a device discovery job.

Click Start Discovery either in:

Device Discovery Summary page (Common Services> Device and Credentials> Device Discovery). See Figure 10.

or

Discovery Settings page (Common Services> Device and Credentials> Device Discovery > Discovery Settings).

Device discovery starts as an immediate job. Email notification is sent to the email address configured in the Global Settings wizard.

After device discovery has started running, the Start Discovery button changes to Stop Discovery.

Meanwhile, the device discovery status is displayed as Initializing, as the required Uniform Resource Names (URNs) are to be published. After the URNs are published, the discovery status is changed to Running. Otherwise, if an error occurs while publishing URNs, the discovery status is displayed as Failed.

The discovery status is displayed as Running after the completion of device discovery and before the CSDiscovery process is stopped. After device discovery is completed successfully, the status changes to Completed.

You can view the summary of discovered devices from the Device Discovery Summary page or the Common Services Job Browser page.

To view the discovered devices summary from the Common Services Job Browser page, you should click the Job ID created on starting or scheduling device discovery.

Note: You cannot run more than one instance of device discovery at a time.

Figure 10. Starting Device Discovery

Stopping Device Discovery

You can stop device discovery by clicking the Stop Discovery button in the Device Discovery Summary page (see Figure 11).

You can also cancel device discovery jobs from the Common Services Job Browser page. Canceling jobs from the Common Services Job Browser page stops the device discovery process, and the status is displayed as Recent Discovery Info Not Found.

The “Discovery has been stopped successfully” informational message appears after discovery is stopped successfully.

Note: It may take some time after stopping discovery to kill all the discovery-related threads that were created at the start of discovery.

Figure 11. Stopping Device Discovery

Viewing Discovery Reports

You can navigate to Common Services > Device and Credentials > Device Discovery to view the discovery reports.

In the Device Discovery Summary page, you can view the device count of:

Total Discovered Devices

Reachable Devices

Unreachable Devices

Devices Added to DCR

Devices Updated to DCR

You can click the device count displayed for these fields to view the respective reports (see Figure 12).

You can also view the summary from:

Common Services Job Browser page by clicking the job ID of a discovery job

Device Discovery Summary portlet in the LMS Portal application

Note: The discovery-related data is not available if the job is canceled from the Common Services Job Browser.

Figure 12. Device Discovery Details

Scheduling Device Discovery

You can schedule one or more device discovery jobs in Common Services. The optimum device discovery schedule depends on the size of the network and changes in the network.

After you have configured device discovery settings, you can schedule discovery jobs in the Discovery Schedule page. When you schedule discovery jobs, make sure that the scheduled times do not overlap each other. Otherwise, one of the device discovery jobs may fail.

You must go to Common Services > Device and Credentials > Device Discovery > Discovery Schedule to open this page and click Add. Enter the day(s) and time to configure a device discovery schedule and click Schedule (see Figures 13 and 14).

The discovery schedule is created and assigned with a job ID. Email notification is sent to the email address if you have configured an email address in the Global Settings page and an SMTP server in the System Preferences page.

You can edit or delete a scheduled job by clicking the Edit or Delete buttons, respectively.

In LMS 3.1, you can also schedule multiple jobs with different discovery settings. Once a job is scheduled, it is associated with the current discovery settings. To schedule another job with different settings, you need to change the discovery settings first and then schedule a job.

You can view or edit the settings of a scheduled discovery job by clicking the View Settings or Edit Settings button, respectively.

If you are upgrading or migrating to the LMS 3.0 December 2007 update (with Campus Manager) from LMS 3.0, the discovery settings in LMS 3.0 will be preserved and the migrated discovery jobs run with these settings.

Example: If you want to run discovery at 12:00 noon on Monday, Wednesday, and Friday, you should create a schedule by specifying the time as 12:00 and select the Monday, Wednesday, and Friday check boxes in the Recurrence Pattern panel. You must click the Schedule button to successfully create this schedule.
Figure 13. Device Discovery Schedule

Figure 14. Device Discovery Schedule

Using Discovery Features through CLI

You can use the DiscoveryCli command-line utility to start and stop device discovery and view the discovery status.

To run the DiscoveryCli commands, you must navigate to NMSROOT/bin, where NMSROOT is your CiscoWorks Installation directory.

Starting Discovery through CLI

To start device discovery through CLI, you must enter:

DiscoveryCli -u username -p password start
Example: C:\Program Files\CSCOpx\bin> DiscoveryCli -u admin -p test start

After you run the command, the following message appears:

DiscoveryCli
============
INFO: Discovery has been started as an immediate job with id 1037
INFO: Mail has been sent to the user.

Stopping Discovery through CLI

To stop device discovery through CLI, you must enter:

DiscoveryCli -u username -p password stop
Example: C:\Program Files\CSCOpx\bin> DiscoveryCli -u admin -p test stop

After you run the command, the following message appears:

DiscoveryCli
============
INFO: Discovery has been stopped successfully.

Viewing Device Discovery Status through CLI

To view the status of device discovery through CLI, you must enter:

DiscoveryCli -u username -p password status
Example: C:\Program Files\CSCOpx\bin> DiscoveryCli -u admin -p test status

After you run the command, the following message appears:

DiscoveryCli
============
INFO: Below is the status of recently completed discovery.
Discovery Status : Completed
Discovery Start Time : Sun Sep 02 07:00:12 GMT+05:30 2007
Discovery End Time : Sun Sep 02 07:02:47 GMT+05:30 2007
Total Devices Discovered : 28
Reachable Devices : 24
Unreachable Devices : 4
Devices Newly Added to DCR: 0
Devices Updated to DCR : 24

Viewing Device Discovery Help

To view the help content, you must enter:

DiscoveryCli -h
Example: C:\Program Files\CSCOpx\bin>DiscoveryCli -h

After you run the command, the following message appears:

DiscoveryCli
============
Usage:
DiscoveryCli -u <username> [-p <password>] [-h] start|stop|status
Options:
-u <username> : Ciscoworks username
-p <password> : Ciscoworks password
-h : Print this help, then exit
Tasks:
start : Start a discovery process now
stop : Stop the running device discovery instance
status : Show the status of running or completed discovery
Example:
DiscoveryCli -u admin start

DiscoveryCli Errors

If you are not authorized to perform DiscoveryCli tasks, an error message appears when you run the DiscoveryCli commands.

After you run the command, the following message appears:

DiscoveryCli
============
ERROR: Authorization failed. You are not authorized to perform this task.

When you provide a wrong username or password, the following message appears:

DiscoveryCli
============
ERROR: Authentication failed. Invalid username or password.

Debugging Device Discovery

In the LMS 3.0 December 2007 update, you can activate the debugging option for device discovery.

To do so, you should go to Common Services > Server > Admin > CS Log Configurations and select CSDiscovery as the component. You should select Enable as the debug mode and click Apply.

Debugging is activated without the restart of daemons within 60 seconds, and debug messages are logged into CSDiscovery.log. The CSDiscovery.log is available in NMSROOT\log on Windows and /var/adm/CSCOpx/logs on Solaris. This log file contains the information about discovery jobs, URNs published, discovery threads, and other information related to device discovery.

To debug more about device-level information, you must activate the debugging option for ngdiscovery.log located in the same top-level directories.

Example: If you have started device discovery but the discovery status is displayed as Failed, you can activate the debugging option and try once again to start discovery. The log file displays the reason for failure as a problem while publishing the discovery-related URN.

In LMS 3.1 you can activate the module-wise debugging option for components of Common Services device discovery without restarting the daemon manager. When you activate the debugging option for a selected component, the log level in the csdiscovery.properties file is changed to DEBUG and the debug messages are recorded into the CSDiscovery.log file.

To activate the debugging option for the Common Services device discovery components:

1. Go to the CiscoWorks home page and select Common Services> Device and Credentials> Device Discovery > Discovery Logging Configuration.

The Discovery Logging Configuration page appears. See Figure 15.

2. Select one or more discovery modules or components from the Disabled Modules list box.

3. Click Add to add the components to the Enabled Modules list box.

4. Click Apply.

Debugging is enabled for all the components listed in the Enabled Modules list box. The changes will come into effect after 60 seconds.

To disable the debugging option, move the selected component from the Enabled Modules list box to the Disabled Modules list box using the Remove button.

The debugging option for all the device discovery components is disabled by default.

Note: Enable the debugging option only if required. Otherwise the size of the log file grows bigger and device discovery could take more time.

Figure 15. Debugging Option for Device Discovery

Optimizing Device Discovery

To discover devices in a particular subnet, you can select Ping Sweep On IP Range as the discovery module and specify the specific subnet mask in the seed device.

Entering a smaller subnet mask value may result in a longer discovery cycle, as discovery has to sweep IP addresses from more networks.

To discover the edge routers that are being connected to your branch offices or ISPs, select the module as BGP if the protocol is enabled in those devices.

If you have cluster setup in your network, then you can select the module as a cluster discovery module.

If you have devices with the same configuration as a backup for the other devices where HSRP is enabled, you can use the HSRP module.

You can use OSPF to discover your core devices in the network if it is enabled in those devices.

You can use Cisco Discovery Protocol as the discovery module if your entire network contains Cisco devices.

You can use other or multiple protocols that are available in NGD if your network contains devices from different vendors.

Use Cases

The use cases listed below explain how to configure device discovery settings and work with next-generation discovery effectively.

Use Case 1

Consider you want to discover the devices in your network with the following settings:

Device Discovery Module

Ping Sweep On IP Range

Seed Device

10.77.213.245 for the specified discovery module

Subnet Mask

255.255.255.240 for the specified discovery module

SNMPv2 Target

*.*.*.*

SNMPv2 Read Community

public

SNMPv2 Target

*.*.*.*

Exclude Devices

10.77.213.241 to 10.77.213.244

Update DCR Display Name

Yes

Preferred DCR Display Name

hostname+domain name

Preferred Management IP

loopback address

Use Default Credentials

No

Email

admin@domain.com

To configure the specified device discovery settings:

1. Go to Common Services > Device and Credentials > Device Discovery > Discovery Settings.

The Discovery Settings page appears.

2. Click Configure.

The Module Settings wizard appears.

3. Select Ping Sweep On IP Range and click Next.

The Seed Devices Settings wizard appears.

4. Click Module-specific Seed Devices > Ping Sweep On IP Range at the left.

5. Enter the seed device as 10.77.213.245 and subnet mask as 255.255.255.240.

6. Click Add and click Next to launch the SNMP Settings wizard.

7. Select the SNMPv2 radio button and click Add to open the SNMPv2 credentials popup window.

8. Enter the target as *.*.*.* and the read community as public.

9. Click OK to return to the SNMP Settings wizard.

10. Click Next to launch the Filter Settings wizard.

11. Select IP Address as the filter type and select the Exclude radio button.

12. Click Add to introduce a row for entering the filter rule.

13. Enter 10.77.213.[241-244] as the filter rule.

14. Click Next to launch the Global Settings wizard.

15. Select Hostname+Domain Name as the Preferred DCR Display Name option.

16. Select the Update DCR Display Name check box.

17. Select Use LoopBack Address as the Preferred Management IP.

18. Configure the email ID as admin@domain.com.

19. Remove the check mark in the Use Default Credentials check box.

20. Click Next to view the summary of settings.

21. Click Finish in the Discovery Summary wizard to apply the settings.

You can now start device discovery using the Start Discovery button in the Discovery Settings page.

Use Case 2

Consider you want to discover the devices in your network with the following settings:

Device Discovery Module

BGP

Seed Device

10.77.213.245 as global seed device

SNMPv2 Target

10.77.*.*, 10.78.*.*

SNMPv2 Read Community

public (for 10.77.*.*), cwpublic (10.78.*.*)

Exclude Devices

SysObjectIDs starting with .1.3.6.1.4.n.

Update DCR Display Name

Yes

Preferred DCR Display Name

Hostname

Preferred Management IP

Reverse DNS Lookup

Use Default Credentials

Yes

Email

admin@domain.com

To configure the specified device discovery settings:

1. Go to Common Services > Device and Credentials > Device Discovery > Discovery Settings.

The Discovery Settings page appears.

2. Click Configure.

The Module Settings wizard appears.

3. Select BGP and click Next.

The Seed Devices Settings wizard appears.

4. Click Global Seed Device at the left.

5. Enter 10.77.213.245 as the seed device.

6. Click Add and click Next to launch the SNMP Settings wizard.

7. Select the SNMPv2 radio button and click Add to open the SNMPv2 credentials popup window.

8. Enter the target as 10.77.*.* and the read community as public.

9. Click OK to return to the SNMP Settings wizard.

10. Click Add to open the SNMPv2 credentials popup window to configure another set of SNMPv2 credentials.

11. Enter the target as 10.78.*.* and the read community as cwpublic.

12. Click OK to return to the SNMP Settings wizard.

13. Click Next to launch the Filter Settings wizard.

14. Select SysObjectID as the filter type and select the Exclude radio button.

15. Click Add to introduce a row for entering a filter rule.

16. Enter \.1\.3\.6\.1\.4\.(.)+ as the filter rule.

17. Click Next to launch the Global Settings wizard.

18. Select Hostname as the Preferred DCR Display Name option.

19. Select the Update DCR Display Name check box.

20. Select Reverse DNS Lookup as the Preferred Management IP.

21. Configure the email ID as admin@domain.com.

22. Select the Use Default Credentials check box.

23. Click Next to view the summary of settings.

24. Click Finish in the Discovery Summary wizard to apply the settings.

You can now start device discovery using the Start Discovery button in the Discovery Settings page.

Use Case 3

Consider you want to discover the devices in your network with the following settings:

Device Discovery Module

HSRP

Seed Device

10.77.213.245 as module-specific and global seed device

Hop Count

10

SNMPv2 Target

*.*.*.*

SNMPv2 Read Community

public

Exclude Devices

Devices in Chennai

Update DCR Display Name

Yes

Preferred DCR Display Name

IP Address

Preferred Management IP

Resolve By SysName

Use Default Credentials

No

Email

admin@domain.com

To configure the specified device discovery settings:

1. Go to Common Services > Device and Credentials > Device Discovery > Discovery Settings.

The Discovery Settings page appears.

2. Click Configure.

The Module Settings wizard appears.

3. Select HSRP and click Next.

The Seed Devices Settings wizard appears.

4. Click Module-specific Seed Devices > HSRP at the left.

5. Enter the seed device as 10.77.213.245 and the hop count as 10.

6. Click Add.

7. Click Global Seed Devices at the left.

8. Enter 10.77.213.245 as the seed device.

9. Click Add and click Next to launch the SNMP Settings wizard.

10. Select the SNMPv2 radio button and click Add to open the SNMPv2 credentials popup window.

11. Enter the target as *.*.*.* and the read community as public.

12. Click OK to return to the SNMP Settings wizard.

13. Click Next to launch the Filter Settings wizard.

14. Select SysLocation as the filter type and select the Exclude radio button.

15. Click Add to introduce a row for entering a filter rule.

16. Enter Chennai(.)* as the filter rule.

17. Click Next to launch the Global Settings wizard.

18. Select IP Address as the Preferred DCR Display Name option.

19. Select the Update DCR Display Name check box.

20. Select Resolve By SysName as the Preferred Management IP.

21. Configure the email ID as admin@domain.com.

22. Remove the check mark in the Use Default Credentials check box.

23. Click Next to view the summary of settings.

24. Click Finish in the Discovery Summary wizard to apply the settings.

You can now start device discovery using the Start Discovery button in the Discovery Settings page.

Note: As the same seed device is specified in both module-specific and global settings at runtime, before discovery starts running, the duplicate seed device is discarded.

Use Case 4

Consider you want to discover the devices in your network with the following settings:

Device Discovery Module

Cisco Discovery Protocol

Seed Device

Use DCR as Seed List

SNMPv2 Target

*.*.*.*

SNMPv2 Read Community

public

Exclude Devices

Devices in the domain Cisco.com

Update DCR Display Name

No

Preferred Management IP

None

Use Default Credentials

No

Email

admin@domain.com

To configure the specified device discovery settings:

1. Go to Common Services > Device and Credentials > Device Discovery > Discovery Settings.

The Discovery Settings page appears.

2. Click Configure.

The Module Settings wizard appears.

3. Select Cisco Discovery Protocol and click Next.

The Seed Devices Settings wizard appears.

4. Click Module-specific Seed Devices > CDP at the left.

5. Select the Use DCR As Seed List option.

6. Click Add and click Next to launch the SNMP Settings wizard.

7. Select the SNMPv2 radio button and click Add to open the SNMPv2 credentials popup window.

8. Enter the target as *.*.*.* and the read community as public.

9. Click OK to return to the SNMP Settings wizard.

10. Click Next to launch the Filter Settings wizard.

11. Select DNS Domain as the filter type and select the Exclude radio button.

12. Click Add to introduce a row for entering a filter rule.

13. Enter (.)+\.cisco\.com as the filter rule.

14. Click Next to launch the Global Settings wizard.

15. Remove the check mark in the Update DCR Display Name check box.

16. Select None as the Preferred Management IP.

17. Configure the email ID as admin@domain.com.

18. Remove the check mark in the Use Default Credentials check box.

19. Click Next to view the summary of settings.

20. Click Finish in the Discovery Summary wizard to apply the settings.

You can now start device discovery using the Start Discovery button in the Discovery Settings page.

Running Device Discovery within NAT Setup

Running Common Services device discovery is supported on a CiscoWorks server that is set up within a Network Address Translation (NAT) boundary.

Device discovery initiated from a CiscoWorks server within a NAT environment can discover the devices from the network that are outside the NAT boundary.

Traceability Matrix Comparing Campus Manager Discovery and NGD

Tables 1 and 2 explain the traceability matrix between Campus Manager discovery and next- generation discovery.

Table 1. UI Properties Comparison between Campus Manager Discovery and NGD

Feature (UI Properties)

Campus Manager Discovery

NGD

Module Settings

(Supported discovery modules)

Cisco Discovery Protocol – For Ethernet networks
ILMI – For ATM networks
ELMI – For Frame Relay networks

Layer 3 Discovery Protocols

ARP
BGP
OSPF
Routing Table

Layer 2 Discovery Protocol

Cisco Discovery Protocol
Ping Discovery Option
Ping Sweep On IP Range
Others
Cluster Discovery Module
HSRP

ILMI and ELMI protocols are not supported in Common Services NGD

Seed Device Settings

Options to add seed device:

From file
Provide one or more seed IP addresses directly

During the first discovery cycle, Campus Manager discovery takes the device list provided in the seed devices option as seed devices. In the consecutive discovery cycle, Campus Manager discovery uses all the devices in DCR as seed devices.

Seed device can be added:

Module-specific
Global

Options to add seed device:

From file
Provide one or more seed IP addresses directly
Use DCR as seed device

The Ping Sweep On IP Range option does not support the Use DCR As Seed List option because of performance issues (If the DCR has, for example, 5000 devices, ping sweep should ping all 5000 devices, which takes more time.)

SNMP Settings

Enable Multiple Community Strings option is provided.

If the option is selected, Campus Manager checks for the multiple community string.

By default, the multiple community string is selected and no option is provided to deselect it.

Encrypt Community Strings option is provided.

By default, community strings are encrypted and there is no option provided to disable encryption.

SNMPv2 is supported.

SNMPv2 is supported.

The SNMP version is displayed as SNMPv1/v2c.

No option is available to select either SNMPv1 or v2c.

Following security levels of SNMPv3 are supported:

AuthNoPriv
NoAuthNoPriv

Following security levels of SNMPv3 are supported:

AuthNoPriv
NoAuthNoPriv
AuthPriv

Help button is not available in SNMP Settings page.

Help button is added in both SNMPv2 and SNMPv3 Settings pages.

Filter Settings

Filtering can be done based on
IP address only.

Filtering can be done based on:

IP address
DNS domain
SysObjectId
SysLocation

Global Settings

Preferred Management IP

You can select one or more or all of the following options:

Use LoopBack Address
Resolve By Name
Resolve By SysName

The Resolve By Name option is the default option for this field.

Use LoopBack Address
Select this option to resolve names served by loopback address.

If there are multiple loopback addresses configured, Campus Manager checks for the address that is DNS resolvable.

Resolve By Name

When you select this option, Campus Manager tries to resolve the IP address to a DNS name (forward lookup), performs reverse lookup using the obtained DNS name, and chooses the resolved IP address as the preferred management IP.

Resolve By SysName

When you select this option, Campus Manager tries to resolve the address using the SysName (reverse lookup) and sets the resolved IP address as the management IP.

All options

When you select all three preferred management IP address options, Campus Manager checks for loopback first. If the loopback fails, then Campus Manager checks to resolve by domain name followed by SysName.

You can select any one of the following options as your preferred management IP:

Use LoopBack Address
Resolve By Name
Resolve By SysName
None.

The Resolve By Name option is the default option for this field.

Use LoopBack Address
Select this option to manage a device in the address assigned to the loopback interface.
If there are multiple loopback IP addresses, the highest loopback address is used to manage the device.

Resolve By Name
Common Services device discovery uses DNS, if available, to perform device name lookups.

Select this option to do name resolution using the device name.

Resolve By SysName
Select this option to contact the DNS server to pick up the device hostname.

None
Select this option if you do not want to manage the devices with the preferred management IP address.

When you select this option, the devices are added in DCR with their IP addresses.

Update DCR Display Name

Check box is provided to select this option in the Discovery Settings page. By default this option is not selected.

When the property is set to false, the DCR display name will not be updated after discovery

If it is set to true, the DCR display will be updated after every Dev discovery.

If this option is selected, the discovery process will check the preferred DCR display name selected and update the DCR display name with the preferred option after every discovery.

If this option is not selected, the display name is not updated after discovery completion.
Fallback is supported; if Resolve By SysName fails, discovery falls back to Resolve By Name and Use LoopBack Address.

Use Default Credentials

When you select this option, the devices are updated with the default credentials except the SNMP read community string. The SNMP read community string is updated from the discoverysnmp.conf file.

A link is provided to launch the Default Credentials Settings page from the Device Discovery Settings page.

This option is available in NGD.

When you select this option, the devices are updated with the default credentials that you have configured already.

However, the SNMP credentials set for device discovery will not be updated or overwritten by default SNMP credentials configured in the Default Credentials page.

Preferred DCR Display Name

There is no option in the user interface to select a preferred DCR display name.

If the hostname of the device exists, then the devices are updated in DCR with their hostname as the DCR display name. Otherwise, the IP address of the device is updated as the display name in DCR.

Following options are provided as preferred DCR display name:

IP Address
Host Name
FQDN

The hostname of the device is set as the preferred DCR display name by default. If the hostname does not exist, the devices are added to DCR with their IP address as the DCR display name.

Use Reverse DNS Lookup

This option allows you to enable or disable DNS lookup.

This option, when enabled, checks for any of the options listed below to resolve accordingly:

Use LoopBack Address
Resolve By Name
Resolve By SysName

If you do not select this option, Campus Manager will not check for DNS.
Options under Preferred Management IP are disabled if you do not select this option.

The Use Reverse DNS Lookup option is not available in NGD, but the None option for the Preferred Management IP Address provides the function of the Use Reverse DNS Lookup option.

Jump Router Boundaries

If the Jump Router Boundaries option is selected, device discovery happens beyond the router boundaries.

Option is not available in the LMS 3.0 December 2007 update.

By default, discovery happens beyond the router boundaries.

NOTE: This option is introduced in LMS 3.1.

Email

Not supported

The system uses the email ID that you have configured to notify you the following:

Status of immediate or scheduled device discovery jobs upon their completion
New discovery schedules
Stopped device discovery jobs

ICMP Timeout

Not supported

You can configure ICMP timeout for the Ping Sweep On IP Range option.

ICMP Retry

Not supported

You can configure ICMP Retry for the Ping Sweep On IP Range option.

InterPacket Timeout

Not supported

You can configure InterPacket Timeout for the Ping Sweep On IP Range option.

Table 2. Hidden Properties Comparison between Campus Manager Discovery and NGD

Feature (Hidden Properties)

Campus Manager Discovery

NGD

updateDomainNameSuffix

Updates DCR display name with domain name suffix after discovery when this property is set to true

Default value is false.

The option FQDN available under Preferred DCR Display Name will perform the functionality of this property.

ThreadPool.Devdiscovery.priority

Sets higher priority for device discovery threads within ANI

Default value is HIGH.

NGD is a separate process and hence there is no need to set higher priority for device discovery threads.

ThreadPool.Devdiscovery.count

Denotes the maximum number of threads supported

Default count value is 48.

TotalThreadAllowed property in NGD is equivalent to this.

snmp.maxRows=50000

Gets maximum rows allowed for SNMP table fetch

Not required

snmp.threads.min=15

Denotes minimum number of threads used

Denotes minimum number of threads used

snmp.threads.max=48

Denotes maximum number of threads allowed

Denotes maximum number of threads allowed

snmp.defaultReadCmty=public

Default read community used for discovery when the read community is not configured in the user interface

Not required

snmp.defaultWriteCmty=private

Not in use

Not required

snmp.getBulkSize=10

Sets the get bulk size

Default SNMP value for GetBulkSize is 20.

snmp.version2c=on

Flag to turn on or off SNMP version2c

Set it to "off" to disable v2c.

In SNMP library this is not exposed as SNMP library settings.

(Properties – (http://twiki.cisco.com/Teams/FrequentlyAskedQuestions#FaqSnmp17))

CIDS provides overloaded method for overriding properties, but it does not provide other options to set.

NGD does not provide this property.

AniDBNullColumnValidation=false

Related to database, Validate Null Column in Database

Related to database

Ani.sendEvents=false

Control sending of events, database and PO synchronization

Related to database

DB.WriteClassListToDb=false

Controls writing class list PO to database

Related to database

DB.Connection.Timeout

Database timeout

Default value is 60000.

Related to database

DB.Connection.MinIdleTime

Database idle time

Default value is 60000.

Related to database

DB.ReaperSleepTime

Database sleep time

Default value is 30000.

Related to database

Ani.resolve=true

If set to true, it uses JNDI to resolve.

DNS resolution becomes successful only if forward and reverse DNS requests are matching.

If this property is enabled, then either a forward or reverse DNS response is enough to decide the DNS name.

In device discovery, this feature is provided by setting the property HostNameResolveType="JNDI"

Discovery.SkipExcludedLoopback=false

If the detected loopback is configured in an excluded address list, then discovery skips and uses another loopback address as the management address.

This happens when you set the value to true.

The purpose is not to manage the device with the configured loopback address and not to skip the device itself.

This option is not supported.

Discovery.neighbors.onEnabled=on

Not used

Not required

Discovery.domains.exclude=

VLAN Trunking Protocol (VTP) domain-based filter is removed in LMS 3.0. Hence this property is removed.

Not required

Discovery.domains.include=

VTP domain based filter is removed in LMS 3.0. Hence this property is removed.

Not required

Properties in Common Services discovery

SNMPFallback

Not supported

If set to true, SNMP fallback from SNMPv3 to SNMPv2 is not supported.

Default value is true.

NextDeviceInterval

Not supported

NextDeviceInterval is a sleep control to wait for the next device discovery to start.

Default value is 75 ms.

ThreadTimeout

No option is provided for thread timeout

Timeout for the discovery processes thread

Default is 300 ms.

TotalThreadAllowed

This is similar to ThreadPool.Devdiscovery.count.

Denotes the total number of threads allowed

Default value is 20.

PurgeDeviceObject

Not supported

Purge module-related data in device object after publishing to adapters

Default value is true.

ExportDiscardedDevices

Not supported

Provides the list of discarded devices to export when this is set to true

Default value is true.

ExportUnreachableDevices

Not supported

Provides the unreachable device list to export when this option is set to true

Default value is true.

Features Newly Added in LMS 3.1

Jump router boundaries option for Cisco Discovery Protocol module

Add discovered devices to a group

Multiple discovery schedules

Package-level debugging for discovery

Abbreviations, Acronyms, and Definitions

Abbreviation or Term

Description or Definition

ARP

Address Resolution Protocol

BGP

Border Gateway Protocol

Cluster

A group of devices in which one device acts as the commander and the others as members

Discovery module

Protocol that is used to discover the devices

Hop count

The number of next hops that can be crossed during discovery

HSRP

Hot Standby Routing Protocol

NGD

Next-generation discovery

OSPF

Open Shortest Path First

Routing table

Table that contains route entries for other networks

Seed device

The device from which discovery starts