User Guide for Resource Manager Essentials 4.2 (With LMS 3.1)
Chapter 3: Adding and Troubleshooting Devices Using Device Management
Downloads: This chapterpdf (PDF - 0.98MB) The complete bookPDF (PDF - 10.7MB) | 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

Auto Allocation Settings Summary for Manage By Groups Mode

Managing Devices Not Matching the Policy

Verifying the Device Credentials While Adding Devices to RME

Verifying the Device Credentials While Editing Device Credentials in 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

Attribute Error Report

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

Checking and Viewing Device Credentials

Generating Device Credentials Report

Credential Verification Report

Credential Error Report

Verifying Device Credentials

Viewing Job Details

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

Device Manageability Status

Understanding Device Manageability Status Report

Using RME Device Selector

Using Simple Search

Using Advanced Search

Using Advanced Search—An Example

Using the All Tab

Using the Search Results Tab

Using the Selection Tab

Device Icons and Device Types

Use Cases for Adding Devices into RME

Adding devices into RME Automatically

Adding devices into RME Manually

Verifying the Device Credentials while adding devices to RME

Verifying the Device Additions


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.

After 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.

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, TFTP Timeout, and Natted RME IP Address.

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 Application Log Level Settings for further details.

Perform the Device Status Test

You can verify the Device Status to find means to troubleshoot Inventory and Config failure.

See Device Manageability Status 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".

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

Edit device identity

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 change these Device Management Settings to enable or disable automatic allocation of devices to RME from Device Credentials Repository (DCR).

To change the device management settings, go to Resource Manager Essentials > Admin > Device Mgmt > Device Management Settings

This Device Management Settings page consists of the following:

Table 3-1 Device Management Settings Options

Field/Buttons
Description
Auto Allocation Settings

Enable Auto Mode

(Checkbox)

Check this option if you want to automatically add all devices added into DCR to RME, as well. This option is enabled by default. If you want to manually add device to RME, then disable this option.

For more information on adding devices manually, see Adding Devices to RME Manually.

The number of devices added into RME will depend on the license limit.

Manage All Devices

(radio button)

Allows you to add devices from DCR and manage them in RME. This allocation method is dynamic in nature. In other words, the devices added to DCR after applying the settings are also added into RME at runtime.

You can use this option only if the Enable Auto Mode checkbox is checked. The number of devices added into RME will depend on the license limit. If you select this option and a device is deleted from DCR, the device will also be deleted from RME.

For more information on deleting devices in this mode, see Deleting Devices in Allocate All Devices Mode.

Manage By Groups

(radio button)

Allows you to add devices from DCR and manage them in RME based on groups.The devices that are part of the selected groups are added into RME.

This allocation method is dynamic in nature. In other words, the new devices added to groups after applying the settings are also added into RME at runtime.

You can use this option only if the Enable Auto Mode checkbox is checked. The number of devices added into RME depends on the license limit.

For more information on the Auto Allocation Settings Summary that pops up after applying this option, see Auto Allocation Settings Summary for Manage By Groups Mode.

Group Selector

Lists the groups available for auto allocation. Select one or more groups so that devices belonging to those groups are added into RME automatically.

You can use this option only if the Enable Auto Mode checkbox is checked.

Devices Not Matching the Policy

Allows you to generate a report for those devices that are managed by RME but do not satisfy the grouping rule criteria.

You can use this button only if the Manage By Groups option is selected.

For more information, see Managing Devices Not Matching the Policy.

Apply

Allows you to apply the changes after changing the settings.

Device Management CDA Settings

Verifying Device Credentials While Adding Devices

Check this option if you want to verify the device credentials while adding devices to RME. This option is disabled by default.

For more information, See Verifying the Device Credentials While Adding Devices to RME.

Verifying Device Credentials on Editing Device Credentials

Check this option if you want to verify the device credentials while editing the device credentials in RME. This option is disabled by default.

For more information, See Verifying the Device Credentials While Editing Device Credentials in RME.


Deleting Devices in Allocate All Devices Mode

You cannot delete devices directly from RME when the device allocation mode is set to Allocate All Devices.

To delete devices:


Step 1 Create a User-defined group with all the devices except those devices which you want to delete.

Step 2 Change the auto allocation method to Manage by Groups

Step 3 Select the User-defined group created in Step 1

Step 4 Click Apply.

Only those devices which you have selected to be included in the group will be available in RME.


You cannot delete devices directly from RME if you have selected Allocate By Groups mode. If you try to delete a device configured to a group, a message appears indicating that you cannot directly delete devices configured to a group and that you need to suspend the devices manually and then only delete them.

Auto Allocation Settings Summary for Manage By Groups Mode

To access the Auto Allocation Settings summary:


Step 1 Select the Manage By Groups mode

Step 2 Select the required device group from the group selector

Step 3 Click Apply


The Auto Allocation Settings Summary consists of the following:

Table 3-2 Fields in the Auto Allocation Settings Summary

Field
Description
Auto Allocation Settings Summary

Number of devices currently managed

Total number devices that are currently managed by RME.

Number of new devices after this rule change

Number of devices that will be added into RME after the rule change.

This number is based on the current number of devices in the selected groups.

Click on the count link to view details of the new devices that will be added after the rule change.

For more information on the fields in the new devices table, see List of new devices field description.

Total number of devices after this rule change

The total number of devices that will be henceforth managed by RME after applying this rule.

This is the sum of:

Number of devices currently managed + Number of new devices after this rule change

Current license limit

The current license limit for RME. If it is an evaluation license, then the license limit is 100 devices for 90 days.

List of new devices

IP Address

IP Address of the new device that will be added to RME after applying the Manage By Groups auto allocation option.

Device Name

Device Name of the new device that will be added to RME after applying the Manage By Groups auto allocation option.

OK

Click OK if you want to save and apply the settings.

Cancel

Click Cancel if you want to discard the changes you made to the settings.


Managing Devices Not Matching the Policy

The devices not matching the policy are those devices that are managed by RME but do not satisfy the group criteria. You can ascertain the list of stale devices using the Stale Devices button available in the Auto Allocation Settings window.

To access the Auto Allocation Settings window, go to Resource Manager Essentials > Admin > Device Mgmt > Device Management Settings

You can use the Devices Not Matching the Policy button, only if you have selected Manage by Groups auto allocation method.

The fields in the Stale Devices Report output are:

Table 3-3 Fields in the Stale Devices Report

Field
Description

IP Address

IP Address of the device managed by RME but does not satisfy the group criteria.

Device Name

Device name of the device managed by RME but does not satisfy the group criteria.

Suspend All

Moves all the devices not matching the policy to Suspended State in RME.


Behavior of Auto Allocation during Fresh Install, Upgrade and Reinstall

The behavior of Device Auto Allocation is as follows:

During Fresh Install of RME 4.2, the Enable Auto Mode option is checked by default. The Manage All Devices auto allocation method is used.

While upgrading from a previous version of RME to RME 4.2,

If the Auto Allocation option was enabled in the previous version of RME, after upgrade the Enable Auto Mode option is checked by default. The Manage All Devices auto allocation method is used.

If the Auto Allocation option was disabled in the previous version of RME then after upgrade, the Enable Auto Mode option is unchecked. The Manual mode of device allocation is used.

During Reinstall of RME 4.2, the Enable Auto Mode option is checked by default. The Manage All Devices auto allocation method is used.

Verifying the Device Credentials While Adding Devices to RME

You can check your device credentials while adding devices to RME and view the results by scheduling and running a CDA job. 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 results of the CDA job.

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 Jobs.

The Device Credentials Job Creation dialog box appears.

Step 2 Select either:

Device Selector, if you want to schedule report generation for static set of devices (See the topic, Using RME Device Selector in the section Managing Inventory Collection and Polling Using Inventory, for more details.) You can select devices that are in Normal, Pending or Pre-deployed states for job creation.

Or

Group Selector, if you want to schedule report generation for dynamic group of devices.

Step 3 Enter the information required to create a job:

Field
Description

Device Credentials Options

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

Scheduling

Run Type

Specifies the type of schedule for the job:

Immediate—Runs the report immediately.

6 - hourly—Runs the report every 6 hours, starting from the specified time.

12 - hourly—Runs the report every 12 hours, starting from the specified time.

Once—Runs the report once at the specified date and time.

Daily—Runs daily at the specified time.

Weekly—Runs weekly on the day of the week and at the specified time.

Monthly—Runs monthly on the day of the month and at the specified time.

For periodic jobs, the subsequent instances of jobs will run only after the earlier instance of the job is complete.

For example, if you have scheduled a daily job at 10:00 a.m. on November 1, the next instance of this job will run at 10:00 a.m. on November 2, only if the earlier instance of the November 1 job has completed. If the 10.00 a.m. November 1 job has not completed before 10:00 a.m. November 2, then the next job will start only at 10:00 a.m. on November 3.

If you select Immediate, the date field option will be disabled.

Date

1. Enter the start date in the dd Mmm yyyy format, for example, 02 Jul 2004, or click on the calendar icon and select the date.

2. Enter the start time by selecting the hours and minutes from the drop-down list.

The Date field is enabled only if you have selected an option other than Immediate in the Run Type field.

Job Info

Job Description

Enter a description for the report that you are scheduling. This is a mandatory field. Accepts alphanumeric values. This field is restricted to 256 characters.

E-mail

Enter e-mail addresses to which the job sends messages when the job has run.

You can enter multiple e-mail addresses separated by commas.

Configure the SMTP server to send e-mails in the View/Edit System Preferences dialog box (Common Services > Server > Admin > System Preferences).

We recommend that you configure the CiscoWorks E-mail ID in the View / Edit System Preferences dialog box (Common Services > Server > Admin > System Preferences).

When the job starts or completes, an e-mail is sent with the CiscoWorks E-mail ID as the sender's address,

Attachment

Check this option if you want the job notification mail to consist of attachments in either CSV or PDF format.

Either select:

CSV if you want the attachment in CSV format.

Or

PDF if you want the attachment in PDF format. This is the default format.

The CSV and PDF radio options will be enabled only if the Attachment checkbox is checked.

If the Attachment option is disabled, go to Common Services to change the settings. For more information on configuring attachment settings as well as the maximum size of attachments allowed in notification mails, see Common Services Online Help


Step 4 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 from the Device Management CDA Settings area.

Step 3 Click OK.


To view the result of the CDA job:


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 Jobs.

The Device Credential Verification dialog box appears.

Step 2 A CDA job is created with the following description:

CDA job due to Device Add.

Step 3 Click on the Job ID to view the results of the job.


Verifying the Device Credentials While Editing Device Credentials in RME

You can check your device credentials while editing device credentials in RME and view the results by scheduling and running a CDA job. Use this option to make sure that your Device and Credential Repository credentials, match your actual device credentials.

Verifying device credentials while editing device credentials in RME involves:

1. Selecting the credentials that need to be verified while editing device credentials in RME.

2. Selecting the verify device credentials while editing device credentials option from the Resource Manager Essentials > Admin > Device Mgmt > Device Management Settings.

3. Viewing the results of the CDA job.


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

If a single device is added to RME, then the device credential check is done without creation of a CDA job.

To select the credentials that need to be verified while editing device credentials in RME:


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

The Device Credentials Job Creation dialog box appears.

Step 2 Select either:

Device Selector, if you want to schedule report generation for static set of devices (See the topic, Using RME Device Selector in the section Managing Inventory Collection and Polling Using Inventory, for more details.) You can select devices that are in Normal, Pending or Pre-deployed states for job creation.

Or

Group Selector, if you want to schedule report generation for dynamic group of devices.

Step 3 Enter the information required to create a job:

Field
Description

Device Credentials Options

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

Scheduling

Run Type

Specifies the type of schedule for the job:

Immediate—Runs the report immediately.

6 - hourly—Runs the report every 6 hours, starting from the specified time.

12 - hourly—Runs the report every 12 hours, starting from the specified time.

Once—Runs the report once at the specified date and time.

Daily—Runs daily at the specified time.

Weekly—Runs weekly on the day of the week and at the specified time.

Monthly—Runs monthly on the day of the month and at the specified time.

For periodic jobs, the subsequent instances of jobs will run only after the earlier instance of the job is complete.

For example, if you have scheduled a daily job at 10:00 a.m. on November 1, the next instance of this job will run at 10:00 a.m. on November 2, only if the earlier instance of the November 1 job has completed. If the 10.00 a.m. November 1 job has not completed before 10:00 a.m. November 2, then the next job will start only at 10:00 a.m. on November 3.

If you select Immediate, the date field option will be disabled.

Date

1. Enter the start date in the dd Mmm yyyy format, for example, 02 Jul 2004, or click on the calendar icon and select the date.

2. Enter the start time by selecting the hours and minutes from the drop-down list.

The Date field is enabled only if you have selected an option other than Immediate in the Run Type field.

Job Info

Job Description

Enter a description for the report that you are scheduling. This is a mandatory field. Accepts alphanumeric values. This field is restricted to 256 characters.

E-mail

Enter e-mail addresses to which the job sends messages when the job has run.

You can enter multiple e-mail addresses separated by commas.

Configure the SMTP server to send e-mails in the View/Edit System Preferences dialog box (Common Services > Server > Admin > System Preferences).

We recommend that you configure the CiscoWorks E-mail ID in the View / Edit System Preferences dialog box (Common Services > Server > Admin > System Preferences).

When the job starts or completes, an e-mail is sent with the CiscoWorks E-mail ID as the sender's address,

Attachment

Check this option if you want the job notification mail to consist of attachments in either CSV or PDF format.

Either select:

CSV if you want the attachment in CSV format.

Or

PDF if you want the attachment in PDF format. This is the default format.

The CSV and PDF radio options will be enabled only if the Attachment checkbox is checked.

If the Attachment option is disabled, go to Common Services to change the settings. For more information on configuring attachment settings as well as the maximum size of attachments allowed in notification mails, see Common Services Online Help


Step 4 Click OK.


To select the verify device credentials while editing device credentials:


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 Editing Devices from the Device Management CDA Settings area.

Step 3 Click OK.


To view the results of the CDA job:


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

The Device Credential Verification dialog box appears.

Step 2 A job is created with the description:

CDA Job due to Credential Edit.

Step 3 Click on the Job ID to view the results of the job.



Note The CDA jobs which are in Stop initiated state or not in Running state will be deleted. Only the current running jobs will be retained.


Using the RME Devices Window

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

Table 3-4 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

Natted RME IP Address

TFTP Timeout

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 can either:

Add devices manually (See Adding Devices to RME Manually)

Or

Add devices automatically (See Adding Devices to RME Automatically)

Before adding devices to RME, you must add devices into Device and Credential Repository (Common Services > Device and Credentials > Device Management).

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

When you add devices to Device and Credential Repository and RME is down, the devices are added automatically when RME comes up again. The devices are added automatically, if the Automatically Manage Devices from Credential Repository option is enabled.

If this option is not enabled, you must manually add the devices.

Notes on Cluster Management Devices and Proxy Devices

The following is additional information on:

Cluster Management Devices

If you have added the Cluster Commander to DCR with the device type as Cisco Cluster Management Suite, it does not appear in the RME device selector. You must add this Commander in DCR, as Member. Normally, the Commander is 0th member of the cluster.

For more information, see the section Cluster Managed in the Adding Devices to the Device and Credential Repository Common Services Online help.

Similar to other devices, these cluster members are managed in RME and you can perform all RME tasks on them.

Proxy Devices

All relationships between the Cisco Standard devices and Proxy Managers are considered while adding devices to DCR.

The Proxy managed devices can be added to RME in the same way as other Cisco Standard devices. RME displays these Proxy managed devices in the same way as it displays other Cisco Standard Devices.

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.2 on Cisco.com to know the list of devices that are supported in RME:

http://www.cisco.com/en/US/products/sw/cscowork/ps2073/products_device_support_tables_list.html

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 Enable Auto Mode 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, a message appears, There are no new devices in DCR. Please click here to add devices in DCR.

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

Step 4 Select the devices from the group.

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

To select particular device type, select the Device Type Groups check box, and select the device type (for example, Routers, Switches and Hubs, etc.).

To select devices from User Defined Groups, select the User-Defined Groups checkbox and 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.

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

Step 5 Click Next.

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

Table 3-5 View Attributes Fields

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. The minimum value is zero.

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. The minimum value is zero seconds. There is no maximum value limit.

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. The minimum value is zero seconds. There is no maximum value limit.

Changing the Telnet timeout value affects inventory collection.

Natted RME IP Address

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 Natted RME IP Address. 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 recommend that you import the same file that you have exported after editing. If any new device entries are added, these 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 and displays the updated RME device attributes.

While importing the edited RME device attributes file an error message may appear,
Attribute values for some selected devices are invalid. See Attribute Error Report for details.

See Editing RME Device Attributes section to know the minimum and maximum values for the RME device attributes. Also see Attribute Error Report for more information.

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, if you want to modify the attributes of that device.

Or

Select all devices by checking Apply to All Devices checkbox, if you want to apply the attributes of one device to all other devices that are listed in 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) these devices get added into 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 when you either export or edit the RME device attributes from the RME Devices window (Devices > Device Management > RME Devices).

SNMP Retry

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

The default value is 2. The minimum value is zero.

SNMP Timeout

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

The default value is 2 seconds. The minimum value is zero seconds. There is no maximum value limit.

Changing the SNMP timeout value affects inventory collection.

Telnet Timeout

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

The default value is 36 seconds. The minimum value is zero seconds. There is no maximum value limit.

Natted RME IP Address

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.

TFTP Timeout

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

The default value is 5 seconds and the minimum value is 0 seconds. There is no maximum value limit.

This attribute is available only when you edit the RME device attributes from the RME Device Attributes window (Admin > System Preferences > RME Device Attributes).

Do any one of the following to set or edit the RME device attributes:

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

Set the device attributes value for a single RME device using Resource Manager Essentials > Devices > Device Management > RME Devices > Edit Device Attributes > Inline Edit. See To set or edit the RME device attributes for a single RME device

Set the device attributes value for the bulk of RME devices using Resource Manager Essentials > Devices > Device Management > RME Devices > Edit Device Attributes > Export. See To set or edit the RME device attributes for the bulk of RME devices


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


To set 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

Natted RME IP Address

TFTP Timeout

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

You can change the value for a single or bulk 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 a single RME device and To set or edit the RME device attributes for the bulk of 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 a single RME device


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 RME Device Attributes dialog box appears.

Step 4 Click Inline Edit.

The Device Attributes Information dialog box appears.

Step 5 Select a device from the Devices pane.

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

You can check the Apply to all Devices checkbox to apply the device attributes of one device to all other devices that are listed in the Devices pane.

Step 7 Click Modify in the Device Attributes Information dialog box.

Step 8 Click Apply in the RME Device Attributes dialog box.


To set or edit the RME device attributes for the bulk of 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 RME Device Attributes dialog box appears.

Step 4 Click Export.

The Export Device Attributes 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 enter the filename on the RME server.

Click OK in the Server Side File Browser dialog box.

b. Click OK in the Export Device Attributes to File dialog box.

The notification window displays Data exported successfully.

c. Click OK in the notification window.

Step 5 Edit the exported file.

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

See RME Device Attributes Export File Format for further information.

Step 6 Click Import in the RME Device Attributes dialog box.

The Import Device Attributes to File dialog box appears.

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

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 in the Server Side File Browser dialog box.

b. Click OK in the Import Device Attributes to File dialog box.

The notification window displays Data imported successfully.

c. Click OK in the notification window.

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

While importing the edited RME device attributes file an error message may appear,
Attribute values for some selected devices are invalid. See Attribute Error Report for details.

See Editing RME Device Attributes section to know the minimum and maximum values for the RME device attributes. Also see Attribute Error Report for more information.

Step 7 Click Apply.

The RME Devices window appears.


Attribute Error Report

The Attribute Error report is generated when the attribute values imported for some selected devices are invalid. This error occurs when the device attributes that are imported as a CSV file contain invalid attributes.

You can click on the Attribute Error Report link that is displayed in the error message, to open the Attribute Error Report.

You can also view the Attribute Error Report by clicking on the Attribute Error Report button from the following locations:

Resource Manager Essentials > Devices > Device Management > RME Devices > Edit Device Attributes

Resource Manager Essentials > Devices > Device Management > RME Devices > Add Devices > Next


Note The Attribute Error Report link is available only if importing of device attributes causes error.


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. The minimum value is zero.

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. The minimum value is zero seconds. There is no maximum value limit.

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. The minimum value is zero seconds. There is no maximum value limit.

Natted RME IP Address—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 the refresh 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. See Table 3-6:

Table 3-6 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

Refresh

(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?

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.

The supported version for CSV is 3.0.


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 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.

To view the device status, click Resource Manager Essentials > Devices > Device Management.


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

Export to File

(Icon)

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

Print

(Icon)

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-7 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.

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

For details see To suspend the Pending devices:

Refresh

(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. See Table 3-8:

Table 3-8 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. See Table 3-9:

Table 3-9 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.

Refresh

(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.

To view the device status, click Resource Manager Essentials > Devices > Device Management.


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.


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.

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 3 After you have corrected your device specification, your network connectivity, or both, resubmit the device.

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

Table 3-10 describes what you should do if the Ping utility determines that the device is an unknown host:

Table 3-10 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 LMS Portal home page > Device Troubleshooting > Device Center.


Table 3-11 describes what you should do if the Ping utility determines that devices as unreachable:

Table 3-11 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.


Table 3-12 describes what you should do if the device does not respond to an ICMP Echo request packet:

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

Problem 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 LMS Portal 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 LMS Portal 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 LMS Portal 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 LMS Portal home page > Device Troubleshooting > Device Center.


Table 3-13 describes what you should do if the device does not respond to an SNMP Get request packet:

Table 3-13 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 LMS Portal 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 LMS Portal home page > Device Troubleshooting > Device Center.


Table 3-14 describes what you should do if the device does not support RFC 1213 (SNMP MIB II) attributes:

Table 3-14 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. It:

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

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

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

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

5. 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 a 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 (See Table 3-15):

Table 3-15 Conflicting Devices Types Window 

Fields/Buttons
Description

Device Identity

(Field)

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.


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.

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.

You can check the All checkbox to verify all the device credentials.

Click Update to save your settings or click Reset to discard the changes.

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 LMS Portal home page, 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 using the Telnet transport library. It also verifies if the attempt is successful.

SSH Username and Password

SSH username and password are verified by trying to login to the device using the SSH transport library. It also verifies if the attempt is successful.

Telnet enable mode password

Enable mode password is verified while trying to establish connection using Telnet and entering the enable mode. It also verifies if the attempt is successful.

SSH enable mode password

Enable mode password is verified while trying to establish connection using SSH and entering the enable mode. It also verifies if the attempt is successful.

After 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.


Generating Device Credentials Report

You can generate Device Credentials Report from the Report Generator page in RME.

To generate the report:


Step 1 Select Resource Manager Essentials > Reports > Report Generator.

The Report Generator Page appears.

Step 2 Select Device Credential from the drop-down list on the left.

Step 3 Select either the Verification report or the Error report from the drop-down list on the right.

Step 4 Select the required devices using the device selector. (For more details, see the topic, Using RME Device Selector)

Step 5 Select the credentials that you want to verify from the Device Credentials Options pane.

You can select one or many credentials.

Step 6 Click Finish.

The generated report appears.

Or

Click Reset to clear the selections, and select again.


The following buttons are available on the Credential Verification Report and Credential Error Report:

Button
Description

Export to File

(Icon)

Export this report in either PDF or CSV format.

Print

(Icon)

Generates a format that can be printed.

Export device list to Device Selector

(Icon)

Export the list of devices for which the report has been generated, to the Device Selector. You can use this list to perform specific tasks such as, editing the device credentials.

You can view this exported list of devices in the Saved device list folder of the RME Device Selector.


You can edit the device credentials by clicking the Edit Device Credentials button. This is displayed only if the job has failed devices.

When you click Edit Device Credentials, the Edit Credentials page in DCR is launched. Any changes to the credentials is updated in all the failed devices. A confirmation message is shown before updating credentials in all failed devices.

Credential Verification Report

The Credential Verification Report displays the device names and the credential status for each device. This report can be used to view the static device credential verification report.

The report displays the number of devices that were selected for credential verification, and lists the devices for which the report is not available.

Table 3-16 describes the Credential Verification Report Status messages:

Table 3-16 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.

The status of SNMP(V1/V2/V3) Credential Verification(RO,RW) if shown as Successful, does not necessarily mean that access to all MIBs in the device were successful.

It only reflects the validity of SNMP Community strings, Username and password through RFC 1213 MIB.

No authentication configured

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

RME was able to use 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 any 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.

Did Not Try

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

A Telnet password does not exist, so could not log into 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.

Credentials not Verified

Specific credentials were not verified because they were not selected for verification.


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.

Credential Error 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.

Verifying Device Credentials

To verify device credentials, select Resource Manager Essentials > Devices > Device Management > Device Credential Verification Jobs.

The Device Credential Verification Jobs browser dialog box appears with a detailed list of all scheduled CDA jobs.

The columns in the job browser display the following information:

Column
Description

Job ID

Unique number assigned to job when it is created.

For periodic jobs such as Daily, Weekly, etc., the job IDs are in the number.x format. The x represents the number of instances of the job. For example, 1001.3 indicates that this is the third instance of the job ID 1001.

Click on the hyperlink to view the Job details. (See Viewing Job Details)

Status

Status of the job:

Successful—When the job is successful.

Failed—When the job has failed.

Stopped—When the job has been stopped.

Running—When the job is in progress.

Missed Start—When the job is not initiated to run.

Scheduled—When the job is scheduled to run at a later point of time.

Stop Init—When the job is stopped, it goes to Stop Init State before going to Stopped state.

Description

Description of the job, entered at the time of job creation.

Owner

Username of the job creator.

Scheduled at

Date and time at which the job was scheduled.

Completed at

Date and time at which the job was completed.

Schedule Type

Type of job schedule—Immediate, Once, Daily, Weekly, Monthly, 6-Hourly, 12-Hourly.

You can specify when you want to run the Device Credential job.

To do this, select one of these options from the drop down menu:

Immediate—Runs the report immediately.

Once—Runs the report once at the specified date and time.

Daily—Runs daily at the specified time.

Weekly—Runs weekly on the day of the week and at the specified time.

Monthly—Runs monthly on the day of the month and at the specified time.

6-Hourly—Runs once in 6 hours.

12-Hourly—Runs once in 12 hours.

For periodic jobs, the subsequent instances of periodic jobs will run only after the earlier instance of the job is complete.

For example: If you have scheduled a daily job at 10:00 a.m. on November 1, the next instance of this job will run at 10:00 a.m. on November 2 only if the earlier instance of the November 1 job has completed. If the 10.00 a.m. November 1 job has not completed before 10:00 a.m. November 2, then the next job will start only at 10:00 a.m. on November 3.


When you click Report, you are taken to the Report Generator Page for Device Credential Verification. (RME > Reports > Report Generator).

Click Create to create a new device credential verification job. You must enter the following details:

Device Selector

Select the required devices using Device Selector. (For more details, see Using RME Device Selector)

Device Credentials Options

Select the credential which need to be verified. Click All to verify all credentials.

Scheduling

Select the Run Type for the job. If you select Immediate, the job is run immediately. Otherwise, you can select the date and time to run the job.

Job Info

Enter a description for the job.

Enter an e-mail ID (or multiple e-mail ids) to which the job results have to be sent. You can also specify multiple e-mail IDs.


Viewing Job Details

From the Job Browser dialog box, you can learn more about any job by viewing its details.


Step 1 In the Device Credential Verification Job Browser, click the Job ID hyperlink.

The Job Details pop-up appears, displaying the day, date and time details in the header at the top of the report. The Job ID and the Status appear in the header of the report.

The Job Details dialog box has two panes. The left pane contains a table of contents for the job results. The results appear in the right pane.

Step 2 Click a page in the left pane to view its corresponding report in the right pane.

Double-click a folder in the left pane to open and close it.

If the folder has subfolders, the next level of subfolders appears under it. Otherwise, its corresponding report appears in the right pane.

The contents of the left pane depends on the state of the job. The left pane can contain:

Job Summary (in the Job Details folder).

Devices Details (in the Device Details folder).

Work Order. Contains same the information as the workorder that was displayed when the job was created.

For retried jobs, the job definitions are not updated. For such jobs, the original job definitions are retained.


To perform actions on a job, click one of the following:

Edit—Edits selected scheduled job.

Retry—Retry a failed job. This is applicable for Immediate jobs.

Stop—Stops or cancels a running job.

Delete—Deletes the selected job from the job browser.

The following buttons are available in the Job Details page:

Button
Description

Export to File

(Icon)

Export this report in either PDF or CSV format.

Print

(Icon)

Generates a format that can be printed.

Export device list to Device Selector

(Icon)

Export the list of devices for which the report has been generated, to the Device Selector. You can use this list to perform specific tasks such as, editing the device credentials.

You can view this exported list of devices in the Saved device list folder of the RME Device Selector.


You can edit the device credentials by clicking the Edit Device Credentials button. This is displayed only if the job has failed devices.

When you click Edit Device Credentials, the Edit Credentials page in DCR is launched. Any changes to the credentials is updated in all the failed devices. A confirmation message is shown before updating credentials in all failed devices.

After editing the credentials, you can retry the failed jobs.

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.

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.DeviceListService

Where,

CiscoWorks_host is the CiscoWorks server hostname.

The default CiscoWorks port is 1741

To enable secured connection through HTTPS for DLMS, you must configure cmf-app.conf (NMSROOT\MDC\Apache\conf) to allow HTTPS access for the servlet rme/com.cisco.nm.rmeng.inventory.servlet.DeviceListService:

To configure cmf-app.conf:


Step 1 Add the following text as one line to the file:

SetEnvIf Request_URI /rme/com.cisco.nm.rmeng.inventory.servlet.DeviceListService allow_https

Step 2 Restart the daemons.

HTTPS access is now enabled.


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

https://CiscoWorks_host :port/rme/com.cisco.nm.rmeng.inventory.servlet.DeviceListService

Where,

CiscoWorks_host 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

Table 3-17 describes the mapping of CSV 2.0 to CSV 3.0

Table 3-17 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,puser,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,tacpwd1,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,tacpwd1,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

PERL Example

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";

}

Device Manageability Status

You can verify device manageability status using Device Manageability Status option. This option enables you to generate a Device Manageability Status report to identify possible causes for Inventory and Configuration collection failure and take timely corrective action.

To generate a Device Manageability Status Report:


Step 1 Select Resource Manager Essentials > Devices > Device Management > Device Manageability Status

The RME Device Manageability Status dialog box appears.

Step 2 Select the required devices using the Device Selector. (See the topic, Using RME Device Selector for more details.)

Step 3 Click Generate Report to generate a Device Manageability Status Report.


Understanding Device Manageability Status Report

Table 3-18 describes the various fields that constitute a Device Manageability Status Report.

Table 3-18 Fields in a Device Manageability Status Report

Field
Description

Device Name

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

Sys Object Id

sysObjectID of the device.

sysObjectID is an authoritative identification of the network management subsystem contained in the entity. This value is allocated within the SMI enterprises subtree (1.3.6.1.4.1) and provides an easy and unambiguous means for determining the kind of box that is managed.

Model

Model of the device

Device Status

Device status is either Managed or Unmanaged.

The devices are Managed when they are in RME in any of these device states: Normal, Alias, and Pre-deployed.

The devices are Unmanaged when they are in RME in either of these device states: Conflict or Suspended device states. The devices are also considered Unmanaged when they are not in RME but in Device and Credentials Repository.

Inventory Collection Status

Inventory Collection status of a device can be either Success or Failed.

The collection is considered successful, if all the required information about the device is received by the RME server.

The collection is considered as Failed, if all the required information about the device is not received by the RME server. If the status of Inventory Collection is Failed, then the possible causes as well as the recommended corrective actions are provided for the device.

Inventory Last Updated time

Time at which the Inventory Collection was last run.

Config Collection Status

The Configuration collection status of a device can be either Success or Failed.

The collection is considered Successful, if all required information about the device is received by the RME server.

The collection is considered as Failed, if all required information about the device is not received by the RME server.

Click on the Success or Failed link against each device to get detailed information of the reasons for Config collection success or failure.

Config Last Updated time

The time at which the Configuration collection was last run.



Note During Upgrade or Restore, the generated Device Manageability Status report may not display data for some devices. You need to run a fresh Inventory or Configuration collection for those devices and generate the report again.


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 Device type groups 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.


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

Search Input

Enter the search expression in this field.

You can enter single device names or multiple device names. If you are entering multiple device names, separate them with a comma. You can also enter the wildcard characters "*" amd "?".

For example: 192.168.10.1*, 192.168.20.*

Search

Use this icon to perform a simple search of devices based on the search criteria you have specified in the Search Input text field.

For information on Search, see Using Simple Search.

Advanced Search

Use this icon to perform an advanced search of devices based on the search criteria you have specified in the Search Input text field.

For information on Advanced Search, see Using Advanced Search.

All

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

For more information, see Using the All Tab.

Search Results

Displays all the search results from Search or Advanced Search.

For more information, see Using the Search Results Tab.

Selection

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

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

For more information, see Using the Selection Tab.


Figure 3-1 shows the new device selector.

Figure 3-1 Device Selector

Tool-tips are provided for long device names so that you do not have to scroll to see the complete device name.

Using Simple Search

You can search for devices by entering the devices name (Display Name) in the Search Input field.

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).

Usage Notes

The following are the usage notes for Simple Search:

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

For example:

You can enter device names in these many ways to select multiple devices:

192.168.80.140, 192.168.135.101, rtr805

192.168.80.*, 192.168.*

192.168.22.?

You 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 not case-sensitive.

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

For example:

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

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 objects selected text displays 0 (zero) device selected.

Using Advanced Search

You can use the Advanced Search icon to specify a set of rules for advanced search. Advanced search is based on the Grouping Services attributes of RME's Grouping Services Server. In the Advanced Search dialog box, you can create rules to search for devices.

Figure 3-2 shows the Advanced Search dialog box.

Figure 3-2 Device Selector Advanced Search

This dialog box contains the following fields and buttons (See Table 3-19):

Table 3-19 Advanced Search 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

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 Advanced Search Rule Attribute.

Operator

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

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.

Search

Used to search for devices based on the defined rule.


Usage Notes

The following are the usage notes for Advanced Search:

If you have not selected any device nodes, then advanced search is applied only for All Devices node.

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 Advanced Search 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 are 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 advanced search operation is not 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 search, click Clear All before selecting any new devices.

RME Advanced Search Rule Attribute

Table 3-20 lists the available device advanced search rule attributes that you can use for defining advanced search.

Table 3-20 RME Advanced Search 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

Name of the 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 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.Serial_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 Advanced Search—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 are assumed to 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

Use the following procedure for advanced search:


Step 1 Click the Advanced Search icon in the Device Selector pane.

The Define Advanced Search 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 Search.

The Device Selection dialog box appears.

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

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


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:

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), View Credential Verification Report and Error Report (Devices > Device Management > Device Credential Verification).

Only one Saved device list is created within the RME device selector. If concurrent users have created Saved device list, only the last created Saved device list appears in the RME Device Selector. The previous Saved device list is overwritten with the latest.


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 a stand-alone system, server name is not appended. For example, for Common Services, you will see CS.

Other application folders are displayed in RME based on the settings at Common Services > Device Management > Device Selector Settings. For more details, see Common Services Online Help.

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

Multiple Device Selector

Single Device Selector

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

Multiple Device Selector

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

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

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

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

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

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

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

For example, if you select the Normal Devices node and expand 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 Search Results Tab

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

Using the Selection Tab

The Selection Tab serves as a repository of all the devices that you select from the Search Results tab or the All Tab.

There are three ways to select devices in the Device Selector:

Selection Using All Tab

Selection Using Search

Selection Combining All and Search

Selection Using All Tab

You can select devices using the tree view in the All tab. This tab displays all devices that are available in RME.

Selection Using Search

You can search devices using Search or Advanced Search. The list of devices matching the search criteria is shown under the Search Results tab. You can select the required devices from the Search Results tab. The Selection tab reflects whatever you selected from Search Results.

If you click the All tab now, the devices selected from Search Results will be shown in the All Devices group.

Selection Combining All and Search

After you select devices using the All tab, you can add a few more devices using Search. You can enter the search criteria and search using Search or Advanced Search and the Search Results tab displays the devices matching the criteria.

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

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


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


Device Icons and Device Types

Table 3-21 lists all CiscoWorks device icons mapped to the CiscoWorks device types:

Table 3-21 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 AS5350XM Universal Gateway

Cisco AS5400XM Universal Gateway

Cisco AS5X00 Series Access Servers

Cisco 2500 Series Access Servers

AS5350XM - Cisco AS5350XM Universal Gateway

AS5400XM - Cisco AS5400XM Universal Gateway

[and so on]

Cisco ASA-5500 Adaptive Security Appliance (Single Mode)

Cisco ASA-5510 Adaptive Security Appliance

Cisco ASA-5505 Adaptive Security Appliance

Cisco ASA-5540 Adaptive Security Appliance Security Context

Cisco ASA-5550 Adaptive Security Appliance Security Context

This device icon represents single mode.

Cisco ASA-5500 Adaptive Security Appliance (Multi Mode)

Cisco ASA-5550 Adaptive Security Appliance Security Context

Cisco ASA-5510 Adaptive Security Appliance

Cisco ASA-5540 Adaptive Security Appliance Security Context

This device icon represents multi mode.

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

Cisco 2821 Integrated Services Router

Cisco XR 12406 Router

Cisco XR 12410 Router

Cisco XR 12810 Router

[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 Switch

Catalyst 5505 Switch

Catalyst 5509 Switch

[and so on]

Cisco Catalyst 6500 Series Switches

Catalyst 6500 Switch

Catalyst 6509 Switch

3560E-12D-S-Rex - Cisco Catalyst 3560E-12D-S Switch

3750-24PS Cisco - Catalyst 3750-24PS Switch

3750G-12S Cisco - Catalyst 3750G-12S Switch

Cisco Catalyst Series Switches (Others)

2960-24S- Cisco Catalyst 2960-24-S Switch

2960-24TC-S -Cisco Catalyst 2960-24TC-S Switch

2960-48TC-S  -Cisco Catalyst 2960-48TC-S Switch

CBS3110G -Cisco Catalyst Switch Module 3110G for IBM BladeCenter

Cisco-BCH -Cisco BladeCenterH

ME-3400G-2CS-A -Cisco ME 3400G-2CS-A Switch

SFS-3054- Cisco SFS 3504 Multifabric Server Switch

Cisco Wide Area Application Engine

WAE-612 -Cisco WAE-612 Wide Area Application Engine

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]

Cisco PIX 515E Firewall

Cisco PIX 515E Firewall Security Context

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)

Cisco MDS 9513 Multilayer Director Switch

[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)

ACE Device Support Cisco -ACE Application Control Engine Module

[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.


For details about Device Selector, see Common Services Online Help. See "Related Documentation" section on page -xxxiii

The recommended number of devices for Contract Connection and Bug Tool Kit is 500. For Software Management (SWIM), the recommended number of devices is 1500. The recommended number of devices for rest of the modules in RME is based on the number of devices supported by each LMS 3.1 license.

For more information on the number of devices supported by each LMS 3.1 license, see Installing and Getting Started with CiscoWorks LAN Management Solution 3.1

Use Cases for Adding Devices into RME

Case

You are a network administrator and you want to add devices into RME and Verifying the Added Devices

Solution

Before you add devices into RME, you should know where the devices are first added. The devices first gets added to Device Credential Repository (DCR) which is a component available in Common Services.

For more information on DCR, see the Common Services Online Help or Common Services User Guide.

After the devices are added into DCR, you can add those devices into RME from DCR.

You can use any of the two methods available to add devices into RME:

Adding of Devices into RME Automatically

Adding of Devices into RME Manually

Adding devices into RME Automatically

To add devices automatically from DCR into RME:


Step 1 Go to RME > Admin > Device Mgmt > Device Management Settings

The Device Management Options page is displayed.

Step 2 Check Enable Auto Mode option.

Step 3 From the sub option select Manage All devices.

Step 4 Click OK

Now whenever a device is added to DCR, it is automatically added to RME


Adding devices into RME Manually

Before you proceed with manually adding of devices into RME, ensure that the Enable Auto Mode option is unchecked.

To disable this option:


Step 1 Go to RME > Admin > Device Mgmt > Device Management Settings

The Device Management Options page is displayed.

Step 2 Uncheck Enable Auto Mode option

Step 3 Click OK


To add devices manually from DCR into RME:


Step 1 Go to RME > Admin > Device Mgmt > RME Devices

The Device Selector appears.

Step 2 Use the expand buttons to locate the xyz group of devices and check it.

Step 3 Click Add Devices button to add the xyz group of devices into RME.


Verifying the Device Credentials while adding devices to RME

To do this:


Step 1 Go to RME > Admin > Device Mgmt > Device Management Settings

The Device Management Settings dialog box is displayed.

Step 2 Check Verify Device Credentials While Adding Devices option.

Step 3 Click OK.


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 the Device Additions

After adding devices, you would want to verify if the devices have been added properly. To do that:


Step 1 Go to RME > Devices > Device Management

The Device Management State Summary dialog box appears.

This list indicates the state each device is in as a result of the device add operation. Ideally all devices should eventually be in the Normal State, meaning RME was at least able to contact them using an SNMP read operation. The Pending State would indicate the add operation is still in progress.

Step 2 Click the Normal Devices count link.

The Normal Devices dialog box appears.

Step 3 Expand the RME devices group from the Device Selector.

Step 4 From the expanded list select the Normal Devices group.

Step 5 Click Report button.

The Device Status Report is generated and displayed showing the devices added to the RME along with the results of the inventory and configuration collection.