User Guide for Internetwork Performance Monitor 4.1(With LMS 3.1)
Chapter 3 : IPM Device Management

Table Of Contents

Adding Devices Using Device Management

Understanding the Device and Credentials Repository

Understanding the IPM Devices Page

Viewing IPM Devices

Automatically Importing DCR Devices

Manually Importing DCR Devices

Adding Adhoc Target Devices to IPM

Licensing Behavior While Adding Devices

Editing IPM Device Attributes

Deleting Devices from IPM

Configuring Device Selector

Using Device Selector

Using the Selection Tab

Using the All Tab

Using the Search Results Tab

Searching Devices

Performing Simple Search


Adding Devices Using Device Management


This section explains how to add devices from Common Services' Device and Credentials Repository (DCR) and manage the same in IPM.

To add devices from Common Services' DCR, you must first add devices to DCR. After adding the devices to DCR, you can import them into IPM. Besides adding devices from DCR, you can also add adhoc devices into IPM.

You can add devices into IPM using one of the following methods:

Automatically Importing DCR Devices.

To import DCR devices automatically, go to Internetwork Performance Monitor > Admin > Auto Allocation Settings

Manually Importing DCR Devices.

To import DCR devices manually, go to Internetwork Performance Monitor > Collector Management > Devices > Add Devices.

Adding Adhoc Target Devices to IPM.

To add adhoc target devices, go to Internetwork Performance Monitor > Collector Management > Devices > Add Adhoc Devices.

This section contains the following topics:

Understanding the Device and Credentials Repository

Understanding the IPM Devices Page

Configuring Device Selector

Understanding the Device and Credentials Repository

The Device and Credentials Repository (DCR) is part of Common Services application. This is a centralized device repository to share device credentials across all applications that are installed on CiscoWorks server. You must first add the devices to the Common Services' DCR and then import the devices to IPM.

Use the DCR (Common Services > Device and Credentials > Device Management) to:

Add a device

Edit device identity

Edit device credentials

Import devices

Export devices

View the list of devices

Delete devices

The IPM application uses the following device credentials from the DCR:

Device identity information such as IP address/host name/display name.

Device access information such as SNMP v2/v3 credentials.

When a device is deleted from IPM, the DCR is not affected. You can selectively add the devices back to IPM. However, if a device is deleted from DCR, the device is also deleted from the IPM application. For more information on the DCR, See the Common Services Online Help and User Guide.

You can add devices to IPM using one of the following methods:

Automatically Importing DCR Devices

Adding Adhoc Target Devices to IPM

Manually Importing DCR Devices

However, the number of devices you can add in IPM depends on the device license limit. For more information, see Licensing Behavior While Adding Devices.

Understanding the IPM Devices Page

For IPM to work with devices, you must first add devices into IPM from Common Services' Device and Credentials Repository (DCR). You can add the devices either automatically or manually from DCR. You can also add adhoc target devices into IPM.

The devices added into IPM, both from DCR and adhoc target devices, appear on the IPM Devices page.

Table 3-1 shows the fields and buttons that are available in IPM Devices page.

Table 3-1 IPM Devices Page

Fields/Buttons
Description

IPM Devices

Lists all devices in IPM.

For more information, see Viewing IPM Devices.

The devices are identified by the Display Name that you have entered while adding devices to Device and Credentials Repository (DCR).

For more information, see Using Device Selector.

Add Devices

Allows you to add devices into IPM manually.

For more information, see Manually Importing DCR Devices.

Add Adhoc Devices

Allows you to add adhoc target devices.

For more information, see Adding Adhoc Target Devices to IPM.

Edit Device Attributes

Allows you to edit the IPM device attributes. The device attributes are:

SNMP Retry

SNMP Timeout

For more information, see Editing IPM Device Attributes.

Delete

Allows you to delete devices from IPM.

For more information, see Deleting Devices from IPM.

Refresh

(Icon)

Use this to update the new device count.


Viewing IPM Devices

The IPM Devices page lists all devices based on Device Type Groups, Responder Enabled Devices, and Adhoc Target devices (Internetwork Performance Monitor > Collector Management > Devices).

All Devices—Lists all DCR devices in the application with their display names. The display names are defined when you add the devices in DCR.

Device Type Groups—Lists all devices in groups and subgroups based on their MDF type.

User Defined Groups—Lists IPM devices that satisfy the group rules. The group rules are defined in Common Services (Common Services > Groups > Group Administration).

Responder Enabled Devices—Lists all responder enabled target devices.

Adhoc Target Devices—Lists all adhoc target devices added into IPM.

To view IPM devices:


Step 1 Go to LMS Portal and select Internetwork Performance Monitor > Collector Management > Devices.

Step 2 Click the Devices hyperlink.

The IPM Devices page appears with the list of devices in IPM.


Automatically Importing DCR Devices

Whenever you add devices to Common Services' Device and Credentials Repository (DCR), the devices are added to IPM automatically if the Enable Auto Mode option is checked. This option is available under Internetwork Performance Monitor > Admin > Auto Allocation Settings.

This option is enabled by default. Hence, the devices get added to IPM automatically after you have added the devices to DCR.

For more information on Auto Allocation of DCR devices, see Auto Allocation Settings. in Managing Admin Settings in IPM.


Manually Importing DCR Devices

You can use this option to selectively add devices into IPM from Device and Credentials Repository (DCR). Alternatively, this option also allows you to add the devices that you have deleted from IPM.


Note View Permission Report (Common Services > Server > Reports) to check if you have the required privileges to perform this task.


To manually import the DCR devices:


Step 1 Go to LMS Portal and select Internetwork Performance Monitor > Collector Management > Devices.

The IPM Devices page appears.


Note Check if the Automatically Manage Devices from Credential Repository option is deselected on the Application Settings page (Internetwork Performance Monitor > Admin > Application Settings).


Step 2 Click Add Devices.

The Add DCR Devices page appears.

Step 3 Select the required devices from the Device Selector.

To select all the devices, select the All Devices check box.

To select a particular device type, expand the Device Type Groups, and expand the device type (for example: Routers, Switches, Hubs, etc.) and then select the required device.

To select a user-defined device, expand the User-Defined Groups and then select the required device.

To see the list of selected devices, click the Selection tab. You can deselect the devices if you want.

You can also search for devices from the Device Selector. For more details, see Using Device Selector.

Step 4 Click Add to add devices.

A message appears that the device has been added successfully.

Step 5 Click OK.


Adding Adhoc Target Devices to IPM

You can use this option to add adhoc target devices to IPM if you want to manage devices from an external source. The devices added are not included for the device license count.

To add adhoc target devices:


Step 1 Go to LMS Portal and select Internetwork Performance Monitor > Collector Management > Devices.

The IPM Devices page appears.

Step 2 Click Add Adhoc Devices.

The Add Adhoc Devices page appears.

Step 3 Enter the Host Name/IP Address of the target device in the Adhoc Devices field.


Note Use comma (,) separator to add more than one device.


Step 4 Click Add to add the adhoc target devices.

A message appears that the devices are added successfully.

Step 5 Click OK.


Licensing Behavior While Adding Devices

Based on the IPM device license limit, you can add devices from Device and Credentials Repository (DCR) either automatically or manually.

If the number of devices you add from DCR exceeds the IPM device license limit, then you can add either 10% of the device license limit or additional 100 devices, whichever is minimum, apart from the licensed device limit.

Examples

1. If you have a license for 100 devices, you are allowed to manage up to 110 devices, as 10% of 100 devices is 10 devices.

2. If you have a license for 5000 devices, you are allowed to manage up to 5100 devices. You can add additional 100 devices apart from the licensed device limit. This is because 10% of 5000 devices is 500 devices, which is more than 100 devices.

Licensing Behavior While Adding Devices Automatically

By setting `Automatically Manage Devices from Credential Repository' option on the Application Settings page, you can add devices automatically from DCR into IPM.

In this case, if IPM reaches the maximum device limit while adding the devices automatically, you can go for either an additional 10% of the licensed device limit or an additional 100 devices, whichever is minimum.

Licensing Behavior While Adding Devices Manually

If you do not want to import devices automatically from DCR, then you can import the devices manually from DCR to IPM.

In this case also after reaching the maximum device limit, you can opt for either an additional 10% of the licensed device limit or an additional 100 devices, whichever is minimum.

Editing IPM Device Attributes

You can modify the device attributes for single or multiple devices listed in IPM. You cannot modify the adhoc target devices.

The device attributes that you can modify are:

SNMP Retry—Number of times the system retries to access devices using SNMP options. The default value is 3. The minimum value is 0 and the maximum value is 6.

SNMP Timeout—Duration of time that the system should wait for a device to respond before it retries to access it again. The default value is 2. The minimum value is 0 and there is no maximum value.

To edit the IPM device attributes:


Step 1 Go to LMS Portal and select Internetwork Performance Monitor > Collector Management > Devices.

The IPM Devices page appears.

Step 2 Select the required devices for which you want to edit the device attributes.

For more information on selecting the device, see Using Device Selector.

Step 3 Click Edit Device Attributes.

The Device Attributes Information window appears.

Step 4 Select the required device from the Devices section.

Step 5 Modify the following device attributes in the Device Information section:

SNMP Retry (0-6 count)

SNMP Timeout (Min 0 Secs)

You can select the Apply to all Devices check box to apply the attributes of one device to all the other devices listed in the Devices section.

Step 6 Click Modify.

A message appears that the attributes of the selected devices have been modified successfully.

Step 7 Click OK.


Deleting Devices from IPM

You can use the Delete option to delete the devices from IPM. As a result, IPM deletes the collectors associated with that device and their statistics. To restore the deleted devices manually, go to Internetwork Performance Monitor > Collector Management > Devices > Add Devices.

You can still view the information of the deleted device in Device and Credentials Repository (DCR) even after you delete the device from IPM. To delete the device information permanently, go to Common Services > Device and Credentials > Device Management.


Note If IPM Process is down when you delete devices from DCR, the devices get deleted from IPM when IPM Process is up again.


You can also delete the IPM devices using the command line interface command:

ipm deletedevice -u admin -p admin -device Display Name


Note View Permission Report (Common Services > Server > Reports) to check if you have the required privileges to perform this task.


To delete devices from IPM:


Step 1 Go to LMS Portal and select Internetwork Performance Monitor > Collector Management > Devices.

The IPM Devices page appears.

Step 2 Select the devices that you want to delete. For more information, see Using Device Selector.

Step 3 Click Delete.

The Delete Confirmation dialog box appears.

Step 4 Click OK to delete the selected devices.

The updated IPM Devices page appears.

Or

Step 5 Click Cancel to return to the IPM Devices page.

Although these devices are deleted from IPM they are still available in DCR. To view the deleted devices, go to Internetwork Performance Monitor > Collector Management > Devices > Add Devices.


Configuring Device Selector

The improved Device Selector allows you to search for the devices in DCR. It helps to locate the devices and perform the various device management tasks quickly. With this improved Device Selector, you need not remember the device type or application group hierarchy to locate the devices.

You can define the settings of the Device selector pane to customize the display of devices and the order of display.

This section contains the following information:

Using Device Selector

Using the Selection Tab

Searching Devices

Using the All Tab

Using Device Selector

The Device Selector pane allows you to select IPM devices to perform IPM tasks. This pane lists all IPM devices in a group. The devices are listed in the appropriate groups based on Device Type groups and User Defined group rules.

The device name that you see in this pane is the Display Name that you have entered at the time of adding the devices in Device and Credential Repository.

If you have configured CiscoWorks login mode to work under ACS mode (Common Services > Server > Security > AAA Mode Setup), the devices listed for you while performing the IPM tasks are based on your role and associated privileges that are defined in Cisco Secure ACS.

Table 3-2 shows the fields and buttons available in the Device Selector pane.

Table 3-2 Device Selector Pane

Field/Button
Description

Search Input

Enter your search expression in this text field.

You can enter a single device name or multiple device names in this field. You can enter the following as search inputs for searching multiple devices:

Comma separated list of full device names

Device names with wildcard characters * and ? to search for multiple devices matching the text string entered in this input field.

Combination of comma separated list of device names, and device names with wildcard characters.

For more information, see Performing Simple Search.

Search

Allows you to perform a Simple search of devices, after you have entered your search input.

For more information, see Performing Simple Search.

All

Lists all the top-level device groups and the device names under each group in a hierarchical format (tree view).

The top-level device groups include:

All Devices

Device Type Groups

User-Defined Groups

Responder Enabled Devices

Adhoc Target

For more information on types of device groups, see List of Device Folders.

Search Results

Displays the Simple search results. From the search result, you can do a Select All, Clear All, or select a few devices.

The Simple search results are based on the display name of the devices added to DCR.

Selection

Lists all the devices that you have selected in the All or Search Results tab or through a combination of both. You can also use this tab to deselect the devices that you have already selected.

You can perform more than one search and can accumulate your selection of devices.


The Device Selector pane displays the number of devices selected by you at the bottom as a hyperlink. When you click the hyperlink, the Selection Tab is launched.

Tool tips are provided for devices with long names to avoid horizontal scroll to see the complete device name.

Using the Selection Tab

The Selection tab serves as a repository of all the devices that you select from the Search Results tab or All tab. You can select the required devices to perform various device management tasks such as editing device credentials and viewing device credentials, using any of the following methods:

Selecting Devices From All Tab

Selecting Devices From Search Results

Selecting Devices Using a Combination of All Tab and Search Results

Selecting Devices From All Tab

You can select devices using the Tree View in the All tab. The Selection tab displays all devices that are available in IPM.

Selecting Devices From Search Results

You can perform a Simple Search and the search results are displayed under the Search Results tab. You can select the devices you want from the Search Results tab. The Selection tab and the All tab display the devices that you have selected from the Search Results.

You can perform more than one search and accumulate the selected devices.

Selecting Devices Using a Combination of All Tab and Search Results

After you select devices using the All tab, you can add a few more devices using Search. You can enter the search criteria and perform a Simple Search, and the Search Results tab displays the devices that match the criteria.

You can select the required devices from the Search Results tab. The Selection tab displays the accumulated list from both All and Search Results tabs. If you click the All tab, it displays the selected devices from Search Results under the All Devices group as well.

You can enter another search criteria and select more devices. The selected devices are listed under All tab from the Selection tab, as you select more devices.


Note The (n) Devices Selected message at the left-bottom corner of the Device Selector screen shows the number of devices you have selected. It launches the Selection tab when you click on it.


Using the All Tab

The All tab lists all the devices that are available in IPM. The list is based on the Display Name that you entered in the Device Properties dialog box when you added devices to Device and Credential Repository (Common Services > Device and Credentials > Device Management).

List of Device Folders

The following is the list of device folders under the All tab:

The All Devices Group displays all the devices in the application in the alphabetical order of their display names. The display names are defined when you have added the devices in DCR.

You can use the device groups only when you are working on a IPM application. You cannot use these device groups when you are working on another CiscoWorks application. For example, if you are working on Campus Manager application, these groups cannot be used.

The User-Defined Groups folder lists IPM devices that satisfy the group rules. The group rules are defined by you when you create the User Defined groups.

See Managing Collector Groups for further details on IPM User-Defined groups.

The Device Type Groups folder lists all devices based on their MDF type by default.

The Responder Enabled Devices folder lists all the responder enabled target devices. Enhanced UDP Jitter operation uses Responder Enabled target devices.

The Adhoc Target folder lists all the adhoc target devices added into IPM.

IPM supports both Single and Multiple Device Selector.

Single Device Selector

In the single device selector, you can select a device only at the leaf-level (device-level). The radio buttons at the node-level (folder-level) are grayed out.

Multiple Device Selector

In the multiple device selector, you can select devices at both the node-level and leaf-level.

The following are the usage notes for the multiple device selector:

If you select devices at the node-level, all devices listed under this node are selected.

For example, if you select the All Devices node, all devices under this node are selected.

If you expand a device node, you cannot select devices at the node-level. You need to select devices individually at the leaf-level.

For example, if you expand the All Devices node, you cannot select devices at the All Devices node-level (the check box is grayed out). You need to select devices individually under the All Devices node.

If you select devices at a node-level and expand that particular node, you can deselect the devices only at the leaf-level and not at the node-level.

For example, if you select the Normal Devices node and expand it, you can deselect the devices only at the leaf-level. You cannot deselect all the devices at the Normal Devices node-level (the check-box is grayed out), when it is expanded. However, you can use Clear All to deselect all the devices.

You can select multiple device nodes to perform the IPM tasks.

For example, you can select the Previous selection and the Saved device list nodes together to perform the IPM tasks.

Using the Search Results Tab

The Search Results Tab lists all the results of Simple search operation. It displays a flat list of devices and you can do a select all, clear all, or select a few devices from the list.

Searching Devices

With the improved Device Selector, you can search the devices by performing a Simple search. While performing the simple search, you need not remember the name of the devices and the groups in which the devices are grouped.


Note The search string is not case sensitive in Common Services.


Performing Simple Search

You can enter your search criteria in the Search Input field and search for the devices using the Search icon. The search results are based on the display name of the devices added in DCR.

Usage Notes for Simple Search:

You can enter multiple device names separated with a comma. You can also enter wildcard character, "*" or "?" for selecting multiple devices.

For example, you can enter device names in these many ways to select multiple devices:

192.168.80.140, 192.168.135.101, rtr805

192.168.80.*, 192.168.*

192.168.22.?

You can enter multiple wildcard characters for selecting the devices.

For example, 192.*.80.*. This is allowed.

You must enter either the complete device name or enter the partial device name appended with wildcard character *. That is,

No devices are selected, if you enter only 192.168 in the Device Name text box.

You have to enter either 192.168* or 192.168.10.10.

The search is not case-sensitive.

The devices that are selected is a unique list. There are no duplicate entries of devices.

For example:

If you have these devices in All Devices and Normal devices nodes: 192.168.10.10, 192.168.10.20, 192.168.10.21, 192.168.10.30, and 192.168.10.31 then,

Select the devices 192.168.10.20, 192.168.10.21, and 192.168.10.30 in the Normal devices node.

Enter the search criteria 192.168.10.2*.

Finally, the selected devices are displayed as, 192.168.10.20, 192.168.10.21, and 192.168.10.30 in the Normal devices node and 192.168.10.20 and 192.168.10.21 in All Devices node. However, the selected devices count that is displayed in the Device Selector is only three and not five.

The All Devices node is expanded without selecting any devices, if the search criteria is not satisfied. The object(s) selected text displays 0 (zero) device selected.