User Guide for Resource Manager Essentials 4.0 (With LMS 2.5)
Managing Inventory Collection and Polling Using Inventory

Table Of Contents

Managing Inventory Collection and Polling Using Inventory

How to Use Inventory

Pre-requisites

Collecting and Updating Inventory Data

Viewing Reports and Graphs

Using the Inventory Job Browser and Viewing Inventory Collection Status

Using the Inventory Job Browser

Viewing Job Details

Creating and Editing an Inventory Collection or Polling Job

Stopping, Cancelling or Deleting an Inventory Collection or Polling Job

Viewing Inventory Collection Status

Inventory Administrative Operations

Setting Change Report Filters

Changing the Schedule for System Inventory Collection or Polling

Generating Inventory Reports

Generating a 24 Hour Inventory Change Report

Generating a Hardware Report

Generating a Software Report

Generating a Detailed Device Report

Generating a Chassis Slot Summary

Generating Chassis Slot Details

Generating MultiService Port Details

Generating a Hardware Summary Graph

Generating a Software Version Graph

Generating a Chassis Summary Graph

Using Inventory Custom Report Templates

Creating a Custom Report Template

Adding a Rule

Modifying a Rule

Deleting a Rule

Modifying a Custom Template

Deleting a Custom Template

Understanding Template Rules Evaluation

Running a Custom Report

Custom Report Output

Examples of Custom Template Definitions

Template Definition Example 1

Template Definition Example 2

Template Definition Example 3

Template Definition Example 4

Template Definition Example 5

Template Definition Example 6

Template Definition Example 7

Template Definition Example 8

Template Definition Example 9

Template Definition Example 10

Template Definition Example 11

Template Definition Example 12

Using Device Center for Inventory Tasks


Managing Inventory Collection and Polling Using Inventory


Inventory, or the Inventory Collection Service (ICS) and Poller software component of RME, collects inventory data from the network devices and keeps the inventory updated. It does this by:

Enabling you to collect inventory periodically. You can ensure that inventory data is collected periodically to avoid the usage of stale inventory data by other RME applications.

Polling the devices for any changes in inventory. If it detects a change, it invokes a full inventory data collection.

Initiating inventory data collection on request.

For example, when the Syslog application receives an inventory change Syslog message, it invokes inventory data collection using the API that Inventory registers with Syslog.

RME acquires inventory data from devices using SNMP queries to standard SNMP MIB II objects and Cisco-specific enterprise MIB objects.

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


Note You can select the log level settings for the Inventory application using the feature "Log Level Settings" (Resource Manager Essentials > Admin > System Preferences > Loglevel Settings).


How to Use Inventory

You can use the Inventory application of RME for:

Collecting and Updating Inventory Data

Viewing Reports and Graphs

Pre-requisites

Before you schedule inventory polling and collection jobs, you must perform these tasks:


Step 1 Add or import devices and add their credentials to the Device and Credentials Admin (DCA) database.

Step 2 Add devices in RME using Resource Manager Essentials > Devices > Device Management > RME Devices.

In the RME Devices dialog box that appears, click Add Devices. For the detailed procedure, see the topic "Adding Devices to RME" in the section "Adding and Troubleshooting Devices Using Device Management".

We also recommend that you enter the RME device attributes:

a. Select Resource Manager Essentials > Devices > Device Management > RME Devices.

The RME Devices dialog box appears.

b. Select the devices for which you want to edit the RME device attributes and click Edit Device Attributes.

For more Device Management information, see the section "Adding and Troubleshooting Devices Using Device Management" in the User Guide or Online Help.



Note Any change that you make to the system time affects RME processes. You will have to restart the Daemon Manager for the proper functioning of RME.


You can select the log level settings for the Inventory application using the feature "Log Level Settings".

Collecting and Updating Inventory Data

To ensure that your inventory data is up-to-date, use RME to:

Schedule inventory collection. (A default job is created when you install RME, and you can change the schedule of this job as required.) For details see "Creating and Editing an Inventory Collection or Polling Job".

Schedule "heavyweight" collection of inventory data from all managed devices to run and update the database at regular intervals.

Set inventory poller schedule. (A default job is created when you install RME, and you can change the schedule of this job as required.) For details see "Creating and Editing an Inventory Collection or Polling Job".

Schedule periodic polling to see if any changes have occurred on any managed devices, and, if changes are detected, trigger an inventory collection on only the changed devices.

Create and run user-defined inventory collection jobs.

Create and run jobs. You can schedule jobs on specific sets of devices to run immediately, once, or periodically, with a frequency such as 6- hourly, 12-hourly, daily, weekly or monthly.

In this way, you can update your inventory database and show the changes in all the associated inventory reports. For details see "Creating and Editing an Inventory Collection or Polling Job".

Before you run inventory collection see "Pre-requisites".

View the Permission Report (Common Services > Server > Reports) to check whether you have the required privileges to perform these tasks.


Note Inventory log files (IC_Server.log, ICServer.log, ICServerUI.log, and invreports.log) are stored at these locations:
On Windows: NMSROOT/log, where NMSROOT is the CiscoWorks installation directory.
On Solaris: /var/adm/CSCOpx/log


Viewing Reports and Graphs

You can monitor the system, interface, hardware, and software details of your network devices. Note that a history of inventory changes are logged by and viewed through Change Audit. Reports and graphs listed here are viewed from the Inventory application.

24-Hour Inventory Change Report (see "Generating a 24 Hour Inventory Change Report").

Shows the details of all inventory changes that were detected on the device during the last 24 hours.

Chassis Slot Summary (see "Generating a Chassis Slot Summary") and Chassis Slot Details (see "Generating Chassis Slot Details").

Shows overview and detailed capacity information for selected devices.

Hardware Report (see "Generating a Hardware Report") and Software Report (see "Generating a Software Report").

Shows summary of device hardware and software data. For example, you can run these reports before you perform a hardware or software upgrade to help determine the scope of the work involved.

Generating a Detailed Device Report.

Shows the details about all stored inventory data (hardware, flash, memory, software, etc.) for selected devices.

MultiService Port Details (see "Generating MultiService Port Details").

Shows details about a selected switch's multiservice ports, which supply power while supporting voice traffic.

Hardware Summary Graph (see "Generating a Hardware Summary Graph").

Shows the distribution of device types among all the managed device classes.

Chassis Summary Graph (see "Generating a Chassis Summary Graph").

Shows the distribution of chassis types among all the managed device classes.

Software Version Graph (see "Generating a Software Version Graph").

Shows the distribution of software versions among all the managed device classes.

Inventory Custom Reports (see "Using Inventory Custom Report Templates").

Shows device details by their attributes, see Table 6-3, "Inventory Groups and Attributes".

You can save the reports that you have generated, in a comma separated (CSV) format or in the PDF format. Redirect a report to an e-mail recipient, save the report, or run it again later.

Using the Inventory Job Browser and Viewing Inventory Collection Status

The Inventory option of Resource Manager Essentials (Resource Manager Essentials > Inventory), enables you to:

Use the Inventory Browser (see "Using the Inventory Job Browser").

View the Inventory Collection status (see "Viewing Inventory Collection Status").

Using the Inventory Job Browser

The Inventory Job Browser displays all user-defined jobs. It also displays the system-defined inventory collection and polling jobs. You can create and manage inventory jobs using the Job Browser. You can edit, stop, cancel or delete jobs using this Job Browser.


Note View the Permission Report (Common Services > Server > Reports) to check whether you have the required privileges to perform these tasks.


When you install RME, a default job is defined for Inventory Collection and Inventory polling.

These default jobs include all the devices in the normal and pending states, and the devices in the pre-deployed state.

When the default job runs, RME evaluates the "all devices" group and executes the job. This way whenever new devices are added to the system, these devices are also included in the default collection/polling job.

For the default system jobs, the device list cannot be edited. You can only change the schedule of those jobs. Therefore, when a periodic system job for inventory collection or polling is scheduled, the scheduled job is not displayed in the Inventory Job Browser.

However, the job is displayed in the Job Browser when it is running, or after it is completed, with all its details such as Job ID, Job Type, Status, etc.

User-defined jobs, however, are displayed in the Job Browser once they are scheduled, when they are running, and after they are completed.

To invoke the Inventory Job Browser:

Select Resource Manager Essentials > Devices > Inventory > Inventory Jobs.

The Inventory Job Browser dialog box appears with a detailed list of all scheduled inventory jobs.

The columns in the Inventory Job Browser dialog box are:

Column
Description

Job ID

Unique ID assigned to the job by the system, when the job is created. Click on the hyperlink to view the Job details (see "Viewing Job Details".)

Periodic jobs such as 6-hourly, 12-hourly, Daily, Weekly and Monthly, have the job IDs that 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.

Job Type

Type of job—System Inventory Collection, System Inventory Polling, Inventory Collection and Inventory Polling.

Status

Status of the job—Scheduled, Successful, Failed, Cancelled, Stopped, Running, Missed Start.

Description

Description of the job entered by the job creator. This is a mandatory field. Accepts alphanumeric values. The field is restricted to 256 characters.

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


Using the Filter by field in the Inventory Job Browser, you can filter the jobs displayed in the browser.

You can filter the jobs using any of the following criteria and clicking Filter:

Filter Criteria
Description

All

Select All to display all jobs in the Job Browser

Job ID

Select Job ID and enter the whole or the first part of the Job ID(s) that you want to display.

Job Type

Select Job Type and then select any one of the following:

Inventory Polling

System Inventory Polling

Inventory Collection

System Inventory Collection

Status

Select Status and then select any one of these:

Schedule

Successful

Failed

Cancelled

Stopped

Running

Missed Start

Note Missed start is the status when the job could not run for some reason at the scheduled time. For example, if the system was down when the job was scheduled to start, when the system comes up again, the job does not run. This is because the scheduled time for the job has elapsed. The status for the specified job will be displayed as Missed Start.

Description

Select Description and enter the first few letters or the complete description.

Owner

Select owner and enter the user ID or the beginning of the user ID.

Schedule Type

Select the schedule type and select any one of these:

Immediate

Once

6-hourly

12-hourly

Daily

Weekly

Monthly


Click on this icon to refresh the Inventory Job Browser.


Using the Inventory Job Browser, you can perform the following tasks:

Table 6-1 Inventory Browser Buttons, the Tasks they Perform and their Description 

Button
Task
Description

Create

Create jobs

You can create a new job.

Edit

Edit jobs

You can edit a only a scheduled job.

You can select only one job at a time for editing. If you select more than one job, the Edit button is disabled.

Cancel

Cancel jobs

You can cancel a scheduled job. You can select more than one scheduled job to cancel. You are prompted to confirm the cancellation.

If it is a periodic job, you are prompted to confirm whether it you want to cancel only the current instance of the job or all future instances.

After you select a periodic job and click Cancel, the Cancel Confirmation dialog box appears.

1. Select one of the following options:

Cancel just this instance

Cancel this and all future instances

2. Click OK.

Stop

Stop jobs

You can stop a running job.

However, the job will be stopped only after the devices currently being processed are completed. This is to ensure that no device is left in an inconsistent state.

Delete

Delete jobs

You can delete a job that has been scheduled, successful, failed, stopped or cancelled. However, you cannot delete a running job.

You can select more than one job to delete, provided they are scheduled, successful, failed, stopped, or cancelled jobs. For instance, if you select a failed job and a running job, the Delete button is disabled.

If you are deleting a scheduled periodic inventory job, the following message is displayed:

If you delete periodic jobs, or instances of a periodic job, that are yet to be run, the jobs will no longer run, nor will they be scheduled to be run again. You must recreate the deleted jobs.

You are prompted to confirm the deletion.


.

Records for Inventory Collection and Polling jobs need to be purged periodically. You can schedule a default purge job for this purpose. See "Job Purge" in the section "Setting System-wide Parameters Using System Preferences".

Viewing Job Details

In the Inventory Job Browser, click on the Job ID hyperlink to view the following job details for Inventory collection, or polling jobs:

Job Details—Expand this node to display Job Summary and Job Results for the inventory collection or polling job.

Job Summary—Click on this node to view the following for the inventory collection or polling job:

Job Summary—Displays information about the job type, the job owner, the status of the job, the start time, the end time and the schedule type.

Device Summary—Displays information about the total devices submitted for the job, the number of devices that were scanned, the number of devices that were pending, the devices that were successful with change, successful without change, and the failed devices.

Job Results—Displays information about the number of devices scanned, the names of the scanned devices, the duration of scanning, the average scan time per device, and the job results description, for the inventory collection or polling job.

To see more details, expand the Job Results node. You will see the following details:

Failed—If you click on this node, you will see the collective list of failed devices and the reason for their failure in the right pane, for the inventory collection or polling job.

If you expand this node, the list of failed devices appears.

If you select a device, the right pane displays the device name and the reason for the failure. For example, Device sensed, but collection failed, or Device not reachable.

Successful: With Changes

For a Inventory collection job:

Expand the Successful: With Changes node to display a list of devices.

If you select a device, the right pane displays the device name and a hyperlink: View Changes. If you click on this hyperlink, the Inventory Change Details report appears for the device. The report displays information about the attribute, the type of change, the time of change, the previous value and the current value for the collection job.

If you do not expand this node, you will see the collective list of devices with the status Success: With changes with their View Changes hyperlinks, in the right pane, for the collection job.

There is a View All Changes hyperlink in the right pane. If you access this hyperlink, all the changes on the devices are displayed.

For a Inventory polling job:

Click on the Successful: With Changes node to display a list of devices that have changes, as a comma separated list, in your right pane. To view the Inventory collection job details for these devices, click the Inventory Collection Job Details hyperlink.

Successful: Without Changes

If you click on this, you will see as a comma-separated list in your right pane, the devices that were successful for the inventory collection or polling job.


Note Inventory Poller creates a Collection job when it detects changes.


Creating and Editing an Inventory Collection or Polling Job

To create an Inventory collection or polling job:


Step 1 In the Inventory Job Browser, click Create. (To invoke the Inventory Job Browser, see "Using the Inventory Job Browser").

The Create Inventory Job dialog box appears.

Step 2 Select the required devices using the Device Selector. (See the topic, "Using RME Device Selector" in the section "Adding and Troubleshooting Devices Using Device Management", for more details.)

You can select devices that are in Normal, Pending or Pre-deployed states for job creation.

Step 3 Enter the information required to create a job:

Field
Description

Job Type

Select either Inventory Collection or Inventory Polling, as required.

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,


Step 4 Click Submit.

You get a notification that the job has been successfully created, and it appears in the Inventory Job Browser.

To edit a job, select a scheduled job from the Inventory Job Browser, and click Edit.

The Edit Inventory Job dialog box appears. The Job Type options are disabled. You can however, change the Scheduling and Job Info fields as required, and click Submit.

The job is edited.


Stopping, Cancelling or Deleting an Inventory Collection or Polling Job

You can stop, cancel or delete Inventory Collection or Polling jobs.

Stopping a Job, see "Stop" in Table 6-1.

Cancelling a job, see "Cancel" in Table 6-1.

Deleting a job, see "Delete" in Table 6-1.

Viewing Inventory Collection Status

You can view the status of Inventory collection.


Step 1 Select Resource Manager Essentials > Inventory > View Inventory Collection Status.

The Inventory Collection Status dialog box appears.

Step 2 View the Inventory collection status:

Table 6-2 An Example of Inventory Collection Status with Description 

Inventory Collection Status
No. of Devices
Description

Inventory Collected

15 (hyperlink)

Click on the Devices hyperlink to view a report called Devices for which Inventory has been Collected at Least Once.

The report displays the list of devices and the time of the last inventory collection, for each device.

Click on the hyperlink for each device to view the details of that device, in Device Center.

Inventory Never Collected

10 (hyperlink)

Click on the Devices hyperlink to view the list of devices for which inventory has never been collected.

Click on the hyperlink for each device to view the details of that device, in Device Center.

Total

25

Total number of devices for which the inventory collection status is displayed.


Click on this icon to refresh the Inventory Collection Status dialog box.


For more details about Device Center, see the CiscoWorks Common Services Online Help or User Guide.


Inventory Administrative Operations

Using the Admin tab of Resource Manager Essentials (Resource Manager Essentials > Admin > Inventory), you can perform the administrative operations for the Inventory application:

Setting Change Report Filters.

Changing the Schedule for System Inventory Collection or Polling.


Note View the Permission Report (Common Services > Server > Reports) to check whether you have the required privileges to perform these tasks.


Setting Change Report Filters

Using the Inventory Change Filter dialog box, you can select the attributes that you do not wish to log using Change Audit. The history of inventory changes are logged by and viewed through Change Audit.

The attributes that you select in the Inventory Change Filter dialog box, are monitored for Inventory changes like other variables. However, they are not logged using Change Audit. Consequently, these changes are not displayed in your inventory change reports.

For example, for Stack devices, if you do not want to log the operational status for changes in Change Audit, select the Operational Status option in the Inventory Change Filter dialog box.

The Inventory Change Filter dialog box, displays each attribute group and the corresponding filters for the attribute group, for your selection.

To view all inventory change reports, select Resource Manager Essentials > Reports > Report Generator. In the Report Generator dialog box, first select the application, Change Audit, and then select the Exception Period Report from the respective drop-down lists.

To view inventory changes from the last 24 hours, select Resource Manager Essentials > Reports > Report Generator. In the Report Generator dialog box, first select the application, Inventory, and then select report 24 Hour Inventory Change report from the respective drop-down lists.


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


To set Inventory change filters:


Step 1 Select Resource Manager Essentials > Admin > Inventory > Change Filter.

The Inventory Change Filter dialog box appears.

Step 2 Select a group from the Select a Group drop-down list. See Table 6-3.

The dialog box refreshes to display the filters available for the attribute group that you selected.

Step 3 Select the attributes that you do not want to monitor for changes.

Step 4 Click Save.

A confirmation dialog box appears.

Step 5 Click OK to save the details.

You can use Reset All to reset your selections for all groups. This resets all previous values to blanks.


Changing the Schedule for System Inventory Collection or Polling

At the time of RME installation, system jobs are created for both Inventory collection and polling, with their own default schedules. A periodic inventory collection job collects inventory data from all managed devices and updates your inventory database.

Similarly, the periodic polling polls devices and updates the inventory database. You can change the schedule of these default, periodic system jobs.

For inventory collection or polling to work, your devices must have accurate read community strings entered. (For the detailed procedure, see the section "Adding and Troubleshooting Devices Using Device Management".) The changes detected by inventory collection or polling, are reflected in all associated inventory reports.

Note that the inventory poller allows you to collect inventory less often. The poller detects most changes in managed devices, with much less impact on your network. If the poller detects changes, it initiates inventory collection.

To collect inventory or poll devices as a one-time event or for selected devices only, create user-defined inventory collection or polling jobs (see "Creating and Editing an Inventory Collection or Polling Job").


Note View the Permission Report (Common Services > Server > Reports) to check whether you have the required privileges to perform these tasks.



Step 1 Select Resource Manager Essentials > Admin > Inventory > System Job Schedule.

The System Job Schedule dialog box displays the current collection or polling schedule. It is divided into two panes:

Job Type: Inventory Collection

Job Type: Inventory Polling

The fields in these panes are identical. You can enter date for either collection and polling, or both. Click Apply in the respective panes for the changes to take effect.

Step 2 Set the new Inventory Collection or Inventory Polling schedule in the respective panes, as follows:

Field
Description
Scheduling

Run Type

Select the run type or frequency for inventory collection or polling—Daily, Weekly, or Monthly.

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.

Date

Select the date for the collection or polling to begin, using the date picker.

at

Enter the time for the collection or polling to begin, in the hh:mm:ss format.

Job Info

Job Description

Has a default Job Description:

For Job Type, Inventory Collection, the description is, System Inventory Collection Job.

For Job Type, Inventory Polling, the description is, System Inventory Polling Job.

E-mail

Enter e-mail addresses to which the job sends messages when the collection or polling 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.


Inventory data does not change frequently, so infrequent collection is better. However, if you are installing much new equipment, you may need more frequent collection.

Infrequent collection reduces the load on your network and managed devices. Collection is also best done at night or when network activity is low. Also, make sure your collections do not overlap, by checking their duration using the Inventory Job Browser (see "Using the Inventory Job Browser"), and scheduling accordingly.

Step 3 Click Apply.

The new schedule is saved.


Generating Inventory Reports

You can use the Inventory reports option to examine your default and custom reports.

Using the Report Generator of RME, you can generate the following Inventory reports and graphs:

24-Hour Inventory Change Report (see "Generating a 24 Hour Inventory Change Report").

Chassis Slot Details (see "Generating Chassis Slot Details").

Chassis Slot Summary (see "Generating a Chassis Slot Summary").

Detailed Device Report (see "Generating a Detailed Device Report").

Hardware Report (see "Generating a Hardware Report").

Software Report (see "Generating a Software Report").

MultiService Port Details (see "Generating MultiService Port Details").

Hardware Summary Graph (see "Generating a Hardware Summary Graph").

Software Version Graph (see "Generating a Software Version Graph").

Chassis Summary Graph (see "Generating a Chassis Summary Graph").

You can run Inventory reports and graphs on multiple clients concurrently. While the reports can be run immediately or scheduled to run at a later date, the graphs can only be run immediately.

Successfully generated reports are stored in the Archives. You can access the reports archives by selecting Resource Manager Essentials >Reports > Report Archives (see the topic "Viewing Archived Reports" in the section "Generating Reports").

In the Reports Archive/Report jobs, you cannot see the Immediate Run Type reports.

An Immediate job displays the first 10,000 lines of a report. For the full report, schedule a job.

If you have selected the Run Type as Immediate, the report appears in a separate browser window.

If you have selected an option other than Immediate in the Run Type field, then a message is displayed,

Job ID created successfully. 
Go to Reports > Report Jobs to view the job status. 

Here, Job ID is a unique Job number.

You can cross-launch to Device Centre by clicking the device names hyperlink, in the generated reports. For details see "Using Device Center for Inventory Tasks".

To purge archived reports and report jobs, see the topic "Purging Reports Jobs and Archived Reports" in the section "Generating Reports".

To use the Report Generator:


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

The RME Reports dialog box appears, in the Report Generator page.

Step 2 From the first drop-down list box, select the application—Inventory.

Step 3 From the second drop-down list box, select the required report, for example, 24-Hour Inventory Change Report.

Step 4 Select the required devices using the Device Selector. (See the topic, "Using RME Device Selector" in the section "Adding and Troubleshooting Devices Using Device Management", for more details.)

Step 5 Enter the information required to generate the required report:

Field
Description
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, all other options are disabled.

Run Type (continued)

If you select any of the other frequencies, then you can specify the start date and time and also provide this information:

Job Description—Enter the description of the job. A mandatory field. Enter up to 256 characters (alphanumeric).

E-mail ID—Enter e-mail addresses to which the job sends messages for notification that has to be sent after the report is run. An optional field.

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.

Report Publish Path—This is the location on the RME server where an HTML version of the report will be saved. An optional field.

Date

Click on the calendar icon and select the date.

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

Select the hours and minutes from the drop-down lists.

Job Info

Job Description

Enter a description for the report that you are scheduling.

The Job Description field is enabled only if you have selected an option other than Immediate in the Run Type field. This is a mandatory field. Accepts alphanumeric values. The field is restricted to 256 characters.

E-mail

Enter a valid e-mail ID of the users who should be notified when the report 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.

The E-mail field is enabled only if you have selected an option other than Immediate, in the Run Type field.

Report Publish Path

Enter a location on the RME server (file path with a valid file name), where an HTML version of the report will be saved. The file name that you specify may be a non-existent file in an existing folder or a new file in a new folder. Causer should have write permission to the given folder. The following message appears if an invalid file name is specified or the casuser is unable to create file in given folder:

Failed to create <filename>. Check directory permission for casuser and/or 
provide a valid file name.

Alternatively, to select a location, click Browse.

The Server Side File Browser dialog box appears.

In the Server Side File Browser dialog box:

a. Select the Directory Content.

b. Select the Drive. The location appears in the File field.

c. Click OK. The specified location appears in the Report Publish Path in the RME reports dialog box.


Step 6 Click Finish.

The specified report appears in a separate browser window.

Use Reset All to reset your selections for all groups. This resets all previous values to blanks.


In the generated report you can perform the following tasks:

Use the Export Current Report icon to export the generated report to a PDF or a comma separated values (CSV) format.

Use the Printer Friendly Format icon to generate a printer-friendly format for the displayed report.

Use the Export Device List to Device Selector icon to 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 or perform an action based on the report.

Sort the contents of any table, by clicking on the table heads.

Generating a 24 Hour Inventory Change Report

The 24-Hour Inventory Change Report shows the details of all inventory changes made during the last 24 hours. This report displays the changes in the values of the attributes of each device that has undergone a change in the last 24 hours, with the time stamp.

To view changes made beyond the last 24 hours, use the Change Audit application, which displays all application changes.

To refer to the 24-Hour Inventory Change Report regularly, you should schedule inventory collection to run every 24 hours. For details on scheduling inventory collection see "Creating and Editing an Inventory Collection or Polling Job".

To generate the report, see "Generating Inventory Reports".

The 24-Hour Inventory Change Report displays:

The following device details:

Total number of submitted device(s)

No. of device(s) with data

Device(s) with change

Information about the following:

Attribute

Type of Change

Time Change Detected

Previous Value

Current Value

Generating a Hardware Report

You can generate a report to display detailed hardware information for your selected devices. The Hardware Report includes user-specified information for each device. This user-specified information will be displayed only when it is available.

To generate the report, see "Generating Inventory Reports".

This report displays:

The following information about hardware characteristics:

Total number of devices

Devices with inventory data

Devices without inventory data

Details of hardware information including system, processor, chassis information, based on the Cisco MetaData Framework (MDF) categories of devices, with a separate table for each device category.

Each table displays the hardware information obtained by polling the class-specific MIB objects on the devices.

The flash size that appears in the Hardware Report is the total of the flash sizes of all the flash devices on that particular device.

For example, if you have a Catalyst 4503 device that contains flash devices such as Boot Flash (61000000 bytes), Slot0 Compact Flash (128000000 bytes), and Cat4000 Private Flash (500000 bytes), the Hardware Report for this Catalyst device will display the total of all the flash devices. That is, the sum of the Boot Flash, Slot0 Compact Flash, and Cat4000 Private Flash (189500000 bytes).

You can also use Custom Reports (see "Using Inventory Custom Report Templates") to generate more specific information, such as RAM size, flash size, port count, hardware version, or card type.

From within the report, you can access any table in the report using the Go to Device category drop-down list. This list displays all the device categories in the generated report.

For more information about a device in the report, click on the device name or IP address. You will be directed to Device Center. (For details about Device Center, see the CiscoWorks Common Services Online Help or User Guide).

Generating a Software Report

You can display software information including system information, image information and processor details for selected devices. User-specified information is also displayed in this report, when it is available.

The report contains a different table for each device category based on the Cisco MetaData Framework (MDF) categorization. Each table summarizes the software information obtained by polling the class-specific MIB objects on the devices.

To generate the report, see "Generating Inventory Reports".

From within the report, you can access any table in the report using the Go to Device category drop-down list. This list displays all the device categories in the generated report.

For more information about a device in the report, click on the device name or IP address. You will be directed to Device Center. (For details about Device Center, see the CiscoWorks Common Services Online Help or User Guide.)

Generating a Detailed Device Report

You can display complete inventory information for selected devices.

The Detailed Device report displays detailed hardware, software characteristics, characteristics including System, Port Interface, Bridge, Memory Pool, Flash Devices, Image, and physical containment information, such as Stack, Chassis, Module, Processor information, for one or more selected devices.

Device information is obtained by polling the class-specific MIB objects on the devices that you select. You can view interface administrative status and slot details for some device classes.

The information shown in this report is based on:

Physical inventory information (all physical components on the device containment like Stack, Back Plane, Chassis, module, Power Supplies, Fan, Processor).

Flash and Memory information.

Logical Inventory Information (logical aspects such as Interfaces, Bridge Interface, Application Information).

System Information (RFC 1213 system information).

Asset Information (information on Asset Tracking).


Note Some data is not displayed, if you have not yet run inventory collection.


To generate the report, see "Generating Inventory Reports".

Click on a device name to see details for that device.

From within the report, you can access any table in the report using the Go to Device category drop-down list. This list displays all the device categories in the generated report.

Generating a Chassis Slot Summary

For each device category that supports capacity planning, the Chassis Slot Summary shows the total number of devices and the number of devices with free slots.

You can click on a link to display Chassis Slot Details for those devices, for example, all devices with free slots.

You can display the number of available slots for the following device classes:

Cisco Catalyst Switch

Cisco Router

Cisco Aironet

Cisco LS1010 Switch

Cisco Catalyst L2L3 Switch

The report also displays a summary of the devices submitted for the report, the number of devices that are without data, and the devices that do not support capacity planning.

To generate the report, see "Generating Inventory Reports".

Generating Chassis Slot Details

The Chassis Slot Details report is for those devices that support Chassis capacity. The report displays the number of free slots or the available capacity for the selected devices.

The devices that support capacity planning include Catalyst Switch, L2L3 Switch, and Router.

To generate the report, see "Generating Inventory Reports".

This report displays the device name, the total slots, the available slots, location of the device, and userfield information for each device, based on the Cisco MetaData Framework (MDF) categorization.

The report also displays a summary of the devices submitted for the report, the number of devices that are without data and the devices that do not support capacity planning.

Click on a device name to go to Device Center. (For details about Device Center, see the CiscoWorks Common Services Online Help or User Guide).

Generating MultiService Port Details

You can display information about multiservice ports on selected switches. Multiservice ports are specially designed to supply inline power while supporting voice traffic.

This report displays devices and the number of free slots, and multi-service ports available. The report displays information such as device name, domain name, total slots, available slots, location, power supply, multi-service port modules, module port count, powered port count, and user-defined fields.

This report is applicable for modular devices such as Catalyst 4000, Catalyst 6000.

If you want your system to support voice traffic, use this report to determine:

Whether your switch has empty slots into which you can install multiservice modules (Available Slots).

Whether you have to upgrade your power supply wattage to support the multiservice modules installed in your switch (Power Supply and Multiservice Modules).

Whether any multiservice modules require submodule installation (Module Port Count vs. Powered Port Count).

How many ports are ready to provide in-line power (Powered Port Count).

To generate the report, see "Generating Inventory Reports".

Click on a device name to go to Device Center. (For details about Device Center, see the CiscoWorks Common Services Online Help or User Guide).

The information in the MultiService Port Details report is updated during the regular inventory collection. You can manually update:

User Fields with Change Device Credentials.

The Location field with the CLI as described in the device's configuration guide.

Generating a Hardware Summary Graph

You can display a pie graph showing the distribution of all managed Cisco devices in the inventory. The graph plots the percentage count of devices, based on the Cisco MetaData Framework (MDF) categorization of devices (Level 2 categorization).

Each section represents the device category, the device count and percentage of the total devices.

To generate the report, see "Generating Inventory Reports". After Step 4, click Finish. The Hardware Summary Graph appears. You cannot schedule the generation of this graph.

This graph displays:

The device category and the percentage of distribution in the network.

The Count. You can click on Count to view the Hardware Report for that device category (see "Generating a Hardware Report".)

The hardware summary, which identifies each section of the graph.

Generating a Software Version Graph

You can generate a pie graph to show the distribution of major and minor Cisco software versions running on the devices in a network. The graph plots the percentage count of selected devices from Inventory, based on the Cisco MetaData Framework (MDF) categorization of devices.

To generate the report, see "Generating Inventory Reports".

After Step 4, click Finish. The Software Version Graph appears. You cannot schedule the generation of this graph.

This graph displays:

The Software Version and the percentage.

The Count. You can click on Count to view the Software Report for that device category (see "Generating a Software Report".)

The software version summary, which identified each section of the graph.

Generating a Chassis Summary Graph

You can generate a pie graph to show the distribution of all Cisco devices in the inventory. The graph plots the percentage count of devices, based on the Cisco MetaData Framework (MDF) categorization of devices (Level 2 and Level 3 categorization).

You can click on any to view a hardware report. "Generating a Hardware Report".

To generate the report, see "Generating Inventory Reports". After Step 4, click Finish. The Chassis Summary Graph appears. You cannot schedule the generation of this graph.

The Chassis Summary Graph displays information about the devices categories, their percentage and the count. You can click on Count to view the Hardware Report for that device category (see "Generating a Hardware Report".)

Using Inventory Custom Report Templates

The Custom Templates option lets you create new report templates customized according to your requirements. You can also edit, or delete existing custom templates.

When you select Resource Manager Essentials > Reports > Custom Report Templates, a list of all custom templates is displayed in the dialog box on the Custom Templates page.

The columns in the custom templates dialog box are:

Column
Description

Template Name

Name of the template. If you click on this hyperlink, the details of the template are displayed in a pop-up window.

Report Type

Syslog report, or inventory report.

Owner

The user who created the template.

Last Modified Time

The date (yyyy-mm-dd) and the time (hh:mm:ss).


Using the custom templates dialog box, you can do the following tasks:

Task
Button

Create a custom template (see "Creating a Custom Report Template").

Create

Modifying a custom template (see "Modifying a Custom Template").

Modify

Delete a custom template (see "Deleting a Custom Template").

Delete



Note View the Permission Report (Common Services > Server > Reports) to check whether you have the required privileges to perform these tasks.


Creating a Custom Report Template

You can create a custom report template for Inventory.


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


To create a custom report template:


Step 1 Select Resource Manager Essentials > Reports > Custom Report Templates.

The Custom Templates dialog box appears.

Step 2 Click Create.

The Application Selection dialog box appears.

Step 3 Select Inventory.

Step 4 Click Next.

The Template Properties dialog box appears.

Step 5 Enter a unique name for the custom report template, in the Report Name field.

This is a mandatory field. You can use the character set for the template names including A to Z, a to z, 0 to 9, -, _, ., ), (, / and blank spaces. The report name should not exceed 60 characters.

Step 6 Specify whether you want the template to available for Public access, or Private access.

Templates that you specify as Public can be seen and generated by other users who are authorized to view this page. Private templates can be seen and generated by only the owner/creator of the templates.

Step 7 Click Next.

The Custom Template Rules dialog box appears.

Step 8 Use the Custom Template Rules dialog box, to:

Add a rule (see "Adding a Rule").

Modify a rule (see "Modifying a Rule").

Delete a rule (see "Deleting a Rule").

The Custom Template Rules dialog box has these buttons:

Add—Adds a rule to the custom template (see "Adding a Rule").

Modify—Modifies an existing rule (see "Modifying a Rule").

Delete—Deletes a rule (see "Deleting a Rule"). You can select one or more rules for deletion.

Cancel—Cancels your changes. Click Cancel to clear your selections in all the drop-down lists.

Clears selection of the rule if any rule selected.

Step 9 Click Next.

The Custom Template Summary window appears, with the summary information about the rules that you have created.

A sample summary is as follows:

Report Name:  FlashDeviceModel
Access Type:  Private
Template Rules:  Flash Device:Model Name:equals:All

Step 10 Click Finish.

A confirmation message appears, that the report template has been created successfully.

The custom template that you created appears in the Custom Templates dialog box.


Adding a Rule

To add a rule:


Step 1 In the Custom Template Rules dialog box, select information in the following fields:

Field
Description

Association

Select an association.

If you are adding a rule for the first time, this drop-down list does not display any values. After you have added a rule and need to add another rule, this drop-down list has the values AND and OR.

Inventory Group

Select the Inventory Group for which you are creating the rule. For details see "Inventory Groups and Attributes".

Attribute

Select an attribute. The attributes that are available in the drop-down list are based on the Inventory group that you selected.

For example, if you select flash device as the Inventory group, the Attributes available for selection are:

Flash Device Size (MB)

Model Name

For details see "Inventory Groups and Attributes".

Operator

Select the operator.

Value

Select the value. For example, ALL.

By default ALL will be populated along with editable drop down item. (The editable drop-down item is the blank one. You can enter your value in it.)

For specific attributes such as VendorType, MemoryType etc., the drop down is be pre-populated when you select the corresponding attributes.

For other remaining attributes ALL and Editable (blank field) will be present in the Value drop-down list. You can either select a value from this drop-down list or enter the value by selecting editable list item.


The following are the Inventory Groups and Attributes:

Table 6-3 Inventory Groups and Attributes 

Report Inventory Group
Custom Report Group/Attribute
Description
Asset

CLE Identifier

CLE identifier of the asset

Orderable Part Number

Orderable part number of the asset.

User-defined Identifier

User-defined identifier of the asset

Chassis

Chassis Model Name

Name of the model.

Chassis Serial Number

Serial number of the chassis.

Chassis Vendor Type

Type of vendor for the chassis.

Chassis Version

Version number of the chassis.

Number of Slots

Number of slots in that chassis.

Port Count

Total port count of the chassis.

Flash Device

Flash Device Size (MB)

Total flash device size in MB.

Model Name

Model name of the flash device.

Flash File

Path Name

Location of flash file.

Size (MB)

Flash file size in MB.

Flash Partition

Erase Needed

Whether an erase is needed.

Free (KB)

Free space in KB.

Name

Flash partition name.

Size (MB)

Flash partition size in MB.

Image

Image Version

Version of the software image on the device.

ROM Sys Version

ROM system software version.

ROM Version

Version of ROM.

Sys Description

Image system description.

Interface

Name

Interface name.

Type

Interface type.

IP Address

IP Address

IP Address of the device.

Subnet Mask

Subnet mask.

Memory

Size (MB)

Total RAM size.

Memory Pool

Free (MB)

Free memory in MB

Name

Name of the memory pool.

Used (MB)

Used memory in MB.

Type

Memory pool type.

Module

HW Version

Module hardware version.

Model Name

Name of the model.

Port Count

Total ports on that module.

Serial Number

Serial number of the module.

Vendor Type

Type of vendor for the module.

Processor

Model Name

Name of the model.

NV RAM Size (KB)

Size of the processor NVRAM in KB.

NV RAM Used (KB)

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

PortCount

Total port count of the processor

RAM Size (MB)

Size of the processor RAM in MB.

Serial Number

Serial number of the processor.

Vendor Type

Type of vendor for the processor.

System

Contact

Contact details for the system.

Description

Description of the system.

Domain Name

Domain name of the system.

Location

System location.

Name

System name.

System Object ID

System Object ID of the device.

User-defined Serial No.

User-defined serial number.

UDF

For example:

User_defined_field_0

User_defined_field_1

User_defined_field_2

All User-defined fields defined in Devices and Credentials Repository (DCR) are displayed here.


Step 2 Click Add to save the rule.

The rule that you created, appears in the Rules List section. You can add more than one rule.

To understand how RME evaluates rules, see "Understanding Template Rules Evaluation".


Modifying a Rule

To modify a rule:


Step 1 Select the required rule from the Rules List section of the Custom Template Rules dialog box.

The values that you had selected previously for this rule, appear in their respective fields.

Step 2 Change these values as required.

Step 3 Click Modify.

The rule is modified.


Deleting a Rule

To delete a rule:


Step 1 Select the required rule from the Rule List section of the Custom Template Rules dialog box. You can select one or more rules for deletion.

Step 2 Click Delete.

A message appears prompting you to confirm the deletion. If you confirm the deletion, the rule is deleted.


Modifying a Custom Template

You can modify a custom report template.


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


To modify a custom template:


Step 1 Select Resource Manager Essentials > Reports > Custom Report Templates.

The custom templates dialog box appears with a list of custom templates.

Step 2 Select the required custom template from the list, and click Modify.

The Template Properties dialog box appears. It is prepopulated with your selected template properties.

Step 3 Click Next.

The Custom Templates Rules dialog box appears.

For the description of the columns in the Custom Reports Templates dialog box, see "Creating a Custom Report Template".

If required, you can modify the template by:

Adding a Rule

Modifying a Rule

Deleting a Rule

Step 4 Click Next.

The Custom Template Summary window appears, with the summary information about the rules that you have created.

Step 5 Click Finish.

A confirmation message appears, that the report template has been created successfully.

The modified custom template appears in the custom templates dialog box.


Deleting a Custom Template

You can delete a custom report template for Inventory.

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


Note If you delete a template, any job created with the template will fail.


To delete a custom report template:


Step 1 Select Resource Manager Essentials > Reports > Custom Report Templates.

The custom templates dialog box appears with a list of custom templates.

Step 2 Select the required custom template. You can select one or more custom templates to delete.

Step 3 Click Delete.

A message appears prompting you to confirm the deletion. If you confirm the deletion, the template is deleted. It ceases to appear in the Inventory custom report template dialog box.


Understanding Template Rules Evaluation

This section helps you understand how the template rules are evaluated by RME:

Rules are evaluated from 1to n (left to right).

The rules with AND operators will be evaluated first and then the OR operator will be applied on the AND operator results.

If a template has rules a, b, c and d and the are given as a AND b OR c AND d, this set of will be evaluated as (a AND b) OR (c AND d).

If you want to just see the data for a set of attributes, you can:

Choose the group and attribute without any operator and value.

or

Choose the group and attribute with any operator and value the should be ALL. The association string can be either AND or OR.

This is only when there is no criteria for any of the rule, and you want to view the data for a set of attributes.


Note Since bracketization is not supported for rules, you should define the template rules intelligently after understanding the evaluation mechanisms (see "Understanding Template Rules Evaluation").
Also, if you want to order the rules, then you need to delete the existing rules and add them again required, or redefine the template, that is, delete and create it anew.


Running a Custom Report

You can run any custom report that you previously created. When you run the report, Inventory uses the criteria you specified when you created the report (see "Using Inventory Custom Report Templates") and displays information on the devices that match.


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

The RME Reports dialog box appears, in the Report Generator page.

Step 2 Select Inventory, from the first drop-down list.

Step 3 Select the required custom report from the second drop-down list. (Custom reports that you created appear in the drop-down list box with a separator).

The Device Selector appears, along with the fields that allow you to enter information in the Scheduling and Job Info fields.

Step 4 Select the required devices using the Device Selector. (See the topic, "Using RME Device Selector" in the section "Adding and Troubleshooting Devices Using Device Management", for more details.)

Step 5 Enter the information required to generate the required custom report, in the Scheduling and Job Info groups. For the field descriptions, see "Generating Inventory Reports"

The custom report appears. See "Custom Report Output".


Custom Report Output

A custom report will be generated only if at least one device satisfies the criteria specified in the template. If none of the criteria that you have specified are met, an appropriate message appears to inform you of this.

In the generated report, the legend N/A (Not Applicable) is displayed in the report cells in these cases:

If that attribute is not collected.

If the criterion is not applicable to that device.

If that attribute is user-defined, and has not been configured. (For example, User-defined fields, User-defined Serial Number, etc.).

If a template has a rule with ALL as the criteria, it means, that all the values of this attribute appear for the submitted devices.

If a template rule has no operator, then the values will be assumed as they are with ALL.

The Summary section of the custom reports displays the following information:

Number of devices selected—Number of devices that you have submitted for report generation.

Number of devices that do not match criteria—Number of devices not meeting the specified template criteria or rules.

Number of devices that do not have inventory collected data—Number of devices for which inventory is not collected.

For example, if n number of devices were submitted, x devices have inventory collected data and y have no inventory collected data. m number of devices do not satisfy criteria. This means, this number is out of n, irrespective of y. The number of devices that do not satisfy criteria comes out of the number of devices that were submitted for collection, irrespective of the number of devices for which no inventory was collected.

You can sort on the columns of the report by clicking on the column title.

Examples of Custom Template Definitions

This section contains examples of template definition and the expected output.

Template Definition Example 1

Template Definition Example 2

Template Definition Example 3

Template Definition Example 4

Template Definition Example 5

Template Definition Example 6

Template Definition Example 7

Template Definition Example 8

Template Definition Example 9

Template Definition Example 10

Template Definition Example 11

Template Definition Example 12


Note If any of the selected devices do not satisfy the criteria that you have specified, a message appears: None of the selected devices match the specified criteria.


Template Definition Example 1

If you create the rule IPAddress:IPAddress:contains:1, in the custom report output, you will get all the IP address of devices which contains 1 as part of the IP Address.

Template Definition Example 2

If the you want to see the device chassis, vendor type, port count of module and processor whose chassis vendor type is xyz and module port count > 0 or Processor port count > 0, the template definition is:

Chassis:VendofType:equals:xyz
AND:Module:PortCount:>:0
OR:Chassis:VendofType:equals:xyz
AND:Processor:PortCount:>:0

In general mathematical notation, if you want to get the result of A AND (B OR C) where A, B and C are the rules, you need to define as A AND B OR A AND C. RME looks at treats this as (A AND B) OR (A AND C).

The default evaluation by RME is that be all rule blocks associated with AND are evaluated first and then in the next step of evaluation OR is applied on the resultant blocks. That is, all rules with the association string AND are clubbed together and evaluated.

Template Definition Example 3

If you want to get details of the IP Addresses of devices which contain 10.36 or whose devices Memory Type is I/O, then the template definition is:

TemplateDef: IPAddress:IPAddress:contains:10.36
OR:Memory:Type:equals:I/O

The custom report is generated with all the IP Addresses and Memory Types for the devices having IP Address 10.36 or whose memory type is I/O.

Template Definition Example 4

If you want to get details of the image versions devices which contain 1 and want to know their flash size, then the template definition is:

Image:Image Version:contains:1 
AND:Flash File:Size (MB)

The custom report is generated with the Flash File size and the image version of all the devices whose image version contains 1.

Template Definition Example 5

If your template definition has the following rules:

Image:Image Version:contains:1 
OR:Flash File:Size (MB)

This custom report is generated with the FlashFile size and Image version of all selected devices. The OR condition without criteria means all flash device sizes.

Template Definition Example 6

If your template definition is the following:

Interface:Type:equals:gigabitEthernet 
OR:Interface:Type:contains:voiceFXS

This custom report is generated with Interface types of the devices which have interfaces of type gigabitEthernet or voiceFXS.

Template Definition Example 7

If your template definition has the following rules:

UDF:user_defined_field_2:contains:xyz 
OR:Flash Device:Total Flash Device Size (MB):>:45

This custom report is generated with user_defined_field_2 and Total Flash Device Size (MB) for the devices whose Total Flash Device Size is greater than 45MB or whose user_defined_field_2 value contains string xyz.

Template Definition Example 8

If your template definition has the following rules:

Chassis:Port Count 
AND:IP Address:IP Address 
AND:Processor:NVRAM Used (KB) 
AND:Processor:Port Count 
AND:Processor:RAM Size (MB) 
AND:System:Description 
AND:Interface:Type 
OR:UDF:user_defined_field_2 
AND:Flash Partition:Free (KB)

This custom report is generated for all given attributes for the selected devices. If any attribute is not collected from the device or if the attribute is not applicable for any device "N/A" will be displayed in the report.

Template Definition Example 9

If your template definition has the following rules:

Memory:Type:equals:Processor Memory 
AND:Memory:Type:equals:I/O

This custom report is generated for the devices which have both Processor memory and I/O memory.

Template Definition Example 10

If your template definition has the following rules

Memory:Type:equals:Processor Memory 
AND:Memory:Type:equals:I/O Memory 
OR:Memory:Type:equals:Other 
AND:Memory:Type:equals:Processor Memory
AND:Memory:Size

This custom report is displayed for memory types and memory size of the devices which have either Processor Memory & I/O Memory or Other and Processor Memory.

Template Definition Example 11

If you want to see memory size of the devices located in Bangalore, Chennai and San Jose, the template can be defined as followed.

System:Location:equals:Banglore
or:System:Location:equals:Chennai
or:System:Location:equals:SJ
AND:Memroy:Size(MB):equals:ALL

Template Definition Example 12

If your template definition has the following rules:

UDF:user_defined_field_0:contains:xyz 
AND:UDF:user_defined_field_3

The custom report is generated for user_defined_field_0 and user_defined_field_3 for devices whose user_defined_field_0 contains string xyz.

For information on cwcli invreport command, see the cwcli section: Using cwcli Commands, topic: Using the cwcli inventory Command

Using Device Center for Inventory Tasks

The CiscoWorks Common Services Device Center provides a "device-centric" view for CiscoWorks applications and offers you device-centric features and information from one single location.

To access Device Center:


Step 1 From the CiscoWorks Homepage, select Device Troubleshooting > Device Center.

The Device Center window appears with the device selector on the right and Device Center overview information on the left section of the screen.

Step 2 Enter the IP address or device name of the device you want to select and click Go in the Device Selector field

Or

Step 3 Select a device from the list-tree.

The Device Summary and Functions Available panes appear in the right section of the screen.

Step 4 Click any of the links under the Functions Available pane to launch the corresponding application function. The links are launched in a separate window.


Note If you enter the device name or IP address of a device not managed by any of the applications installed on the Common Services server, the Functions Available pane will display only the default connectivity tools from Common Services.


For Inventory application, you can:

Launch the Detailed Device Report:

In the Functions Available pane, select Reports > Detailed Device Report. For details of this reports, see "Generating a Detailed Device Report".

Update Inventory.

In the Functions Available pane, select Management Tasks > Update Inventory.

This message appears:

Successfully created job 1045 for updating inventory.  
Go to Resource Manager Essentials > Devices > Inventory > 
Inventory Jobs to see details.

For details of the Inventory Job Browser, see "Using the Inventory Job Browser".