User Guide for Resource Manager Essentials 4.0 (With LMS 2.5)
Adding and Troubleshooting Devices Using Device Management
Downloads: This chapterpdf (PDF - 837.0KB) The complete bookPDF (PDF - 9.12MB) | Feedback

Adding and Troubleshooting Devices Using Device Management

Table Of Contents

Adding and Troubleshooting Devices Using Device Management

Understanding the Device and Credentials Repository

Device Management Administration Settings

Automatic Addition of Device and Credential Repository Devices to RME

Verifying The Device Credentials While Adding Devices to RME

Using the RME Devices Window

Adding Devices to RME

Licensing Behavior While Adding Devices

Adding Devices to RME Manually

Editing Device Attributes While Adding Devices to RME

Adding Devices to RME Automatically

Editing RME Device Attributes

RME Device Attributes Export File Format

Exporting RME Device Credentials

Deleting Devices from RME

Understanding the RME Device States

Working With Normal Devices

Exporting the Normal Devices Credentials

Suspending the Normal Devices

Deleting the Normal Devices

Resubmitting the Normal Devices

Generating the Inventory and Configuration Collection Status Report

Working With Pending Devices

Working With Suspended Devices

Resubmitting the Suspended Devices

Deleting the Suspended Devices

Working With Pre-deployed Devices

Exporting the Pre-deployed Device Credentials

Suspending the Pre-deployed Devices

Deleting the Pre-deployed Devices

Resubmitting the Pre-deployed Devices

Diagnosing Pre-deployed Devices

Working With Alias Devices

Resolving an Alias Device

Working With Conflicting Device Types

Resolving the Conflicting Device Type

Deleting the Conflicting Device Type

Using Device Credential Verification Window

Checking and Viewing Device Credentials

Editing Device Credentials

Device List Manipulation Service

XML DTD for DLMS

Guidelines for Creating the XML File

Adding Devices to Device Credentials Using DLMS

Listing the Devices and Their Status Using DLMS

Getting the Device Credentials Data

Setting the Device Credentials Using DLMS

Getting the Device IP Address

Sample DLMS XML Request File

Sample Java and PERL Scripts to Invoke the Servlet

Java Example

PERL Example

Using RME Device Selector

Using the All Tab

Using the Select Button

Using the Filter Button

Using Filter Button—An Example

Device Icons and Device Types


Adding and Troubleshooting Devices Using Device Management


For RME to work with devices, you must first add devices to Common Services Device and Credential Repository. Once a device is added to the Device and Credential Repository, you can then add it to the RME.

You can add devices from the Device and Credential Repository to RME automatically by enabling Automatically Manage Devices from Credential Repository (by default, this is enabled), or you can add them selectively by disabling Automatically Manage Devices from Credential Repository setting in the Device Management Setting window.

For more information on how to add devices to RME, see Adding Devices to RME.

Once you have added the devices to RME, RME applications' such as Configuration Management, Inventory, and Software Management will use the credentials stored in Device and Credential Repository.

You can perform the following tasks using RME Device Management:

Adding devices to RME from Common Services' Device and Credential Repository.

You can add devices to RME only after adding devices to Common Services' Device and Credential Repository.

You can also check the device credentials while adding devices by selecting the check box, Verify Device Credentials While Adding Devices on Device Management Settings window (Resource Manager Essentials > Admin > Device Mgmt > Device Management Settings).

See Adding Devices to RME for further details.

List RME devices

Displays all RME devices and their respective states.

See Understanding the RME Device States for further details.

Delete RME Devices

Delete devices, including all related device information, that you no longer track.

See Deleting Devices from RME for further details.

Change Device Credentials for RME Devices

A launch point is provided in RME to update device information that is present in Device and Credential Repository. You can edit these credentials, SNMP read and write community strings, Telnet and console-enable passwords, TACACS and local usernames and passwords.

See Editing Device Credentials for further details.

Exporting Device Credentials for RME Devices

Export the device credentials for RME devices in CSV 3.0 and XML file formats.

See Exporting RME Device Credentials for further details.

Check Device Credentials on RME Devices

Verify that Device and Credential Repository credentials match actual device credentials. This includes SNMP read and write community strings, Telnet and console-enable passwords, and TACACS and local usernames and passwords.

You can automatically check device credentials when you add or import devices.

See Checking and Viewing Device Credentials for further details.

Setting the RME Device Attributes

Set the default device attributes in RME such as Serial Number, SNMP timeout, SNMP retry, Telnet timeout, and RME ID (NAT ID).

See Editing RME Device Attributes for further details.

Using RME Device Selector

Select the RME devices to perform the different RME tasks.

See Using RME Device Selector for further details.

Set the debug mode for RME Device Management and Device Selector applications

You can set the debug mode for RME Device Management and Device Selector applications in the Log Level Settings dialog box (Resource Manager Essentials > Admin > System Preferences > Loglevel Settings).

See Log Level Settings for further details.

Using Device Center you can perform the following Device Management tasks:

Check device credentials

Generate Device Credential Verification report

See RME Device Center for further details.

You can perform the following tasks using the command line utility:

You can check the specified device credentials for the RME devices using cwcli inventory cda.

You can export device credentials of one or more RME devices in clear text using cwcli inventory crmexport.

You can delete the specified RME devices using cwcli inventory deletedevice.

You can view the RME devices state cwcli inventory getdevicestate.

See Overview: cwcli inventory Command for further details.

You can perform the following tasks using the Device List Manipulation Service:

Add devices

List the RME devices and their status

Get the device credentials data

Set the device credentials data

Get the device IP address

See Device List Manipulation Service for further details.

For the new features in this release, see "What's New in This Release and RME Feature List".

Understanding the Device and Credentials Repository

The Device and Credential Repository is part of Common Services application. This is a centralized device repository for sharing device credentials across all applications that are installed on CiscoWorks server.

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

Add a device

Import bulk devices

Edit device credentials

View the list of devices on CiscoWorks server

You can also, export and delete devices in Device and Credential Repository.

You cannot add devices directly to the RME. You must first add the devices to the Common Services' Device and Credential Repository and then import the devices to RME.

The RME application uses these device credentials from the Device and Credential Repository:

Device identity information such as IP address/host name.

Device access information such as user names/passwords and SNMP community strings.

When a device is deleted from RME, the Device and Credential Repository is not affected. You can selectively add the devices back to RME. If a device is deleted from Device and Credential Repository, the device is also deleted from the RME application.

For more information on the Device and Credential Repository, see the Common Services Online Help and User Guide.

Device Management Administration Settings

Before adding devices to RME you can set these Device Management Settings for:

Automatically adding devices to RME from Device Credentials Repository

Select the check box Automatically Manage Devices from Credential Repository on Device Management Settings window (Resource Manager Essentials > Admin > Device Mgmt).

See Automatic Addition of Device and Credential Repository Devices to RME.

This option is enabled by default. If you want to manually add device to RME, then disable this option.

See Adding Devices to RME Manually

Verifying the device credentials while adding devices to RME

Select the check box Verify Device Credentials While Adding Devices on Device Management Settings window (Resource Manager Essentials > Admin > Device Mgmt).

See Verifying The Device Credentials While Adding Devices to RME.

Selecting the device credentials that need to be verified while adding devices to RME

Select the device credentials using Resource Manager Essentials >
Admin > Device Mgmt > Device Credential Verification Settings
.

See Verifying The Device Credentials While Adding Devices to RME.

Automatic Addition of Device and Credential Repository Devices to RME

Whenever you add devices to Common Services' Device and Credential Repository, RME triggers the Device Auto Management service. The devices that are added to Device and Credential Repository gets added to RME automatically.

This service is enabled by default. That is, once you have added device to Device and Credential Repository then automatically the devices get added to RME.

The Device Auto Management service gets triggered only when you add devices to Common Services Device and Credential Repository through,

User interface (Common Services > Device and Credentials > Device Management)

Command line tool dcrcli

This service is not triggered when you upgrade a CiscoWorks license file.


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


To enable the Device Auto Management setting:


Step 1 Select Resource Manager Essentials > Admin > Device Mgmt > Device Management Settings.

The Device Management Settings dialog box appears.

Step 2 Select Automatically Manage Devices from Credential Repository.

Step 3 Click OK.

If any new devices are added in Device and Credential Repository (Common Services > Device and Credentials > Device Management) these devices are also added in RME automatically.

If there are any devices that are deleted from RME before enabling this option, those devices are not added to RME. You have to add those devices to RME manually. See Adding Devices to RME Manually.

Click either on:

Resource Manager Essentials > Devices > Device Management to view the RME device state.

or

Resource Manager Essentials > Devices > Device Management > RME Devices to view the RME devices.


Verifying The Device Credentials While Adding Devices to RME

You can check your device credentials while adding devices to RME and view the results in a report. Use this option to make sure that your Device and Credential Repository credentials, match your actual device credentials.

Verifying device credentials while adding devices to RME involve:

1. Selecting the credentials that need to be verified while adding devices to RME.

2. Selecting the verify device credentials while adding devices.

3. Viewing the credentials verification report.

Before performing Step 3, you must add devices to RME. See Adding Devices to RME to add devices to RME.


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


To select the credentials that need to be verified while adding devices to RME:


Step 1 Select Resource Manager Essentials > Admin > Device Mgmt > Device Credential Verification Settings.

The Device Credential Verification Settings dialog box appears.

Step 2 Select the credentials that need to be checked.

You can check the following device credentials:

SNMP Read Community String—SNMP version 2 read community string.

SNMP Write Community String—SNMP version 2 write community string.

SNMPv3—SNMP version 3 username and password

Telnet—Telnet username and password.

Telnet Enable Mode User Name and Password—Telnet username and password in Enable mode.

SSH—SSH username and password.

SSH Enable Mode User Name and Password—SSH username and password in Enable mode.

To view all these credentials select All.

By default, these credentials are checked:

SNMP Read Community String

SNMP Write Community String

Telnet

Telnet Enable Mode User Name and Password

Step 3 Click OK.


To select the verify device credentials while adding devices:


Step 1 Select Resource Manager Essentials > Admin > Device Mgmt > Device Management Settings.

The Device Management Settings dialog box appears.

Step 2 Select Verify Device Credentials While Adding Devices.

Step 3 Click OK.


To view the device verification report:


Note Before performing the step 3, you must add devices to RME. See Adding Devices to RME to add devices to RME.



Step 1 Select Resource Manager Essentials > Devices > Device Management > Device Credential Verification.

The Device Credential Verification dialog box appears.

Step 2 Select the devices that was added newly using either the RME@ciscoworks_server or CS@ciscoworks_server group.

Step 3 Click View Credential Verification Report.

The Credential Verification Report appears. See Credentials Mapping and Understanding Credential Verification Report tables for further information.


Using the RME Devices Window

This window lists all devices in RME. This window contains the following pane and buttons:

Table 3-1 RME Devices Window 

Pane/Buttons
Description

RME Device Selector

(Pane)

This lists all devices in RME.

The devices are identified by the Display Name that you have entered while adding devices to Device and Credential Repository.

See Using RME Device Selector for more information.

Add Devices

(Button)

Add devices to RME manually.

See Adding Devices to RME.

Edit Device Attributes

(Button)

Editing the RME device attributes. The device attributes are:

Serial Number

SNMP Retry

SNMP Timeout

Telnet Timeout

RME ID (NAT ID)

See Editing RME Device Attributes.

Delete

(Button)

Delete RME devices.

See Deleting Devices from RME.

Export

(Button)

Export the RME device credentials into to a file. The supported export file formats are CSV (version 3.0 and XML).

See Exporting RME Device Credentials.


Adding Devices to RME

You add devices to RME either manually or automatically. Before adding devices to RME you must add devices into Device and Credential Repository using Common Services > Device and Credentials > Device Management.

You can either:

Add devices manually (See Adding Devices to RME Manually)

Or

Add devices automatically (See Adding Devices to RME Automatically)

By default, the Automatically Manage Devices from Credential Repository option in the Device Management Settings window is enabled.

If RME is down when you add devices to Device and Credential Repository, the devices get automatically added when RME is back online, if the Automatically Manage Devices from Credential Repository option is enabled. If this option is not enabled, you have to add devices manually.

After adding devices to RME, RME automatically schedules for a device inventory and configuration collection.

For Inventory collection to happen, you must ensure that you have entered the correct read community string in Device and Credential Repository. RME acquires inventory data from devices using SNMP queries to both standard SNMP MIB II objects and Cisco-specific enterprise MIB objects.

For Configuration collection to happen, you should have entered the correct read and write community strings and telnet credentials in Device and Credential Repository.

See Supported Device Table for RME 4.0 on Cisco.com to know the list of devices that are supported in RME:

http://www.cisco.com/univercd/cc/td/doc/product/rtrmgmt/cw2000/cw2000e/e_4_x/4_0/index.htm

Licensing Behavior While Adding Devices

If the number of devices that you added in Device and Credential Repository exceeds the licensed device limit, RME selects the option that results in fewer devices. The options are:

The number of devices permitted by the license and an additional 10% of the licensed device limit are added.

or

The number of devices permitted by the license and an additional 100 devices are added

For example, if you have a license for 5000 devices, you are allowed to manage only up to 5100 devices. This is because 10% of 5000 devices is 500 devices, which is more than 100 devices.

Licensing Behavior While Adding Devices Automatically

If you have enabled the Automatically Manage Devices from Credential Repository option and reached the maximum device limit, when you continue to add devices to Device and Credential, the option that results in fewer devices is selected and added to RME.

For example, if you have a license for 300 devices and you attempt to add 40 more devices, only 330 devices are added. The remaining 10 devices continue to be in Device and Credential Repository.

Licensing Behavior While Adding Devices Manually

If you have disabled the Automatically Manage Devices from Credential Repository option, reached the maximum device limit, and selected a large number devices for adding into RME, none of devices are added.

For example, if you have a license for 300 devices and attempt to add 40 more devices, none of these devices are added to RME.

Adding Devices to RME Manually

You can use this option to selectively add devices to RME from Device and Credential Repository or when you have deleted devices in RME and you want to readd those devices to RME.


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


To add devices to RME manually:


Step 1 Check if the Automatically Manage Devices from Credential Repository on Device Management Settings window (Resource Manager Essentials > Admin > Device Mgmt) is disabled.

Step 2 Select Resource Manager Essentials > Devices > Device Management > RME Devices.

The RME Devices dialog box appears.

Step 3 Click Add Devices without selecting any devices from the RME Device Selector.

The Devices in Device Credential Repository dialog box appears.

If there are no devices in Device and Credential Repository that needs to be added in RME, then a message appears, There are no new devices in DCA. Please click here to add devices in DCA.

If you want to add devices to Device and Credentials Repository, then click on the link or click OK to exit.

Step 4 Select the devices from the Common Services group (CS@ciscoworks_server).

To select all the devices, select the CS@ciscoworks_server check box.

To select particular device type, expand the CS@ciscoworks_server and the System Defined Groups and then select the device type (for example, Routers, Switches and Hubs, etc.).

To select individual device, expand the Common Services group till you see the device Display Name and then select the device.

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

Step 5 Click Next.

The View RME Attributes dialog box appears with the following information:

Column Name
Description

Device Display Name

Display name of the device as entered in Device and Credential Repository.

Serial Number

Cisco manufacturing serial number from chassis. You can enter 0 to 255 alphanumeric characters.

The default value is Default Not Defined.

SNMP Retry (Count)

Number of times, system should try to access devices with SNMP options.

The default value is 2 and the maximum value is 6.

SNMP Timeout (Secs)

Amount of time, system should wait for a device to respond before it tries to access it again.

The default value is 2 seconds and the maximum value is 90 seconds.

Changing the SNMP timeout value affects inventory collection.

Telnet Timeout (Secs)

Amount of time, system should wait for a device to respond before it tries to access it again.

The default value is 36 seconds and the maximum value is 200 seconds.

Changing the Telnet timeout value affects inventory collection.

RME ID

The RME server ID. This is the translated address of RME server as seen from the network where the device resides.

This is used when RME tries to contact devices outside the NAT boundary.

The default value is Default Not Defined.

See Managing Devices When RME Server is Within a NAT Boundary for further details.


Step 6 Click either

Export to edit the RME device attributes in bulk.

Or

Edit Device Attributes to edit the RME device attributes for a single device.

See Editing Device Attributes While Adding Devices to RME for more details.

Step 7 Click Finish.

A notification window displays, Devices selected will be added to RME. Click on Pending Devices to verify the progress.

Step 8 Click OK.

The RME Devices window appears with the newly added devices.

To view the RME device state, click on Resource Manager Essentials > Devices > Device Management.


Editing Device Attributes While Adding Devices to RME

In the View RME Attributes dialog box you can either click

Export to edit the RME device attributes in bulk.

Or

Edit Device Attributes to edit the RME device attributes for a single device.

If you click on the Export button, then follow this procedure to edit the device attributes:


Step 1 Click Export.

The Export Device Credentials to File dialog box appears.

Step 2 Enter the folder name and the filename on the RME server.

or

Click Browse to select a folder on the RME server.

The Server Side File Browser dialog box appears.

a. Select a folder and enter the filename on the RME server.

b. Click OK.

Step 3 Click OK.

Step 4 Edit the exported file.

You can edit only the RME device attributes, Serial Number, SNMP Retry, SNMP Timeout, Telnet Timeout, and RME ID (NAT ID). You cannot edit the Device Display Name (device_identity) or add new device entries.

See RME Device Attributes Export File Format for further information.

Step 5 Click Import

The Import Device Credentials to File dialog box appears.

We recommended that you import the same file that you have exported after editing. If any new device entries are added, those device entries are ignored. Only device entries that match the existing device entries are imported.

Step 6 Enter the folder name and the filename on the RME server.

or

Browse to select a folder on the RME server.

The Server Side File Browser dialog box appears.

a. Select a folder and file on the RME server.

b. Click OK.

Step 7 Click OK.

The RME Device Attributes window refreshes to display the updated RME device attributes.


Note While importing the edited device attributes file an error message may appear, Attribute values for device(s) are invalid. Please see EssentialsDM.log for more details. This file is available at this location, /var/adm/CSCOpx/log on Solaris and NMSROOT/log on Windows. Where NMSROOT is the CiscoWorks installed directory.


See Adding Devices to RME Manually to continue to manually add devices to RME.


If you click on the Edit Device Attributes button, follow this procedure to edit the device attributes:


Step 1 Click Edit Device Attributes.

The Device Attributes Information dialog box appears.

Step 2 Select a device from the Devices pane.

Step 3 Edit the device attributes in the Device Information pane.

Step 4 Click Modify.

See Adding Devices to RME Manually to continue the procedure of adding devices to RME manually.


Adding Devices to RME Automatically

Whenever you add devices to Common Services' Device and Credential Repository, RME triggers the Device Auto Management service. The devices that are added to Device and Credential Repository gets added to RME automatically.

By default, the Automatically Manage Devices from Credential Repository option in the Device Management Settings window is enabled.

The Device Auto Management service gets triggered when you add devices to Common Services' Device and Credential Repository through

User interface (Common Services > Device and Credentials > Device Management).

Command line tool dcrcli

This service is not triggered when you upgrade a RME license file.


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


To enable the Device Auto Management setting:


Step 1 Select Resource Manager Essentials > Admin > Device Mgmt > Device Management Settings.

The Device Management Settings dialog box appears.

Step 2 Select Automatically Manage Devices from Credential Repository.

Step 3 Click OK.

Here after, if any new devices are added in Device and Credential Repository (Common Services > Device and Credentials > Device Management) then automatically those devices get added in RME.

If there are any devices that are deleted from RME before enabling this option, those devices are not added to RME. You have to add those devices to RME manually. See Adding Devices to RME Manually.

Click either on

Resource Manager Essentials > Devices > Device Management to view the RME device state.

or

Resource Manager Essentials > Devices > Device Management > RME Devices to view the RME devices.


Editing RME Device Attributes

The RME device attributes are:

Serial Number

Cisco manufacturing serial number from chassis. You can enter alphanumeric characters up to 255.

The default value is Default Not Defined.

This attribute is available only when you export the RME device attributes from the RME Devices window.

SNMP Retry

Number of times, the system should try to access devices with SNMP options.

The default value is 2 and the maximum value is 6.

SNMP Timeout

Duration of time, system should wait for a device to respond before it tries to access it again.

The default value is 2 seconds and the maximum value is 90 seconds.

Changing the SNMP timeout value affects inventory collection.

Telnet Timeout

Duration of time, system should wait for a device to respond before it tries to access it again.

The default value is 36 seconds and the maximum value is 200 seconds.

RME ID (NAT ID)

The RME server ID. This is the translated address of RME server as seen from the network where the device resides.

This is used when RME tries to contact devices outside the NAT boundary, you need to enable support for NAT.

The default value is Default Not Defined.

See Managing Devices When RME Server is Within a NAT Boundary for further details.

You can either:

Set a default device attributes value for all RME devices using Resource Manager Essentials > Admin > System Preferences > RME Device Attributes.

or

Set different device attributes value for different RME devices using Resource Manager Essentials > Devices > Device Management > RME Devices > Edit Device Attributes.


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


To set a default device attributes:


Step 1 Select Resource Manager Essentials > Admin > System Preferences > RME Device Attributes.

The RME Device Attributes dialog box appears.

Step 2 Enter the default value for:

SNMP Retry

SNMP Timeout

Telnet Timeout

RME ID

The value you enter here will be applicable for all RME devices.

You can change the value for individual devices and also enter the device serial number information using the Edit Device Attributes option on RME Devices window. (see To set or edit the RME device attributes for individual RME devices:.)

Step 3 Click Apply.

A confirmation message appears, Default settings are updated successfully.

Step 4 Click OK.


To set or edit the RME device attributes for individual RME devices:


Step 1 Select Resource Manager Essentials > Devices > Device Management > RME Devices.

The RME Devices dialog box appears.

Step 2 Select the devices for which you want to edit the RME device attributes. See Using RME Device Selector for further information.

Step 3 Click Edit Device Attributes.

The Device Attributes Information dialog box appears.

Step 4 Select a device from the Devices pane.

Step 5 Edit the device attributes in the Device Information pane.

Step 6 Click Modify.


RME Device Attributes Export File Format

The RME device attributes are exported in CSV 3.0 format. The exported file format is:

; This file is generated by DM Export utility
Cisco Systems NM Data import, Source=DM Export; Type=DMCSV; 
Version=3.0

;
;Start of section 0 - DM Export
;
;HEADER: 
device_identity,serial_number,SNMPRetryCount,SNMPTimeout,TelnetTimeout
,RMEId
;
192.168.8.4,Default Not Defined,2,2,36,Default Not Defined

;End of CSV file

Where,

device_identity—Display name of the device as entered in Device and Credential Repository.

serial_number—Cisco manufacturing serial number from chassis. You can enter 0 to 255 alphanumeric characters. The default value is Default Not Defined.

SNMPRetryCount—Number of times, system should try to access devices with SNMP options. The default value is 2 and the maximum value is 6.

SNMPTimeout—Duration of time the system should wait for a device to respond before it tries to access it again. The default value is 2 seconds and the maximum value is 90 seconds.

Changing the SNMP timeout value affects inventory collection.

TelnetTimeout—Duration of time the system should wait for a device to respond before it tries to access it again. The default value is 36 seconds and the maximum value is 200 seconds.

RME Id—RME server ID. This is the translated address of RME server as seen from the network where the device resides. This is used when RME tries to contact devices outside the NAT boundary. The default value is Default Not Defined.

Exporting RME Device Credentials

You can export the device credentials for the RME devices in CSV or XML format.

You can also export RME device credentials using the command line tool,
cwcli inventory crmexport. See Overview: cwcli inventory Command.

You can import the edited device credentials using Common Services > Device and Credentials > Device Management > Bulk Import.


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


To export RME devices credentials:


Step 1 Select Resource Manager Essentials > Devices > Device Management > RME Devices.

The RME devices dialog box appears.

Step 2 Select the RME devices. See Using RME Device Selector for further information.

Step 3 Click Export.

A message appears, Export will store password in clear text. Do you still want to continue?

Step 4 Click OK to continue or Cancel to abort the export.

If you click OK, then the Export To File dialog box appears.

a. Enter the folder name and the filename on the RME server.

or

Browse to select a folder on the RME server.

The Server Side File Browser dialog box appears.

Select a folder and file on the RME server.

Click OK.

b. Select the file format, CSV or XML.

The supported version for CSV is 3.0.


Warning The device passwords will be displayed in plain text.


Step 5 Click OK.

The RME devices dialog box appears.

The exported file is saved on the RME server.

You can import the edited device credentials using Common Services > Device and Credentials > Device Management > Bulk Import.

See Common Services Online help for further information on export file formats and procedure for importing a device file.


Deleting Devices from RME

The devices in the Delete state cannot participate in any RME application flows. The Delete devices historical data is not retained in the RME database.

However, you can re-add the devices using Resource Manager Essentials > Devices > Device Management > RME Devices > Add Devices.

The device information is retained in the Device and Credential Repository. This information is not removed till you delete the device from Common Services > Device and Credentials > Device Management.

If RME is down when you delete devices from Device and Credential Repository, the devices get deleted from RME when RME is back online.

You can also delete the RME devices using the command line tool,
cwcli inventory deletedevice. See Overview: cwcli inventory Command.

For NAM devices, the Supervisor device must be in RME. You cannot work with NAM devices if the Supervisor device is not in RME.


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


To delete devices from RME:


Step 1 Select Resource Manager Essentials > Devices > Device Management > RME Devices.

The RME devices dialog box appears.

Step 2 Select the RME devices. See Using RME Device Selector for further information.

A message appears, Are you sure you want to delete?

Step 3 Click OK.

The RME Devices window appears without the deleted device.

You can view the Deleted devices by navigating to Resource Manager Essentials > Devices > Device Management > RME Devices > Add Devices as these devices still exist in Device and Credential Repository.


Understanding the RME Device States

After adding devices in RME, you can check the state of the RME devices using Resource Manager Essentials > Devices > Device Management option.

You can also view the RME devices state using the command line tool
cwcli inventory getdevicestate. See Overview: cwcli inventory Command.


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


Click on this icon to refresh the RME device states.


The RME devices can be in one of the following states:

Normal

In the Normal device state, the device has been successfully contacted by RME or the device has contacted RME at least once (polling, successful job completion, Syslog receipt etc.). This indicates that this is a real device in the network (at one point in time).

This state does not guarantee that we have had a successful Inventory and Configuration Collection.

See Working With Normal Devices for further details on Normal devices.

Pre-deployed

In the Pre-deployed device state, the device has never been contacted by RME through protocols such as SNMP, Telnet, SSH, etc. If RME successfully contacts the device through the tasks such as Inventory polling, Configuration polling receiving syslog messages, etc., the device will move to a Normal state.

The Pre-deployed device state, indicates that the devices are not in the network and are awaiting to be deployed.

See Working With Pre-deployed Devices for further details on Pre-deployed devices.

Alias

When you add a new device to RME, this device may already exist in RME, but with another hostname or IP address. This device will be in the Alias state.

See Working With Alias Devices for further details on Alias devices.

Pending

When the device is added to RME, RME device management moves the device into this state, and invokes all the registered application tasks such as Inventory Collection and Configuration collection.

Based on the results of the tasks, the device moves to one of these states—Pre-deployed, Normal or Aliased.

The Pending state is a transient state and no device will be in this state for any significant time.

See Working With Pending Devices for further details on Pending devices.

Conflicting

The Conflicting device state occurs if the sysObjectID in the device and that in the Device and Credential Repository do not match.

See Working With Conflicting Device Types for further details on Conflicting devices.

Suspended

State of a device by virtue of explicit action wherein a device cannot participate in any application flows but all historical data pertaining to the device will continue to be maintained by RME. You can re-submit the devices in this state for participation in RME workflows.

See Working With Suspended Devices for further details on Suspending devices.

See Understanding RME Device State Transition to understand the RME device state transitions.

Working With Normal Devices

In the Normal device state, the device has been successfully contacted by RME or the device has contacted RME at least once (polling, successful job completion, Syslog receipt etc.). This indicates that this is a real device in the network (at one point in time).

This state does not guarantee that you have had a successful Inventory and Configuration Collection.

You can schedule for a Inventory Collection using Resource Manager Essentials > Devices > Inventory > Inventory Jobs (Create button) and Configuration Collection using Resource Manager Essentials > Config Mgmt > Archive Mgmt > Sync Archive.

You can perform all the RME application tasks using RME Normal device state.

The Normal Devices window contains the following pane and buttons:

Table 3-2 Normal Devices Window 

Pane/Buttons
Description

RME Device Selector

(Pane)

This lists all devices in RME.

The devices are identified by the Display Name that you have entered while adding devices to Device and Credential Repository.

See Using RME Device Selector for more information.

Export

(Button)

Export the Normal state devices.

See Exporting the Normal Devices Credentials

Suspend

(Button)

Suspend the Normal state devices.

See Suspending the Normal Devices

Delete

(Button)

Delete the Normal state devices.

See Deleting the Normal Devices

Resubmit

(Button)

Resubmit the Normal state devices.

See Resubmitting the Normal Devices

Report

(Button)

Generate Inventory and Configuration collection status report.

See Generating the Inventory and Configuration Collection Status Report.

(Icon)

Click on this icon to refresh the RME device states.


Exporting the Normal Devices Credentials

To export the Normal device list:


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



Step 1 Select Resource Manager Essentials > Devices > Device Management > Normal Devices.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Normal Device State.

The Normal devices dialog box appears.

Step 2 Select the RME devices that are in Normal state. See Using RME Device Selector for more information.

Step 3 Click Export.

A message appears, Export will store password in cleartext. Do you still want to continue?

Click OK to continue or Cancel to abort the export.

If you click OK, then the Export To File dialog box appears.

Step 4 Enter the folder name with the file name on the RME server.

or

Browse to select a folder on the RME server.

The Server Side File Browser dialog box appears.

a. Select a folder on the RME server.

b. Click OK.

c. Enter the file name with the file extension either CSV or XML.

Step 5 Select the Export File Type, CSV or XML.

The supported version for CSV is 3.0.


Warning The device passwords will be displayed in plain text.


Step 6 Click OK.

The devices that you have selected will be exported.

See Common Services Online help for further information on export file formats.


Suspending the Normal Devices

The devices in the Suspended state cannot participate in any RME application flows. However, you can re-submit the devices in this state for participation in RME workflows using Resource Manager Essentials > Devices > Device Management > Suspended Devices. The Suspend devices historical data is retained in the RME database.


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


To suspend the Normal device list:


Step 1 Select Resource Manager Essentials > Devices > Device Management > Normal Devices.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Normal Device State.

The Normal devices dialog box appears.

Step 2 Select the RME devices that are in Normal state. See Using RME Device Selector for more information.

Step 3 Click Suspend.

A confirmation dialog box appears.

Step 4 Click OK.

You can view the Suspended device list by navigating to Resource Manager Essentials > Devices > Device Management > Suspended Devices.


Deleting the Normal Devices

The devices in the Delete state cannot participate in any RME application flows. The Delete devices historical data is not retained in the RME database. However, you can re-add the devices using Resource Manager Essentials > Devices > Device Management > Add Devices.

The device information is retained in the Device and Credential Repository. This information is not removed till you delete the device from Common Services > Device and Credentials > Device Management.


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


To delete the Normal devices:


Step 1 Select Resource Manager Essentials > Devices > Device Management > Normal Devices.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Normal Device State.

The Normal devices dialog box appears.

Step 2 Select the RME devices that are in Normal state. See Using RME Device Selector for more information.

Step 3 Click Delete.

A confirmation dialog box appears.

Step 4 Click OK.

You can view the Deleted devices by navigating to Resource Manager Essentials > Devices > Device Management > Add devices as these devices still exist in Device and Credential Repository.


Resubmitting the Normal Devices

Whenever you change any of the device credentials in the Device and Credential Repository using Common Services > Device and Credentials > Device Management, the RME may not get updated.

For example, if you perform any one of the following updates in the Device and Credential Repository, you must also update the RME. Otherwise some of the RME tasks may fail:

If you update sysObjectID, Device type, or MDF type in the Device and Credential Repository incorrectly, RME may not change the Normal device state to Conflicting device state. So RME applications that access the Device and Credential Repository may fail.

If you update the IP address or hostname in the Device and Credential Repository, RME may not trigger inventory collection.


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


To update the RME whenever there is change in the Device and Credential Repository:


Step 1 Select Resource Manager Essentials > Devices > Device Management > Normal Devices.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Normal Device State.

The Normal Devices dialog box appears.

Step 2 Select the RME devices that are in Normal state. See Using RME Device Selector for more information.

Step 3 Click Resubmit.

A confirmation dialog box shows that the devices has been added to the Pending list.

Step 4 Click OK.

The devices will be re-added to the RME.

Click Resource Manager Essentials > Devices > Device Management to view the device status.


Generating the Inventory and Configuration Collection Status Report

You can view the status of the last Inventory and Configuration collection.

If the collection status is failed, you can schedule for a Inventory Collection using Resource Manager Essentials > Devices > Inventory > Inventory Jobs (Create button) and Configuration Collection using Resource Manager Essentials > Config Mgmt > Archive Mgmt > Sync Archive.


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


To generate a collection status report:


Step 1 Select Resource Manager Essentials > Devices > Device Management > Normal Devices.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Normal Device State.

The Normal Devices dialog box appears.

Step 2 Select the RME devices that are in Normal state. See Using RME Device Selector for more information.

Step 3 Click Report.

The Device Status Report appears in a separate browser window.

See Checking Configuration Archival Status to understand the different configuration collection status.


The following buttons are available on the Device Status Report:

Button
Description

You can export this report in either PDF or CSV format.

Generates a format that can be printed.


Working With Pending Devices

When the device is added to RME, RME device management moves the device into this state, and invokes all the registered application tasks such as Inventory Collection and Configuration collection.

Based on the results of the tasks, the device moves to one of these states—Pre-deployed, Normal or Aliased.

The Pending state is a transient state and no device will be in this state for any significant time. If the devices are in this state for a longer time, you can suspend the devices and resubmit for managing.

To do this use, Resource Manager Essentials > Devices > Device Management > Suspended Devices.

The Pending Devices window contains the following pane and button:

Table 3-3 Pending Devices Window 

Pane/Buttons
Description

Device Identity

(Pane)

This lists all devices in RME that are in Pending state.

The devices are identified by the Display Name that you have entered while adding devices to Device and Credential Repository.

Suspend

(Button)

Suspend the Pending state devices.

See To suspend the Pending devices:

This button gets activated only after selecting devices from Device Identity pane.

(Icon)

Click on this icon to refresh the RME device states.



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


To suspend the Pending devices:


Step 1 Select Resource Manager Essentials > Devices > Device Management > Pending Devices.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Pending Device State.

The Pending devices dialog box appears.

Step 2 Select the devices.

Step 3 Click Suspend.

A confirmation dialog box appears.

Step 4 Click OK.

You can view the Suspended device list by navigating to Resource Manager Essentials > Devices > Device Management > Suspended Devices.


Working With Suspended Devices

Suspended device state cannot participate in any RME application flows but all historical data pertaining to the device will continue to be maintained by RME.

The Suspended Devices window contains the following pane and buttons:

Table 3-4 Suspended Devices Window 

Pane/Buttons
Description

Device Identity

(Pane)

This lists all devices in RME that are in Suspended state.

The devices are identified by the Display Name that you have entered while adding devices to Device and Credential Repository.

Resubmit

(Button)

Re-submit the Suspended state devices.

See Resubmitting the Suspended Devices.

This button gets activated only after selecting devices from Device Identity pane.

Delete

(Button)

Delete the Suspended state devices.

See Deleting the Suspended Devices.

This button gets activated only after selecting devices from Device Identity pane.


Resubmitting the Suspended Devices

If you want to re-add the devices to RME, then you can re-submit the Suspended devices:


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


To re-submit the Suspended devices:


Step 1 Select Resource Manager Essentials > Devices > Device Management > Suspended Devices.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Suspended Device State.

The Suspended devices dialog box appears.

Step 2 Select the devices.

Step 3 Click Resubmit.

A confirmation dialog box appears.

Step 4 Click OK.

You can view the state of these RME devices using Resource Manager Essentials > Devices > Device Management.


Deleting the Suspended Devices

The devices in the Delete state cannot participate in any RME application flows. The Delete devices historical data is not retained in the RME database. However, you can re-add the devices using Resource Manager Essentials > Devices > Device Management > Add Devices.

The device information is retained in the Device and Credential Repository. This information is not removed till you delete the device from Common Services > Device and Credentials > Device Management.

To delete the Suspended devices:


Step 1 Select Resource Manager Essentials > Devices > Device Management > Suspended Devices.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Suspended Device State.

The Suspended devices dialog box appears.

Step 2 Select the devices.

Step 3 Click Delete.

A confirmation dialog box appears.

Step 4 Click OK.

You can view the Deleted devices by navigating to Resource Manager Essentials > Devices > Device Management > Add devices since these devices still exist in Device and Credential Repository.


Working With Pre-deployed Devices

In the Pre-deployed device state, the device has never been contacted by RME through protocols such as SNMP, Telnet, SSH, etc. If RME successfully contacts the device through the tasks such as Inventory polling, Configuration polling receiving syslog messages, etc., the device will move to a Normal state.

In the Pre-deployed device state, there is no successful inventory or configuration collection for the device.

The Pre-deployed device state indicates that the devices are not in the network and are waiting to be deployed.

The Pre-deployed devices appear in the RME device selector as a separate group. These devices also appear under the appropriate MDF-based groups, depending on the Device Type information that you have entered in the Device and Credential Repository (Common Services > Device and Credentials > Device Management).

You can perform application tasks (including jobs) on Pre-deployed devices in the same way as you do with the Normal state devices.

However, for Pre-deployed devices you cannot run application tasks such as Distribution By devices [Basic] job, Distribution By image job, etc. This is because the information needed for such tasks will be available only after RME contacts the devices.

For example, Software Management Distribution By devices [Advanced] job succeeds. This is because no data (either current or cached) is needed from the device for this task.

However, Software Management Distribution By devices [Basic] job fails. This is because the device inventory data is needed from the device for this task.

For all devices in the pre-deployed state, you can schedule:

The RME Inventory polling and collection jobs (Resource Manager Essentials > Devices > Inventory > Inventory Jobs)

The RME Configuration polling and collection jobs (Resource Manager Essentials > Config Mgmt > Archive Mgmt > Sync Archive).

If RME succeeds in contacting the device for any of these jobs, the device will be moved to the Normal state.

See Understanding RME Device State Transition to understand the RME device state transition.

The Pre-Deployed Devices window contains the following pane and buttons:

Table 3-5 Pre-Deployed Devices Window 

Pane/Buttons
Description

Device Identity

(Pane)

This lists all devices in RME that are in Pre-deployed state.

The devices are identified by the Display Name that you have entered while adding devices to Device and Credential Repository.

Export

(Button)

Export the Pre-deployed state devices.

See Exporting the Pre-deployed Device Credentials.

Suspend

(Button)

Suspend the Pre-deployed state devices

See Suspending the Pre-deployed Devices.

Resubmit

(Button)

Re-submit the Pre-deployed state devices.

See Resubmitting the Pre-deployed Devices.

This button gets activated only after selecting devices from Device Identity pane.

Delete

(Button)

Delete the Pre-deployed state devices.

See Deleting the Pre-deployed Devices.

This button gets activated only after selecting devices from Device Identity pane.

(Icon)

Click on this icon to refresh the RME device states.


See Diagnosing Pre-deployed Devices section to understand the probable cause for the device to be in Pre-deployed state and what action that needs to be taken to move the device to the Normal state.

Exporting the Pre-deployed Device Credentials

To export the Pre-deployed device list:


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



Step 1 Select Resource Manager Essentials > Devices > Device Management > Pre-Deployed Devices.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Pre-deployed State.

The Pre-Deployed Devices dialog box appears.

Step 2 Select the devices.

Step 3 Click Export.

A message appears, Export will store password in cleartext. Do you still want to continue?

Step 4 Click OK to continue or Cancel to abort the export.

If you click OK, then the Export To File dialog box appears.

Step 5 Enter the folder name with the file name on the RME server.

or

Browse to select a folder on the RME server.

The Server Side File Browser dialog box appears.

a. Select a folder on the RME server.

b. Click OK.

c. Enter the file name with the file extension either CSV or XML.

Step 6 Select the Export File Type, CSV or XML.


Warning The device passwords will be displayed in plain text.


Step 7 Click OK.

The devices that you have selected will be exported.

See Common Services Online help for further information on export file formats.


Suspending the Pre-deployed Devices

The devices in the Suspended state cannot participate in any RME application flows. However, you can re-submit the devices in this state for participation in RME workflows using Resource Manager Essentials > Devices > Device Management > Suspended Devices.


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


To suspend the Pre-deployed device list:


Step 1 Select Resource Manager Essentials > Devices > Device Management > Pre-Deployed Devices.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Pre-Deployed State.

The Pre-Deployed Devices dialog box appears.

Step 2 Select the devices.

Step 3 Click Suspend.

A confirmation dialog box appears.

Step 4 Click OK.

You can view the Suspended device list by navigating to Resource Manager Essentials > Devices > Device Management > Suspended Devices.


Deleting the Pre-deployed Devices

The devices in the Delete state cannot participate in any RME application flows. The Delete devices historical data is not retained in the RME database. However, you can re-add the devices using Resource Manager Essentials > Devices > Device Management > Add Devices.

The device information is retained in the Device and Credential Repository. This information is not removed till you delete the device from Common Services > Device and Credentials > Device Management.


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


To delete the Pre-deployed devices:


Step 1 Select Resource Manager Essentials > Devices > Device Management > Pre-Deployed Devices.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Pre-deployed Device State.

The Pre-Deployed Devices dialog box appears.

Step 2 Select the devices.

Step 3 Click Delete.

A confirmation dialog box appears.

Step 4 Click OK.

You can view the Deleted devices by navigating to Resource Manager Essentials > Devices > Device Management > Add devices as these devices still exist in Device and Credential Repository.


Resubmitting the Pre-deployed Devices

Whenever you change any of the device credentials in the Device and Credential Repository using Common Services > Device and Credentials > Device Management, the RME may not get updated.

For example, if you perform any one of the following updates in the Device and Credential Repository, you must also update the RME. Otherwise some of the RME tasks may fail, for example if you update the IP address or hostname in the Device and Credential Repository, RME may not trigger inventory collection.


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


To update the RME whenever there is change in the Device and Credential Repository:


Step 1 Select Resource Manager Essentials > Devices > Device Management > Pre-Deployed Devices.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Pre-deployed State.

The Pre-Deployed Devices dialog box appears.

Step 2 Select those devices where the credentials are updated in Device and Credential Repository using Common Services > Device and Credentials > Device Management.

Step 3 Click Resubmit.

A confirmation dialog box displays that the devices has been added to the Pending list.

Step 4 Click OK.

The devices will be re-added to the RME.

Click Resource Manager Essentials > Devices > Device Management to view the device status.


Diagnosing Pre-deployed Devices

This procedure can help you diagnose Pre-deployed devices which are displayed in the Device Management State Summary window.

You can follow any one of these methods to diagnose a Pre-deployed devices:

Check if the inventory or configuration collection was successful. (See Procedure 1.)

Check if the device credentials entered are correct. (See Procedure 2.)

Check device connectivity by protocol, run ping on a device, and trace the route between the management station and a device. (See Procedure 3.)

Procedure 1

Check if the inventory or configuration collection was successful.


Step 1 Select Resource Manager Essentials > Devices > Device Management > Normal Devices.

The Normal Devices dialog box appears.

Step 2 Select Pre-deployed devices group from RME@CiscoWorksServer device group.

Step 3 Click Report.

The Device Status Report appears in a separate browser window.

If the inventory or configuration collection has failed, you can schedule for a:

Inventory collection using Resource Manager Essentials > Devices > Inventory > Inventory Jobs > Create (button).

Configuration collection using Resource Manager Essentials > Config Mgmt > Archive Mgmt > Sync Archive.


Procedure 2

Check if the device credentials entered are correct.


Step 1 Select Resource Manager Essentials > Devices > Device Management > Device Credential Verification.

The Device Credential Verification dialog box appears.

Step 2 Select Pre-deployed devices group from RME@CiscoWorksServer device group.

Step 3 Click Check Device Credential.

The Device Credentials Options dialog box appears.

Step 4 Select the device credentials that you want to verify and click OK.

A notification window appears, Please Click on View Credential Verification Report Button to View the Report.

Step 5 Click OK.

Step 6 Click View Credential Verification Report.

The Credential Verification Report appears.

Click on the Failed link to understand the reasons for failure.

If the device credentials entered is incorrect, you can edit the credentials using Resource Manager Essentials > Devices > Device Management > Device Credential Verification > Edit Device Credentials.

If the connection timeout occurs, you can increase the SNMP and telnet timeout using Resource Manager Essentials > Devices > Device Management > RME Devices > Edit Device Attributes.


Procedure 3

Check device connectivity by protocol, run ping on a device, and trace the route between the management station and a device.


Step 1 Ping the device.

If you specified the Pre-deployed device by IP address, ping to the IP address.

Otherwise, send the request to the fully qualified host name.

Use the default settings for packet size, packet count, and timeout interval. If the ping succeeds, the device is on line and reachable, go to step 2.

If the ping fails because the:

Device is an unknown host. The name service could not resolve the specified host name into an IP address.

Device is unreachable. Your local system is unable to determine a route to the device.

Device is not responding. Your local system was able to determine a route to the device, but the ping did not receive any responses to the ICMP echo-request packets it sent to the device.

Step 2 Open a Telnet session to the device to check its SNMP configuration.

If the device is not responding to the SNMP Get request packets from your server, make sure it has an SNMP agent that is enabled and accessible using the community strings you specified.

Step 3 Use etherfind or another packet analyzer to investigate the SNMP packet exchange between your server and the SNMP agent on the device.

If the device does not support RFC 1213 (SNMP MIB II) attributes, it cannot be managed by RME.

Step 4 After you have corrected your device specification, your network connectivity, or both, resubmit the device.


Note If you try to re-import a device without modifying its device credentials using Common Services > Device and Credentials > Device Management, that device is not processed. Instead it is shown as a duplicate device in the Device Import Status window.
You should resubmit the Pre-deployed device using RME > Devices > Device Management > Pre-deployed Devices > Resubmit (button).



These tables describe the probable cause and the suggested action that needs to be taken when the devices are in Pre-deployed state:

Ping Utility Determines that the Device is an Unknown Host

Ping Utility Determines that the Device is Unreachable

Device does not Respond to an ICMP Echo Request Packet

Device does not Respond to an SNMP Get Request Packet

Device does not Support RFC 1213 (SNMP MIB II) Attributes

The following table describes how to resolve if the Ping utility determines that the device is an unknown host:

Table 3-6 Ping Utility Determines that the Device is an Unknown Host 

Probable Cause
Suggested Action

Device hostname and/or domain name entered incorrectly.

Verify hostname and domain name in device integration source are spelled correctly.

Make necessary corrections and resubmit the device using RME > Devices > Device Management > Pre-deployed Devices > Resubmit (button).

Name lookup registry does not contain entry for device.

If device hostname and domain name are correct and you know IP address, ping to device by IP address. If ping is successful, problem is in name registry.

1. Use NSLookup to confirm device name and server information.

2. Update name registry to include device by editing /etc/hosts file (on UNIX) or updating DNS or NIS servers.

3. Try ping again or add or import device using only IP address.

You can launch NSLookup using CiscoWorks Home page > Device Troubleshooting > Device Center.


The following table describes how to resolve if the Ping utility determines that devices as unreachable:

Table 3-7 Ping Utility Determines that the Device is Unreachable 

Probable Cause
Suggested Action

Device IP address entered incorrectly.

If you used IP address to specify device and ping failed in step 1, ping to device by its fully qualified hostname.

If ping is successful, the problem is that the device IP address was added incorrectly in the device integration source. Correct the IP address.


The following table describes how to resolve if the device does not respond to an ICMP Echo request packet:

Table 3-8 Device does not Respond to an ICMP Echo Request Packet 

Probable Cause
Suggested Action

An intermediate device is powered down.

Determine which device is down and get device back online. Use connectivity tools to find the source of the problem.

You can launch connectivity tools using CiscoWorks Home page > Device Troubleshooting > Device Center.

Device is powered down or administratively disabled.

Get device back online.

Interface at polling destination (identified by IP address in DNS, given entered host and domain names) is broken or administratively disabled.

Verify interface is enabled and functioning properly.

The device or the intermediate network is busy.

Resubmit the device at a time when the device or network is less busy.

You can resubmit using RME > Devices > Device Management > Pre-deployed Devices > Resubmit (button).

The interface at the polling destination is rebooting.

Resubmit the device later.

You can resubmit using RME > Devices > Device Management > Pre-deployed Devices > Resubmit (button).

The connection path from the network management station to the device is a slow link.

Resubmit the device when network traffic is lighter. A heavy network load can cause packets to be dropped.

You can resubmit using RME > Devices > Device Management > Pre-deployed Devices > Resubmit (button).

A section of the connection path from the network management station to the device is busy.

Resubmit the device when the segment is less busy. Use the connectivity tools to find the source of the problem.

You can resubmit using RME > Devices > Device Management > Pre-deployed Devices > Resubmit (button).

You can launch connectivity tools using CiscoWorks Home page > Device Troubleshooting > Device Center.

A section of the connection path from the network management station to the device is noisy and losing packets.

Check your ping statistics for excessive packet loss along the path. Resubmit the device when there is less traffic on the link.

Use the connectivity tools to find the source of the problem.

You can resubmit using RME > Devices > Device Management > Pre-deployed Devices > Resubmit (button).

You can launch connectivity tools using CiscoWorks Home page > Device Troubleshooting > Device Center.

Ping is not enabled for that device.

Verify that ping is enabled on the device.

Ping is blocked by an intermediate device.

Verify that ping is enabled on the routers on the path to the device. Use the connectivity tools to find the source of the problem.

You can launch connectivity tools using CiscoWorks Home page > Device Troubleshooting > Device Center.


The following table describes how to resolve if the device does not respond to an SNMP Get request packet:

Table 3-9 Device does not Respond to an SNMP Get Request Packet 

Probable Cause
Suggested Action

The device does not have an SNMP agent.

None; RME manages only devices with SNMP MIB II agents.

The SNMP agent is not enabled on the device.

Verify that the SNMP agent is enabled.

You entered the wrong SNMP community string.

Verify that you entered the SNMP Read and Write community strings correctly.

You can verify the credentials using

Resource Manager Essentials > Devices > Device Management > Device Credential Verification > Check Device Credential

Resource Manager Essentials > Devices > Device Management > Device Credential Verification > View Credential Verification Report

You can edit the credentials using Resource Manager Essentials > Devices > Device Management > Device Credential Verification > Edit Device Credentials.

Increase the SNMP timeout for that device

Increase the SNMP timeout for that device by exporting the device attributes using Resource Manager Essentials > Devices > Device Management > RME Devices > Edit Device Attributes (button).

An intermediate device is misconfigured and blocking the request.

Determine which device is blocking the request (routers are sometimes configured to block SNMP packets) and reconfigure the device.

Use the connectivity tools to find the source of the problem.

You can launch connectivity tools using CiscoWorks Home page > Device Troubleshooting > Device Center.

Access Control Lists (ACLs) on the managed device prevent SNMP packets from reaching the SNMP agent.

Check the ACLs on the managed device (and possibly intermediary devices) to make sure that SNMP traffic gets to and returns from the agent.

Use the connectivity tools to find the source of the problem. Reconfigure the ACLs on the problem devices to allow SNMP traffic.

You can launch connectivity tools using CiscoWorks Home page > Device Troubleshooting > Device Center.


The following table describes how to resolve if the device does not support RFC 1213 (SNMP MIB II) attributes:

Table 3-10 Device does not Support RFC 1213 (SNMP MIB II) Attributes 

Probable Cause
Suggested Action

The device has an old (RFC 1156) SNMP MIB I agent.

Upgrade the agent to RFC 1213 standards for SNMP MIB II.


Working With Alias Devices

When you add a new device to RME, this device may already exist in RME, but with another hostname or IP address. This device will be in the Alias state.

Detecting an Alias Device

The prerequisites for detecting an alias device are:

The alias device is detected when you perform the first inventory collection for a device.

A device is detected as an alias device only after a successful inventory collection. If a device is detected as an alias of another device, then that device is moved to an aliased state.

For all devices already in aliased state, the RME reruns the alias detection algorithm again. This detection is performed whenever the inventory is collected successfully.

This is done to ensure that the devices are still alias. If any of the devices are found to be not in an alias state, then RME moves these devices to Normal Device state.

For example, this can happen after you correct the IP address of the device.

If the inventory collection is partially successful or failed, an alias device may be listed as a Normal Device or as a Pre-deployed Device, based on whether the device was reachable or not.

Devices in an alias state continue in the workflows as in their previous states (Normal/Pre-deployed/Pending).

You can resolve the alias by selecting one of the devices using Resource Manager Essentials > Devices > Device Management > Alias Devices (see Resolving an Alias Device). After you resolve the alias, all the rejected devices are deleted from the RME database.

Alias Detection Algorithm

RME detects an alias device using this algorithm:

1. RME gets the device IP address, sysObjectID and the MAC address corresponding to the IP address of the new device.

2. RME refers to RME database for devices with same sysObjectID.

3. RME refers to RME database on devices returned in step 2 for IPaddresses and MAC addresses that match the addresses of the new device.

4. RME compares the port count for the devices that match the criteria described in Step 2 and 3.

5. RME identifies the new device as not an alias device if no device is returned in step 4. Otherwise it identifies the new device as an alias device if the device is returned in step 4.

Resolving an Alias Device

To resolve an Alias device:


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



Step 1 Select Resource Manager Essentials > Devices > Device Management > Alias Devices.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Alias Device State.

The Resolve Alias Devices dialog box appears. This dialog box contains two panes,

Normal Devices—Lists the Normal devices that have aliases to the devices.

Alias Devices—Lists the devices that are aliased to the Normal devices.

Step 2 Select a device from the Normal Devices pane to view the list of aliased devices.

Step 3 Click Show Alias Devices.

The devices that are aliased to the Normal devices appear in the Alias Devices pane. The devices that are in the Normal device state are also be listed along with the other alias devices.

Step 4 Select a device you want to resolve from the Alias Devices pane.

While resolving the alias state devices:

If you have chosen to delete the device in the Alias Device state, all Syslog messages collected are retained.

If you have chosen to delete the device in the Normal Device state, all Syslog messages collected are deleted.

We recommend that you delete the device in the Alias Device state and keep the device in the Normal Device state to retain all Syslog messages.

Step 5 Click Select.

The selected device is moved to either the Normal device state or the Pre-deployed device state, based on whether the device is reachable or not.

You can view the RME Device State using Resource Manager Essentials > Devices > Device Management.


Working With Conflicting Device Types

The Conflicting device state occurs if the sysObjectID in the device and that in the Device and Credential Repository do not match.

Detecting an Conflicting Device Type

The prerequisites for detecting an conflicting device are:

The conflicting device is detected when you perform the first inventory collection for a device.

A device is detected as an conflict device only after a successful inventory collection.

If the inventory collection is partially successful or failed, a conflict device may be listed as a Normal Device or as a Pre-deployed Device, based on whether the device was reachable or not.

Devices in Conflicting Device state cannot be included in the RME workflows. You must update the Device and Credential Repository with the correct device type so that these devices can be included in the RME workflows.

The devices go into Conflicting Device state because the device type that you entered in the Device and Credential Repository may be different from the device type that RME determines during inventory collection.

In such a case, RME Device Management provides a User Interface listing the devices with the incorrect device types. It also allows you to update the device type in the Device and Credential Repository or delete the device and re-submit the device for management.

Conflicting Device Type Algorithm

RME detects an conflict device using this algorithm:

1. RME gets sysObjectID from Device and Credential Repository.

If the sysObjectID is null, RME updates the sysObjectID collected by Inventory collection, else go to step 2.

2. RME compares the sysObjectID in the Device and Credential Repository with the sysObjectID collected by Inventory application for a given device.

If they match, the device is moved to either Normal/Pre-deployed/Pending state. Otherwise, RME moves the device state to Conflict and allows you to update the Device and Credential Repository and resubmit the device for management or delete the device.

The Conflicting Device Types window contains the following fields and buttons:

Table 3-11 Conflicting Devices Types Window 

Fields/Buttons
Description

Device Identity

(Field)

This lists all Conflicting devices in RME.

The devices are identified by the Display Name that you entered while adding devices to Device and Credential Repository.

SysObjectID in DCR

(Field)

Displays sysObjectID that you have selected while adding devices to Device and Credential Repository.

SysObjectID found by RME

(Field)

Displays sysObjectID that was found during RME Inventory Collection.

Update Credential Repository

(Button)

Update the Device Credential Repository with the sysObjectID found by the RME.

See Resolving the Conflicting Device Type.

This button gets activated only after selecting devices from Device Identity pane.

Delete

(Button)

Delete the Conflicting type devices.

See Deleting the Conflicting Device Type.

This button gets activated only after selecting devices from Device Identity pane.


Resolving the Conflicting Device Type

To resolve a Conflicting Device Type:


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



Step 1 Select Resource Manager Essentials > Devices > Device Management > Conflicting Device Types.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Conflicting device state.

The Conflicting Device Types dialog box appears.

Step 2 Select a device.

Step 3 Click Update Credential Repository.

The conflicting device is moved to Normal device state.

You can view the RME Device State using Resource Manager Essentials > Devices > Device Management.


Deleting the Conflicting Device Type

To delete the Conflicting Device Type:


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



Step 1 Select Resource Manager Essentials > Devices > Device Management > Conflicting Device Types.

Or

Select Resource Manager Essentials > Devices > Device Management and click on the Number of Device column entry for the Conflicting device state.

The Conflicting Device Types dialog box appears.

Step 2 Select a device.

Step 3 Click Delete.

A confirmation box appears.

Step 4 Click OK.

You can add the deleted devices to RME using Resource Manager Essentials > Devices > Device Management > Add Devices.


Using Device Credential Verification Window

Using Device Credential Verification window you can check and verify the device credentials and edit the RME device credentials.

This window contains the following pane and buttons:

Table 3-12 Device Credential Verification Window 

Pane/Buttons
Description

RME Device Selector

(Pane)

This lists all devices in RME.

The devices are identified by the Display Name that you have entered while adding devices to Device and Credential Repository.

See Using RME Device Selector for more information.

Check Device Credential

(Button)

Select the device credentials that need to be checked.

See Checking and Viewing Device Credentials.

View Credential Verification Report

(Button)

View the device credentials verification result.

This is a static device credential verification report. You can save and print this report.

See Checking and Viewing Device Credentials.

Edit Device Credentials

(Button)

Edit the device credentials window.

See Editing Device Credentials.

Status

(Button)

View the device credentials verification result.

This is a dynamic device credential verification report. You can use the Refresh icon to update this report. You cannot save and print this report.

See Checking and Viewing Device Credentials.

Error Report

(Button)

View the device credential verification report.

This is a static device credential verification report. This report lists only those devices where the credentials verification status shows either Failed or Incorrect.

See Checking and Viewing Device Credentials.


Checking and Viewing Device Credentials

You can check your device credentials for RME devices and view the results in a report. Use this option to make sure that your Device and Credential Repository credentials match your actual device credentials.

You can check the following device credentials:

SNMP Read Community String—SNMP version 2 read community string.

SNMP Write Community String—SNMP version 2 write community string.

SNMP Version 3—SNMP version 3 username and password.

Telnet—Telnet username and password.

Telnet Enable Mode User Name and Password—Telnet username and password in Enable mode.

SSH—SSH username and password.

SSH Enable Mode User Name and Password—SSH username and password in Enable mode.

You can also verify the RME device credentials in two other ways:

Using the command line tool, cwcli inventory cda.

See Overview: cwcli inventory Command for further details.

Using the Device Center (From CiscoWorks homepage, Device Troubleshooting > Device Center to launch Device Center).

See RME Device Center for further details.

Check Device Credentials Algorithm

Device Credential Verification verifies credentials that are device packages specific to a device type. These device packages may have variations in CLI access and respond to different transport protocols.

Device credential verification uses the credentials stored in Device and Credential Repository and validates these credentials against the corresponding device.

The following is the algorithm used to verify credentials for the device transport protocol:

Read Community String

Read community string is verified by performing read operation via the SNMP transport library and checking the result.

Read/Write Community String

a. Read write community string is verified by performing snmpget operation on syslocation variable.

b. snmpset is performed with the value returned in the previous step.

If the error message returned is,

snmpRspBadValue then the Read/Write community string is considered correct.

snmpRspNoSuchName then the Read/Write community string is considered wrong.

Telnet Username and Password

Telnet username and password are verified by trying to login to the device via the Telnet transport library and verify if the attempt is successful.

SSH Username and Password

SSH username and password are verified by trying to login to the device via the SSH transport library and verify if the attempt is successful.

Telnet enable mode password

Enable mode password is verified by trying to telnet and enter the enable mode and verify if the attempt is successful.

SSH enable mode password

Enable mode password is verified by trying to SSH and enter the enable mode and verify if the attempt is successful.

Once the device credentials are validated the result will be displayed and you can refresh to see the latest status.


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


When you click View Credential Verification Report in the Device Credential Verification dialog box,

If you have already selected the credentials that have to be verified then the Credential Verification Report appears.

If you have not selected the credentials to verify then a message appears, None of the devices have credential verification data. Click Check Device Credential to select the credentials that have to be verified and then click Credential Verification. To perform this task, follow the procedure described below:


Step 1 Select Resource Manager Essentials > Devices > Device Management > Device Credential Verification.

The Device Credential Verification dialog box appears.

Step 2 Select the devices. See Using RME Device Selector for more information.

Step 3 Click Check Device Credential.

The Device Credentials Options dialog box appears.

Step 4 Select the device credentials that you want to check. You can select All to check all the device credentials.

Step 5 Click OK.

A notification window displays, Please Click on View Credential Verification Report Button to View the Report.

Step 6 Click OK.

The Device Credential Verification dialog box appears.

Step 7 Click either

View Credential Verification Report to view the static device credential verification report. You can save and print this report.

The Credential Verification Report appears. See Credentials Mapping and Understanding Credential Verification Report tables.

or

Status to view the dynamic device credential verification report. You can use the Refresh icon to update this report. You cannot save and print this report.

The Device Credentials Status Description report appears. See Credentials Mapping and Understanding Credential Verification Report tables.

or

Error Report to view the static device credential verification report. This report lists only those devices where the credentials verification status shows either Failed or Incorrect.

The Credential Verification Report appears. See Credentials Mapping and Understanding Credential Verification Report tables.


Note The device credentials verification result displays No Value To Test for the AUS-managed devices (PIX devices). This is because RME communicates with the AUS using username and password through http protocol.
The SNMP and Telnet/SSH credentials are not required. Any communication to an AUS managed device (PIX devices) does not happen directly, but only through AUS.



The Table 3-13 maps the device credentials that you have entered in the Device and Credentials (Common Services > Device and Credentials > Device Management) database and the credentials that appear in the Credential Verification Report:

Table 3-13 Credentials Mapping 

Credentials in Device and Credential Repository
Credentials displayed in Credential Verification Report

Device Name

Device Name

Click on the device name to launch the Device Center.

SNMP V2C RO Community String

Read Community

SNMP V2C RW Community String

Write Community

SNMP V3 Username and Password

SNMPv3

Primary Credentials Username

Telnet

Primary Credentials Username and Primary Enable Password

Enable by Telnet

Primary Credentials Username

SSH

Primary Credentials Username and Primary Enable Password

Enable by SSH


The Table 3-14 describes the Credential Verification Report Status messages:

Table 3-14 Understanding Credential Verification Report 

Status Message
Description

OK

Check for device credentials completed. The device credentials data in the Device and Credential Repository matches the physical device credentials.

No authentication configured

Device was not configured with authentication mechanism (Telnet/LocalUsername/TACACS).

RME was able to telnet and log into the device successfully with out using the values entered in the Device and Credential Repository.

Incorrect

Check for device credentials completed.

The device credentials data in the Device and Credential Repository does not match with the physical device credentials for one of the following reasons:

The device credentials data in Device and Credential Repository is not correct.

The device is unreachable or offline.

One of the interfaces on the device is down.

No Data Yet

Check for device credentials is in progress.

Did Not Try

Check for device credentials is not performed for one of the following reasons:

A Telnet password does not exist, so could not login to the device.

Device telnet login mode failed, so enable mode login is not attempted.

No Value To Test

Check for device credentials is not performed because you have not entered the device credentials data.

Not Supported

Check for Telnet passwords is not performed because Telnet credential checking is not supported on this device.

Failed

Check failed because a Telnet session could not be established due to a not responding device.

Click on the Failed link to view the error message.

Not Selected For Verification

Protocol was not selected for verification.


The following buttons are available on the Credential Verification Report and Check Device Attribute Status Description report:

Button
Description

You can export this report in either PDF or CSV format.

This is available on Credential Verification Report. That is, when you click View Credential Verification Report and Error Report in the Device Credential Verification window.

Generates a format that can be printed.

This is available on Credential Verification Report. That is, when you click View Credential Verification Report and Error Report in the Device Credential Verification window.

Click on this icon to refresh the device credentials verification status.

This is available on Check Device Attribute Status Description report. That is, when you click Status in the Device Credential Verification window.


Editing Device Credentials

You can change the device credentials that you have entered at the time of adding or importing the devices in the Device and Credential Repository.

You can launch the Edit Device Credentials window from Common Services and from Resource Manager Essentials:

Common Services > Device and Credentials > Device Management and click on Edit button.

Resource Manager Essentials > Devices > Device Management > Device Credential Verification and click on Edit Device Credentials button.

This in turn launches the Common Services Device and Credentials window.


Caution You should not drop System group from the view (read-view and write-view). System group must be available for read and write operation. In MIB-II, System group is available as default.


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


To launch the Device Credentials edit window from RME:


Step 1 Select Resource Manager Essentials > Devices > Device Management > Device Credential Verification.

The Device Credential Verification dialog box appears.

Select the devices. See Using RME Device Selector for more information.

Step 2 Click Edit Device Credentials.

The Common Services Device Management dialog box appears.

The devices that you have selected in the RME Device Credential Verification dialog box can be viewed by selecting the Selection tab.

Step 3 Click Edit.

The Common Services Device Properties dialog box appears.

Application 'RME' is performing 'Edit Device' operation on following 
devices.
Click OK if you want to continue. Otherwise click Cancel.

Step 4 Click OK.

See Common Services Online help or User Guide for further information on editing device credentials.


Device List Manipulation Service

The Device List Manipulation Service (DLMS) allows other network management systems to manipulate Device and Credential Repository devices. You can perform the following, using DLMS:

Add devices (See Adding Devices to Device Credentials Using DLMS)

List the RME devices and their status (See Listing the Devices and Their Status Using DLMS)

Get the device credentials data (See Getting the Device Credentials Data)

Set the device credentials data (See Setting the Device Credentials Using DLMS)

Get the device IP address (See Getting the Device IP Address.)

You perform these operations by sending HTTP requests to a special URL. The URL identifies a servlet that accepts the request and authenticates the requesting user's identity and credentials before authorizing the information exchange. The servlet then parses the request, which is encoded in XML, performs the operations, and returns the results in either XML or CSV format (CSV version 3.0).

You must ensure that your HTTP client can create, write, and read sockets.

The secured connection through HTTPS is not supported for DLMS.

Create the code to call the following Device List Manipulation Service URL, and pass in the content of the XML file using the HTTP POST method (you can use either Java or PERL):

http://CiscoWorks-host:port/rme/com.cisco.nm.rmeng.inventory.servlet.D
eviceListService

Where,

CiscoWorks_servername is the CiscoWorks server hostname.

The default CiscoWorks port is 1741

XML DTD for DLMS

The required XML DTD for the DLMS tool is:

<!ELEMENT request 
(authentication,source,addDevices?,listDevices?,getDeviceCredentials?,
setCredentials?,getDeviceIPAddresses?)>
<!ELEMENT authentication EMPTY>
<!ELEMENT source (host,product,version,description)>
<!ELEMENT host (#PCDATA)>
<!ELEMENT product (#PCDATA)>
<!ELEMENT version (#PCDATA)>
<!ELEMENT description (#PCDATA)>
<!ELEMENT addDevices (deviceInfo)>
<!ELEMENT listDevices (deviceInfo?)>
<!ELEMENT getDeviceCredentials (deviceInfo?)>
<!ELEMENT setCredentials (deviceInfo)>
<!ELEMENT getDeviceIPAddresses (deviceInfo?)>
<!ELEMENT deviceInfo (#PCDATA)>
<!ATTLIST request responseFormat  (csv | xml) #IMPLIED>
<!ATTLIST authentication name CDATA #REQUIRED pwd CDATA #REQUIRED>
<!ATTLIST listDevices deviceType (all | managed)  #IMPLIED>
<!ATTLIST getDeviceCredentials wantdbid (yes) #IMPLIED wantsysoid 
(yes) #IMPLIED>

Guidelines for Creating the XML File

The following are the guidelines while creating the DLMS request XML file:

One request can contain up to five operations.

You can specify the output as CSV or XML.

The attribute pwd of the tag authentication must be 64-based encoded.

If you include <deviceInfo> in any operation, you will receive information only on the devices specified in <deviceInfo>. If you do not specify <deviceInfo>, you will receive information on all managed devices. Create <deviceInfo> using CSV format data.

<deviceInfo> is the Device Display Name as entered in Device and Credential Repository.

When using <listDevices>, you can list all devices or only the managed devices by specifying either the all or managed attribute.

You can list all devices by specifying the attr as yes and devType as all. If you do not specify this, then only RME managed devices will be displayed.

When using <getDeviceCredentials>,

You can display the device ID by specifying the wantdbid attribute as yes.

You can display the sysobject ID by specifying the wantsysoid attribute as yes.

Adding Devices to Device Credentials Using DLMS

Using the DLMS function you can add devices to Device and Credentials Repository. After adding devices to Device and Credentials Repository you can add these devices to RME manually or automatically (see Adding Devices to RME).

The new device information should be added using the <deviceInfo> tag.

The CSV version used for adding devices to Device and Credentials is 2.0. You must enter device name (including domain name or simply an IP address) and the SNMP read community string.


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


The sample XML File for Adding Devices to Device and Credentials Repository (dlmsAddDevices.xml):

<source>
<host>CiscoWorks-Server</host>
<product>CiscoWorks:RME</product>
<version>2.0</version>
<description>Using DLMS for adding devices into Device and Credential 
Repository</description>
</source>
<addDevices>
<deviceInfo>
<![CDATA[
;
; This file is generated by the export utility
; If you edit this file, be sure you know what you are doing
;
Cisco Systems NM data import, source = export utility; Version = 2.0; 
Type = Csv
;
; Here are the columns of the table.
;   Columns 1 and 2 are required.
;   Columns 3 through 20 are optional.
; Col# = 1: Name (including domain or simply an IP)
; Col# = 2: RO community string
; Col# = 3: RW community string
; Col# = 4: Serial Number
; Col# = 5: User Field 1
; Col# = 6: User Field 2
; Col# = 7: User Field 3
; Col# = 8: User Field 4
; Col# = 9; Name = Telnet password
; Col# = 10; Name = Enable password
; Col# = 11; Name = Enable secret
; Col# = 12; Name = Tacacs user
; Col# = 13; Name = Tacacs password
; Col# = 14; Name = Tacacs enable user
; Col# = 15; Name = Tacacs enable password
; Col# = 16; Name = Local user
; Col# = 17; Name = Local password
; Col# = 18; Name = Rcp user
; Col# = 19; Name = Rcp password
; Col# = 20; Name = Group
;
; Here are the rows of data.
;

192.168.10.60,public,private,,testdevice,UNKNOWN,0,UNKNOWN,,,,,,,,,,,,
,
]]>
</deviceInfo>
</addDevices>

The example below is a PERL code that calls the DLMS URL and passes in the content of an XML file:

perl d:\dlms\dlms.pl CiscoWorks-Server dlmsAddDevices.xml

The DLMS output for adding device is:

Authorization succeeded

If you have enabled the Automatically Manage Devices from Credential Repository option on the Device Management Settings window then the newly added device is automatically added into RME.

If this option is not enabled, then you have to add device manually to RME from Device and Credential Repository.

See Adding Devices to RME for further details on adding devices into RME from Device and Credentials Repository.

You can also use the DLMS listDevices function to view the newly added device. See Listing the Devices and Their Status Using DLMS for further details.

Listing the Devices and Their Status Using DLMS

Using the DLMS function you can list and view the device status for either:

All devices in Device and Credential Repository

or

All the RME managed devices.

The device status that are displayed using this tool are managed and unmanaged.

The devices are considered as managed when they are in RME with one of these device states Normal, Alias, and Pre-deployed.

The devices are considered as unmanaged when they are in RME with either Conflict or Suspended device states. Also, the devices are considered unmanaged when they are not in RME but in Device and Credentials Repository.


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


The Sample XML File for Listing the Managed Devices (dlmsListDevices.xml)

<?xml version="1.0"?>
<!DOCTYPE request SYSTEM "D:\\dlms\\dtdexternal.dtd">
<request responseFormat="xml">
<!-- the value for responseFormat could be xml or csv -->
<authentication name="admin" pwd='YWRtaW4='/>
<!-- pwd is 64-based encoded -->
<source>
<host>CiscoWorks-Server</host>
<product>CiscoWorks:RME</product>
<version>2.0</version> 
<description>Using DLMS for listing devices</description> 
</source>
<listDevices attr="yes" deviceType="managed">
</listDevices>

The example below is a perl code that calls the DLMS URL and passes in the content of an XML file:

perl d:\dlms\dlms.pl CiscoWorks-Server dlmsListDevices.xml

The DLMS output for listing managed devices is:

Cisco Systems NM data import, source = List Devices; Version = 2.0; 
Type = Csv
;
; Here are the columns of the table.
; Col# = 1: Name (including domain or simply an IP)
; Col# = 2: device status
;
; Here are the rows of data.
;
192.168.27.16 -CE 507:managed,
192.168.3.2:managed,
rme-blr-3640.cisco.com:managed,
192.168.3.9-UBR925:managed,
192.168.28.14-CE:managed,

To list all the devices in the Device and Credential Repository, change the following line in the given sample XML file:

From

<listDevices attr="yes" deviceType="managed">

To

<listDevices attr="yes" deviceType="all">

Getting the Device Credentials Data

Using the DLMS function, you can view the device credentials data for all devices in Device and Credential Repository. The output for getDeviceCredentials is in CSV 3.0 format.

You get the following additional information while using <getDeviceCredentials>

You can get the device ID by specifying the wantdbid attribute as yes.

You can get the sysobject ID by specifying the wantsysoid attribute as yes.


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


The sample XML File for Geting Device and Credentials for all Devices in Device and Credential Repository (dlmsGetDeviceCredentials.xml):

<?xml version="1.0"?>
<!DOCTYPE request SYSTEM "D:\\dlms\\dtdexternal.dtd">
<request responseFormat="xml">
<!-- the value for responseFormat could be xml or csv -->
<authentication name="admin" pwd='YWRtaW4='/>
<!-- pwd is 64-based encoded -->
<source>
<host>CiscoWorks-Server</host>
<product>CiscoWorks:RME</product>
<version>2.0</version>
<description>Using DLMS for getting Device Credentials</description>
</source>
<getDeviceCredentials>
</getDeviceCredentials>

The example below is a perl code that calls the DLMS URL and passes in the content of an XML file:

perl d:\dlms\dlms.pl CiscoWorks-Server 
dlmsdlmsGetDeviceCredentials.xml

The DLMS output for getting device credentials is:

Cisco Systems NM data import, source = Get Devices Credentials; 
Version = 2.0; 
Type = Csv;
; Here are the columns of the table.
; Col# = 1: Management IP Address
; Col# = 2: Host Name
; Col# = 3: Domain Name
; Col# = 4: Device Identity
; Col# = 5: Display Name
; Col# = 6: SysObjectID
; Col# = 7: DCR Device Type
; Col# = 8: MDF Type
; Col# = 9: SNMP v2 Read Community String
; Col# = 10: SNMP v2 Write Community String
; Col# = 11: SNMP v3 User ID
; Col# = 12: SNMP v3 Password
; Col# = 13: SNMP v3 Engine ID
; Col# = 14: SNMP v3 Auth Algorithm
; Col# = 15: Primary Username
; Col# = 16: Primary Password
; Col# = 17: Primary Enable Password
; Col# = 18: user_defined_field_0
; Col# = 19: user_defined_field_1
; Col# = 20: user_defined_field_2
; Col# = 21: user_defined_field_3
;
; Here are the rows of data.
;
192.168.27.16, , , 
,12.19.27.16-CE507,1.3.6.1.4.1.9.1.409,0,268437658,public,private, , , 
, ,admin,default,  , , , ,
192.168.8.9,10.6.8.9, , 
,192.168.8.9-UBR925,1.3.6.1.4.1.9.1.316,0,273900271,public,private, , 
, , , , ,  , , , ,

Setting the Device Credentials Using DLMS

Using the DLMS function you can edit the device credentials for devices specified in <deviceInfo> tag.

You can edit the following device credentials:

snmp_v2_ro_comm_string—SNMP version 2 Read community string

snmp_v2_rw_comm_string—SNMP version 2 Read-Write community string

snmp_v3_user_id—SNMP version 3 Username

snmp_v3_password—SNMP version 3 Password

snmp_v3_engine_id—SNMP version 3 Engine ID

snmp_v3_auth_algorithm—SNMP version 3 Authentication Algorithm

primary_username—Primary Username

primary_password—Primary Password

primary_enable_password—Primary Enable Password

user_defined_field_0—User-defined field

user_defined_field_1—User-defined field

user_defined_field_2—User-defined field

user_defined_field_3—User-defined field

The following table describes the mapping of CSV 2.0 to CSV 3.0

Table 3-15 Mapping CSV 2.0 and CSV 3,0 Format 

CSV 2.0
CSV 3.0

Name (including domain or simply an IP)

host_name and display_name

RO community string

snmp_v2_ro_comm_string

RW community string

snmp_v2_rw_comm_string

Serial Number

Not used in CSV 3.0

User Field 1

user_defined_field_0

User Field 2

user_defined_field_1

User Field 3

user_defined_field_2

User Field 4

user_defined_field_3

Telnet password

primary_password

Enable password

primary_enable_password

Enable secret

primary_enable_password

Tacacs user

primary_username

Tacacs password

primary_password

Tacacs enable user

Not used in CSV 3.0

Tacacs enable password

primary_enable_password

Local user

primary_username

Local password

primary_password

Rcp user

Not used in CSV 3.0

Rcp password

Not used in CSV 3.0


The order of preference used to set these values in CSV 3.0 are:

If Tacacs username, password, enable password is set, these values will be set as primary_username, primary_password and primary_enable_password.

If Local username and password is set, then the values will be set as primary_username and primary_password.

If Telnet password, Enable Password, and Enable Secret are set, then the values will be set as primary_password, and primary_enable_password (for both Enable Password, and Enable Secret).


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


The sample XML File for Editing Device and Credentials for all Devices in Device and Credential Repository (dlmsSetDeviceCredentials.xml):

<?xml version="1.0"?>
<!DOCTYPE request SYSTEM "D:\dlms\dtdexternal.dtd">
<request responseFormat="xml">
<!-- the value for responseFormat could be xml or csv --> 
<authentication name="admin" pwd='YWRtaW4='/> 
<!-- pwd is 64-based encoded --> 
<source>
<host>ramyab-w2k07</host>
<product>CiscoWorks:RME</product>
<version>2.0</version>
<description>using DLMS for device manipulation in RME</description>
</source>
<setCredentials>
<deviceInfo>
<![CDATA[ 
;
; This file is generated by the export utility
; If you edit this file, be sure you know what you are doing
;
Cisco Systems NM data import, source = export utility; Version = 2.0; 
Type = Csv
;
; Here are the columns of the table.
; Columns 1 and 2 are required.
; Columns 3 through 13 are optional.
; Col# = 1:  Name (including domain or simply an IP)
; Col# = 2:  snmp_v2_ro_comm_string
; Col# = 3:  snmp_v2_rw_comm_string
; Col# = 4:  snmp_v3_user_id
; Col# = 5:  snmp_v3_password
; Col# = 6:  snmp_v3_auth_algorith
; Col# = 7:  primary_username
; Col# = 8:  primary_password
; Col# = 9:  primary_enable_password
; Col# = 10: user_defined_field_0
; Col# = 11: user_defined_field_1
; Col# = 12: user_defined_field_2
; Col# = 13: user_defined_field_3
;
; Here are the rows of data.
;
rtr1750,dlmstest,invtest,snmpv3user,snmpv3pass,11111111111111,MD5,puse
r,ppass,enable,uf1,uf2,uf3,uf4
]]>
</deviceInfo>
</setCredentials>

The example below is a perl code that calls the DLMS URL and passes in the content of an XML file:

perl d:\dlms\dlms.pl CiscoWorks-Server 
dlmsdlmsSetDeviceCredentials.xml

The DLMS output for editing the device credentials is:

Authorization succeeded

You can verify the result using one of the following methods:

Using Common Services > Device and Credentials > Device Management > Export (button)

Using Resource Manager Essentials > Devices > Device Management > RME Devices > Export (button)

Using the DLMS getDeviceCredentials function. See Getting the Device Credentials Data for further details.

Getting the Device IP Address

Using the DLMS function you can get the device IP address of the specified devices.


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


The sample XML File for Editing Device and Credentials for all Devices in Device and Credential Repository (dlmsGetDeviceIPaddress.xml):

<?xml version="1.0"?>
<!DOCTYPE request SYSTEM "D:\\dlms\\dtdexternal.dtd">
<request responseFormat="xml">
<!-- the value for responseFormat could be xml or csv -->
<authentication name="admin" pwd='YWRtaW4='/>
<!-- pwd is 64-based encoded -->
<source>
<host>CiscoWorks-Server</host>
<product>CiscoWorks:RME</product>
<version>2.0</version>
<description>Using DLMS for getting the device IP 
Address</description>
</source>
<getDeviceIPAddresses>
<!-- <![CDATA[ ... ]]> is needed for the text holding special 
charactors, such as &, <, >, 


', ", -->   
</getDeviceIPAddresses>

The example below is a perl code that calls the DLMS URL and passes in the content of an XML file:

perl d:\dlms\dlms.pl CiscoWorks-Server 
dlmsdlmsSetDeviceCredentials.xml

The DLMS output for getting the device IP address is:

Cisco Systems NM data import, source = Get Devices IP Addr; Version = 
2.0; Type
= Csv
;
; Here are the columns of the table.
; Col# = 1: Name (including domain or simply an IP)
; Col# = 2 or above: IP addresses
;
; Here are the rows of data.
;
CE-507:192.168.27.16,
192.168.38.9-UBR925:192.168.38.9,
rme-3640.cisco.com:192.168.28.19

Sample DLMS XML Request File

This is an example of XML code requesting all five Device List Manipulation Service operations (show.xml).

This example also includes the XML DTD used for DLMS.

<?xml version = '1.0' ?> 
<!DOCTYPE request [ 
<!ELEMENT request 
(authentication,source,addDevices?,listDevices?,getDeviceCredentials?,
setCredentials?,renameDevices?,deleteDevices?,getDeviceIPAddresses?)> 
<!ELEMENT authentication EMPTY> 
<!ELEMENT source (host,product,version,description)> 
<!ELEMENT host (#PCDATA)> 
<!ELEMENT product (#PCDATA)> 
<!ELEMENT version (#PCDATA)> 
<!ELEMENT description (#PCDATA)> 
<!ELEMENT addDevices (deviceInfo)> 
<!ELEMENT listDevices (deviceInfo?)> 
<!ELEMENT getDeviceCredentials (deviceInfo?)> 
<!ELEMENT setCredentials (deviceInfo)> 
<!ELEMENT renameDevices (deviceInfo)> 
<!ELEMENT deleteDevices (deviceInfo)> 
<!ELEMENT getDeviceIPAddresses (deviceInfo?)> 
<!ELEMENT deviceInfo (#PCDATA)> 
<!ATTLIST request 
responseFormat CDATA #IMPLIED> 
<!ATTLIST authentication 
name CDATA #REQUIRED 
pwd CDATA #REQUIRED> 
<!ATTLIST listDevices 
deviceType CDATA #IMPLIED> 
<!ATTLIST getDeviceCredentials 
wantdbid CDATA #IMPLIED 
wantsysoid CDATA #IMPLIED> 
<!ATTLIST deleteDevices suspend CDATA #IMPLIED> 
]> 
<request responseFormat="xml"> 
<!-- the value for responseFormat could be xml or csv --> 
<authentication name="admin" pwd='YWRtaW4='/> 
<!-- pwd is 64-based encoded --> 
<source> 
<host>CiscoWorks-Server</host> 
<product>CiscoWorks:RME</product> 
<version>2.0</version> 
<description>text by caller</description> 
</source> 
<addDevices> 
<!-- <![CDATA[ ... ]]> is needed for the text holding special 
charactors, such as &, <, >, ', ", --> 
<deviceInfo><![CDATA[ 
; This file is generated by the export utility 
; If you edit this file, be sure you know what you are doing 
; 
Cisco Systems NM data import, source = export utility; Version = 2.0; 
Type = Csv 
; 
; Here are the columns of the table. 
; Columns 1 and 2 are required. 
; Columns 3 through 19 are optional. 
; Col# = 1: Name (including domain or simply an IP) 
; Col# = 2: RO community string 
; Col# = 3: RW community string 
; Col# = 4: Serial Number 
; Col# = 5: User Field 1 
; Col# = 6: User Field 2 
; Col# = 7: User Field 3 
; Col# = 8: User Field 4 
; Col# = 9; Name = Telnet password 
; Col# = 10; Name = Enable password 
; Col# = 11; Name = Enable secret 
; Col# = 12; Name = Tacacs user 
; Col# = 13; Name = Tacacs password 
; Col# = 14; Name = Tacacs enable user 
; Col# = 15; Name = Tacacs enable password 
; Col# = 16; Name = Local user 
; Col# = 17; Name = Local password 
; Col# = 18; Name = Rcp user 
; Col# = 19; Name = Rcp password 
; 
; Here are the rows of data. 
; 
enm-2501.cisco.com,public,private 
enm-4888.cisco.com,public,priv,Big 
Boys1,field2,,,,,,,,,,,,,rcp2,rcppwd2 
enm-8333.cisco.com,public,private 
enm-4001.cisco.com,public,private,Big Boys1,,,,,,,,,,,,,,rcp2,rcppwd2 
enm-7010.cisco.com,public,private,Big Boys1,,,,,,,,tacuser3,tacpwd3 
192.168.5.6,"public,I am 
,",public,sn2512,my_anno1,my_anno2,my_anno3,my_anno4,,,,tacuser1,tacpw
d1,tacuser2,tacpwd2,,,rcp1,rcppwd1 
]]></deviceInfo> 
</addDevices> 
<listDevices> 
<deviceInfo><![CDATA[ 
; This file is generated by the export utility 
; If you edit this file, be sure you know what you are doing 
; 
Cisco Systems NM data import, source = export utility; Version = 2.0; 
Type = Csv 
; 
; Here are the columns of the table. 
; Columns 1 and 2 are required. 
; Columns 3 through 19 are optional. 
; Col# = 1: Name (including domain or simply an IP) 
; Col# = 2: RO community string 
; Col# = 3: RW community string 
; Col# = 4: Serial Number 
; Col# = 5: User Field 1 
; Col# = 6: User Field 2 
; Col# = 7: User Field 3 
; Col# = 8: User Field 4 
; Col# = 9; Name = Telnet password 
; Col# = 10; Name = Enable password 
; Col# = 11; Name = Enable secret 
; Col# = 12; Name = Tacacs user 
; Col# = 13; Name = Tacacs password 
; Col# = 14; Name = Tacacs enable user 
; Col# = 15; Name = Tacacs enable password 
; Col# = 16; Name = Local user 
; Col# = 17; Name = Local password 
; Col# = 18; Name = Rcp user 
; Col# = 19; Name = Rcp password 
; 
; Here are the rows of data. 
; 
;enm-4000.cisco.com 
;enm-7010.cisco.com 
;192.168.5.9 
mytest.cisco.com 
good 
;bad 
]]></deviceInfo> 
</listDevices> 
<getDeviceCredentials wantsysoid="yes" wantdbid="yes"> 
<deviceInfo> 
; This file is generated by the export utility 
; If you edit this file, be sure you know what you are doing 
; 
Cisco Systems NM data import, source = export utility; Version = 2.0; 
Type = Csv 
; 
; Here are the columns of the table. 
; Columns 1 and 2 are required. 
; Columns 3 through 19 are optional. 
;; Col# = 1: Management IP Address \n" 
; Col# = 2: Host Name \n" 
; Col# = 3: Domain Name \n" 
; Col# = 4: Device Identity \n" 
; Col# = 5: Display Name \n" 
; Col# = 6: SysObjectID \n" 
; Col# = 7: DCR Device Type \n" 
; Col# = 8: MDF Type \n" 
; Col# = 9: SNMP v2 Read Community String \n" 
; Col# = 10: SNMP v2 Write Community String \n" 
; Col# = 11: SNMP v3 User ID \n" 
; Col# = 12: SNMP v3 Password \n" 
; Col# = 13: SNMP v3 Engine ID \n" 
; Col# = 14: SNMP v3 Auth Algorithm \n" 
; Col# = 15: Primary Username \n" 
; Col# = 16: Primary Password \n" 
; Col# = 17: Primary Enable Password \n" 
; Col# = 18: user_defined_field_0 \n" 
; Col# = 19: user_defined_field_1 \n" 
; Col# = 20: user_defined_field_2 \n" 
; Col# = 21: user_defined_field_3 \n" 
; 
; Here are the rows of data. 
; 
enm-2501.cisco.com 
enm-2502.cisco.com 
enm-2503 
enm-7010.cisco.com 
12.18.5.9 
</deviceInfo> 
</getDeviceCredentials> 
<setCredentials> 
<!-- <![CDATA[ ... ]]> is needed for the text holding special 
charactors, such as --> 
<deviceInfo><![CDATA[ 
; This file is generated by the export utility 
; If you edit this file, be sure you know what you are doing 
; 
Cisco Systems NM data import, source = export utility; Version = 2.0; 
Type = Csv 
; 
; Here are the columns of the table. 
; Columns 1 and 2 are required. 
; Columns 3 through 19 are optional. 
; Col# = 1: Name (including domain or simply an IP) 
; Col# = 2: snmp_v2_ro_comm_string 
; Col# = 3: snmp_v2_rw_comm_string 
; Col# = 4: snmp_v3_user_id 
; Col# = 5: snmp_v3_password 
; Col# = 6: snmp_v3_auth_algorith 
; Col# = 7: primary_username 
; Col# = 8: primary_password 
; Col# = 9: primary_enable_password 
; Col# = 10: user_defined_field_0 
; Col# = 11: user_defined_field_1 
; Col# = 12: user_defined_field_2 
; Col# = 13: user_defined_field_3 
; 
; Here are the rows of data. 
; 
enm-2501.cisco.com,public,private,serial,field1,fidel2,fild3 
enm-4888.cisco.com,public,priv,little 
Boys1,field2,,,,,,,,,,,,,rcp9,rcppwd9 
enm-4001.cisco.com,public,private,Big Boys1,,,,,,,,,,,,,,rcp2,rcppwd2 
enm-7010.cisco.com,public,private,Big Boys1,,,,,,,,tacuser3,tacpwd3 
;192.168.5.9,"public,I am 
,",public,sn2512,my_anno1,my_anno2,my_anno3,my_anno4,,,,tacuser1,tacpw
d1,tacuser2,tacpwd2,,,rcp1,rcppwd1 
mytest.cisco.com,public,private 
]]></deviceInfo> 
</setCredentials> 
<getDeviceIPAddresses> 
<deviceInfo> 
</deviceInfo> 
</getDeviceIPAddresses> 
</request> 

Sample Java and PERL Scripts to Invoke the Servlet

The section captures Java and PERL code examples that call the DLMS URL and passes in the content of an XML file.

Java Example

This is an example of Java code that calls the Device List Manipulation Service URL and passes in the content of an XML file.

import java.util.*;
import java.io.*;
import java.net.*;
import javax.servlet.*;
import javax.servlet.http.*;
public class UseDevListSvc extends HttpServlet {
public synchronized void doGet(HttpServletRequest req, HttpServletResponse res)
throws ServletException, IOException {

res.setContentType("text/plain");
PrintWriter pw = res.getWriter();
int port = req.getServerPort();
String host = req.getServerName();;
// Make sure you put show.xml in the right directory. the default
// is CSCOpx/example .
String filename = "/opt/CSCOpx/example/show.xml";
String paramList = fileToString(filename, pw);
String URL = "/rme/com.cisco.nm.rmeng.inventory.servlet.DeviceListService";
try {
DataInputStream ds = execPOST(host, port, URL, paramList, pw);
	if (ds == null) {
		throw new Exception("Could not contact URL " + URL+ " with "+paramList); }
	BufferedReader br = new BufferedReader(new InputStreamReader(ds));
	String line = null; 
	while ((line = br.readLine()) != null ){
		if (line.indexOf("-1:") > 0 ) { //this indicates an error.
			throw new Exception("Received result " + line );
		}
		pw.println(line);
}
} catch (Exception e) {
	pw.println("Error in doGet: "+ e.getMessage());
}
pw.flush(); 
pw.close();
}
public static DataInputStream execPOST(String Host,int Port, String URI, String data, 
PrintWriter pw) {
URL url = null;
URLConnection urlConn;
DataOutputStream printout;
try {
if (Port == -1) {
	url = new URL ("http://" + Host +URI);
} else {
	url = new URL ("http", Host, Port, URI);
	}
urlConn = url.openConnection();
urlConn.setDoInput (true);
urlConn.setDoOutput (true);
urlConn.setUseCaches (false);
urlConn.setDefaultUseCaches (false);
urlConn.setRequestProperty
	("Content-Type", "application/x-www-form-urlencoded");
printout = new DataOutputStream (urlConn.getOutputStream ());
if (data != null)
	printout.writeBytes(data);
	printout.flush();
	printout.close();
return new DataInputStream (new BufferedInputStream( urlConn.getInputStream ()));
}catch (Exception e) {
	pw.println("Error in execPOST: "+ e.getMessage());
	return null;
}
}
private String fileToString (String filename,  PrintWriter pw) {
InputStream is = null;
String out = "";
try {
is = new FileInputStream(filename);
} catch (FileNotFoundException notFound) {
pw.println("Error in fileToString: " + notFound.getMessage());
return null;
}
if (is == null) pw.println("read nothing from the file");
else pw.println("read ok from the xml file.");
try {
InputStreamReader isr = new InputStreamReader(is);
BufferedReader br = new BufferedReader(isr);
String line;
while((line = br.readLine()) != null) {
out = out + line + "\n";
}
} catch (IOException e) {
pw.println("Error in fileToString: " + e.getMessage());
return null;
}
	return out;
	}
public synchronized void doPost(HttpServletRequest req, HttpServletResponse res)
throws ServletException, IOException {
doGet(req,res);
	}
}

PERL Example

This is an example of PERL code that calls the Device List Manipulation Service URL and passes in the content of an XML file.

#!/opt/CSCOpx/bin/perl  
 
# Sample perl script to use Device List Manipulation API. 
# The return information from the API is printed out to STDOUT. 
 
use LWP::UserAgent; 
 
my $myInput = ""; 
my $url;
my $DevListSvc = '/rme/com.cisco.nm.rmeng.inventory.servlet.DeviceListService'; 
my $fileLoc = "/opt/CSCOpx/example/show.xml"; 
my $server = 'CiscoWorks-Server';
my $port = '1741'; 
 
open xmlFILE, $fileLoc or die "Can't find file $fileLoc: $!\n"; 
while (<xmlFILE>) { 
$myInput .= $_; 
} 
 
$url = 'http://' . $server . ':' . $port . $DevListSvc; 
 
$ua = new LWP::UserAgent; 
$ua->agent("AgentName/0.1 " . $ua->agent); 
 
### Create a request 
my $request = new HTTP::Request POST => $url; 
$request->content_type('application/x-www-form-urlencoded'); 
$request->content($myInput); 
 
my $response = $ua->request($request); 
 
### Check the outcome of the response 
if ($response->is_success) { 
 
print $response->content; 
### or do other data processing with the response outcome. 
 
} else { 
 
print "The request is failed\n"; 
 
}

Using RME Device Selector

The Device Selector pane is used to select RME devices to perform RME tasks. This pane lists all RME devices in a group. The devices are listed in the appropriate groups based on System-defined and User-defined group rules.

The devices 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 (Common Services > Device and Credentials > Device Management).


Note 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 RME tasks are based on your role and associated privileges that are defined in Cisco Secure ACS.


The Device Selector pane contains the following field/buttons:

Field/Button
Description

Device Name

Enter the device name.

You can enter multiple device names separated with a comma. You can also enter the wildcard character "*".

For example: 192.168.10.1*, 192.168.20.*

All

Lists all User-defined and System-defined groups for all applications that are installed on CiscoWorks server.

See Using the All Tab.

Selection

Lists all the devices that you have selected in the All tab.

Using this tab, you can deselect devices from the list.

Select

Click this button after entering the device name.

Based on your device name entry, the devices are selected.

See Using the Select Button.

Clear All

Click this button to clear all device selections, entered search criteria, etc.

Filter

You can define a rule for selecting devices.

See Using the Filter Button.

n object(s) selected

This is not a field/button.

Displays the total number of devices selected in the Device Selector.

Where n is the number of devices.


Using the All Tab

The All tab lists all the devices that are available in the RME. 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:

All RME devices are listed under the name RME@CiscoWorks_ServerHostName

The All Devices folder lists all RME devices. That is, this includes devices in Normal, Alias, Pending, and Pre-deployed states. This folder does not include devices in Suspended and Conflicting states.

The Normal Devices folder lists RME devices that has been successfully contacted by RME or the device has contacted RME at least once (polling, successful job completion, Syslog receipt etc.).

The Pre-deployed folder lists RME Device has never ever been reachable by RME (by protocol such as SNMP).

The Previous selection folder lists RME devices that were selected in previous RME task in the same session.

Saved device list folder lists RME devices that are saved explicitly by you while generating the Inventory Reports (Reports > Generator).


Note You can use the Previous selection and Saved device groups only when you are working on a RME application. You cannot use these device groups when you are working on another CiscoWorks application. That is, if you are working on the Campus Manager application, these groups must not be used.


The User Defined Groups folder lists RME devices that satisfy the group rules. The group rules are defined by you at the time of creating the User-defined groups.

See Managing RME Device Groups Using Group Administration for further details on RME User-defined groups.

Based on the applications that are installed on your CiscoWorks server, you will also view device folders related to other CiscoWorks applications: CiscoWorks_ApplicationName@CiscoWorks_ServerHostName

For example: For CiscoWorks Common Services, you will see:

CS@CiscoWorks_ServerHostName.

In RME Device Selector, the other CiscoWorks application device folders will list only RME devices.

For example: If you have devices, A, B, C and D in CiscoWorks Common Services and you have devices A, B, and C in RME then in the RME Device Selector under Common Services device folder, you will view on RME device list, A, B, and C.

The device appears in a disabled (greyed out) state when:

Device type is Unknown in Device and Credential Repository. In all RME applications device is shown as disabled except in Inventory job creation and reports.

Device type is known and correct in Device and Credentials (that is, the SysObjectID is correct and is available in Device and Credentials). However, that device is not supported by RME applications. (Inventory, Software Management, and Configuration Management).

There are two types of device selectors in RME:

Single Device Selector

Mutliple 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. See Figure 3-1.

Figure 3-1 Single Device Selector

Mutliple Device Selector

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

Figure 3-2 Multiple Device Selector

The following are the usage notes for the mutliple 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 the same, 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 RME tasks.

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

Using the Select Button

You can select devices by entering the devices name (Display Name) in the Device Name text box.

The search is based on the Display Name that you view in the Device Selector pane. This Display Name is entered when you add devices to Device and Credential Repository (Common Services > Device and Credentials > Device Management).

The devices name that you enter in the Device Name text box is searched only in the All Devices node. The device name is not searched in any other device nodes such as Normal devices, Pre-deployed, etc.

Usage Notes

The following are the usage notes for the Select button:

You can enter multiple device names separated with a comma. You can also enter wildcard character, "*" 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.*

You cannot enter multiple wildcard characters for selecting the devices

For example, 192.*.80.*. This is not 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 case-sensitive.

If you select devices and enter a search criteria in Device Name text box, only the devices which satisfy the search criteria will be selected in the All Devices node.

For example:

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

a. Select, 192.168.10.10, 192.168.10.20

b. Enter the search criteria 192.168.10.3*

The final selected devices are 192.168.10.30, and 192.168.10.31.

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,

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

b. Enter the search criteria 192.168.10.2*

c. The final selected devices that is displayed is, 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.

If you want to perform a new search, click Clear All before entering any new search entry.

Using the Filter Button

You can define a set of rules for selecting RME devices using the Filter button.

The devices are filtered based on the data present in the RME Inventory database.

In the Device Selector pane, when you click on the Filter button, the Device Filter Rule dialog box appears.

This dialog box contains the following fields and buttons:

Table 3-16 Device Filter Rule Dialog Box 

Field/Buttons
Description

OR, AND, EXCLUDE

Logical operators.

OR—Include objects that fulfill the requirements of either rule.

AND—Include only objects that fulfill the requirements of both rules.

EXCLUDE—Do not include these objects.

This field appears only after a rule expression is added in the Rule Text box.

Object Type

The type of object (device) that is used to form a group.

All RME rule expressions begin with the same Object Type, RME:INVENTORY:Device.

Variable

Device attributes, based on which you can define the group.

See RME Device Filter Rule Attribute.

Operator

The operator to be used in the rule. The list of possible operators changes based on the Variable selected.

Note When using the equals operator the rule is case-sensitive.

Value

The value of the rule expression. The possible values depend upon the variable and operator selected. Depending on the operator selected, the value may be free-form text or a list of values.

The wildcard characters are not supported.

Add Rule Expression

Used to add the rule expression to the group rules.

Rule Text

Displays the rule.

Check Syntax

Verifies that the rule syntax is correct.

Use this button if you have entered the rules manually.

Filter

Used to filter the devices based on the defined rule.


Usage Notes

The following are the usage notes for the Filter button:

If you have not selected any device nodes, then the filter rule is applied only for All Devices node.

If you have selected any devices then the filter rule is applied only for the selected devices.

You can either enter the rules directly in the Rule Text field, or select the components of the rule from the Rule Expression fields, and form a rule.

Each rule expression contains the following:

<object type>.<variable> <operator> <value>

Object Type—The type of object (device) that is used to form a group. All RME rule expressions begin with the same Object Type, RME:INVENTORY:Device.

Variable—Device attributes, based on which you can define the group. See the RME Device Filter Rule Attribute.

Operator—Operator to be used in the rule. The list of possible operators changes based on the Variable selected.

Value—Value of the rule expression. The possible values depend upon the variable and operator selected. Depending on the operator selected, the value may be free-form text or a list of values.

If you entering the rule expressions manually, the rule expression must follow this syntax:

<object type>.<variable> <operator> <value>

If you are entering more than one rule expression, you must enter logical operators OR, AND or EXCLUDE after every rule expression.

You must use Check Syntax button only when you add a rule manually or when you modify a rule expressions in the Rule Text.

The filter operation is case-sensitive.

To delete the rules in the Rule Text box, select the complete rule including the logical operator and press the delete key on your keyboard.

If you want to perform a new filter, click Clear All before selecting any new devices.

RME Device Filter Rule Attribute

The following table lists the available device filter rule attributes that you can use for defining the filter rules.

Table 3-17 RME Device Filter Rule Attribute 

Attribute Group
Attribute Type
Description

Asset

Asset.CLE_Identifier

CLE identifier of the asset.

Asset.Part_Number

Orderable part number of the asset.

Asset.User_Defined_Identifier

User-defined identifier of the asset

Chassis

Chassis.Model_Name

Name of the model.

Chassis.Number_Of_Slots

Number of slots in that chassis.

Chassis.Port_Count

Total port count of the chassis.

Chassis.Serial_Number

Serial number of the chassis.

Chassis.Vendor_Type

Type of vendor for the chassis.

Chassis.Version

Version number of the chassis.

Flash

Flash.File_Name

Location of flash file.

Flash.File_Size

Flash file size in MB.

Flash.Model_Name

Model name of the flash device.

Flash.Partition_Free

Free space in MB.

Flash.Partition_Name

Flash partition name.

Flash.Partition_Size

Flash partition size in MB.

Flash.Size

Total flash device size in MB.

Image

Image.ROM_Sys_Version

ROM system software version

Image.ROM_Version

Version of ROM.

Image.Sys_Description

Image system description

Image.Version

Running Device image version.

IP Address

IP.Address

Device IP address.

IP.Address_Type

Version of IP, IPv4 or IPv6

IP.Network_Mask

Network Mask address

Memory

Memory.Free

Free memory in MB.

Memory.Name

Name of the memory.

Memory.Size

Total RAM size in MB.

Memory.Type

Memory type.

Memory.Used

Used memory in MB.

Module

Module.HW_Version

Module hardware version.

Module.Model_Name

Name of the model.

Module.Port_Count

Total ports on that module.

Module.Serail_Number

Serial number of the module.

Module.Vendor_Type

Type of vendor for the module.

Processor

Processor.Model_Name

Name of the model.

Processor.NVRAM_Size

Size of the processor NVRAM in MB.

Processor.NVRAM_Used

Size of the processor NVRAM that has been utilized, in MB.

Processor.Port_Count

Total port count of the processor

Processor.RAM_Size

Size of the processor RAM in MB.

Processor.Serial_Number

Serial number of the processor.

Processor.Vendor_Type

Type of vendor for the processor.

State

State

RME device state such as Normal, Alias, etc.

System

System.Contact

Device contact person name.

System.Description

Description of the system.

System.DomainName

Device domain name.

System.Location

Device location information.

System.SystemOID

System Object ID of the device (sysObjectID).


Using Filter Button—An Example

The following example describes the procedure for selecting devices whose IP address starts with 192.168 or Network Mask is 255.255.255.0. Also, these devices must be in Normal state.

The devices in your network are:

192.168.101.200 with network mask 255.255.255.128

192.168.101.201 with network mask 255.255.255.0

192.168.102.251 with network mask 255.255.255.0

192.168.102.202 with network mask 255.255.255.19

192.168.200.210 with network mask 255.255.255.128

You can apply this filter in two ways:

Procedure 1:


Step 1 Click on Filter in the Device Selector pane.

The Define Filter Rule dialog box appears.

Step 2 Select,

a. State as Variable

b. = as Operator

c. Normal as Value

Step 3 Click Add Rule Expression.

The rule is added into the Rule Text.

Step 4 Select,

a. And as Logical Operator

b. IP.Address as Variable

c. Contains as Operator

d. Enter 192.168.101 for Value.

Step 5 Click Add Rule Expression.

The rule is added into the Rule Text.

Step 6 Select,

a. OR as Logical Operator

b. IP.Network_Mask as Variable

c. equals as Operator

d. Enter 255.255.255.0 for Value.

Step 7 Click Add Rule Expression.

The rule is added into the Rule Text.

Step 8 Click Filter.

The Device Selection dialog box appears.

The devices that satisfied the filter condition are selected. That is these two devices are selected.

192.168.101.200 with network mask 255.255.255.0

192.168.101.251 with network mask 255.255.255.0


Procedure 2:


Step 1 Select the Normal Devices node in the Device Selector pane.

All devices under this node will be selected.

Step 2 Click on Filter in the Device Selector pane.

The Define Filter Rule dialog box appears.

Step 3 Select,

a. IP.Address as Variable

b. Contains as Operator

c. Enter 192.168 for Value.

Step 4 Click Add Rule Expression.

The rule is added into the Rule Text.

Step 5 Select,

a. OR as Logical Operator

b. IP.Network_Mask as Variable

c. equals as Operator

d. Enter 255.255.255.0 for Value.

Step 6 Click Add Rule Expression.

The rule is added into the Rule Text.

Step 7 Click Filter.

The Device Selection dialog box appears.

The devices that satisfied the filter condition are selected. That is these two devices are selected.

192.168.101.200 with network mask 255.255.255.0

192.168.101.251 with network mask 255.255.255.0


Device Icons and Device Types

This section lists all CiscoWorks device icons mapped to the CiscoWorks device types:

Table 3-18 Device Icons Mapped to Device Types 

Device Icon
Device Type
Device Type Example
(This list is not comprehensive and only has samples)

Universal Gateways and Access Servers

Cisco AS5300 Universal Gateways

Cisco AS5400 Series Universal Gateways

Cisco AS5800 Universal Gateways

Cisco AS5X00 Series Access Servers

Cisco 2500 Series Access Servers

[and so on]

Cisco AS5200 Series Universal Access Servers

AS5200

[and so on]

Content Networking

Cisco Content Service Switch (CSS) 11000 Series

Cisco Content Service Switch (CSS) 11000 Series

Content Engine-500 Series

[and so on]

Cisco Distributed Director

Content Distribution Manager Series (CDM-4630, CDM-4650)

[and so on]

DSL and Long Reach Ethernet (LRE)

Cisco DSL Switches (6015 IP DSL, 6160 IP DSL, 6260 IP DSL)

Catalyst 2900XL Series (2924 LRE XL, 2912 LRE XL)

[and so on]

Optical Networking

Cisco ONS Series (ONS 15540 ESP, ONS 15530 ETSI)

[and so on]

Routers

Cisco 7500 Series

Cisco 3700 Series

Cisco 2500 Series

Cisco 1700 Series

[and so on]

Switches and Hubs

Catalyst 6000 Series

Catalyst 4000 Series

Catalyst 3900 Series

FastHub (300, 316T, 3116)

[and so on]

Cisco 1538 Series Micro Hubs

MicroHub(1502, 1503, 1516)

[and so on]

Cisco Catalyst 5500 Series Switches

Catalyst 5500

Catalyst 5505

Catalyst 5509

[and so on]

Cisco BPX 8600 Series Switches

BPX 8620

BPX 8650

[and so on]

Cisco MGX 8200 Series Edge Concentrators

MGX 8220

MGX 8850

[and so on]

Security and VPN

Cisco VPN 3000 (C3005, C3015, C3030)

PIX Firewall (515, 520)

[and so on]

Broadband Cable

Universal Broadband Routers (UBR) 7100 Series (7111, 7114)

Universal Broadband Routers (UBR) 900 Series (904, 905)

[and so on]

Storage Networking

Cisco Storage Switch (MDS9509, MDS9216)

[and so on]

Voice and Telephony

Any Cisco switch or router that is voice enabled (contains a voice card or voice port and its function is to aid IP Telephony operations).

Switch or router with FXS/FXO/T1/E1 interfaces. Routers with gatekeeper functions.

Cisco 1700

Cisco 2600

Cisco 3600

[and so on]

Cisco 7800 Series Media Convergence Servers

Cisco 7845 Media Convergence Server

Cisco 7835 Media Convergence Server

Cisco 7830 Media Convergence Server

[and so on]

Cisco VG200 Series Gateways

VG224

[and so on]

Network Management

CiscoWorks Wireless LAN Solution Engine

Cisco SwitchProbes

[and so on]

CiscoWorks Hosting Solution Engine

CiscoWorks 1105 Hosting Solution Engine, 1.3

CiscoWorks 1105 Hosting Solution Engine, 1.4

CiscoWorks 1105 Hosting Solution Engine, 1.5

[and so on]

Wireless

Cisco Aironet AP Series (340, 350)

[and so on]

Cisco Interfaces and Modules

Catalyst 6000 modules (WS-SVC-IPSEC-1)

[and so on]

Cisco Catalyst 6500 Series Network Analysis Module (NAM-1,2)

Network Analysis Module

Network Analysis Module 1

Network Analysis Module 2

[and so on]

Unknown

Unknown device type.