Cisco Resource Manager Essentials User Manual
User Guide for
Resource Manager Essentials
Software Release 4.1
CiscoWorks
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
Text Part Number: OL-11714-01
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL
STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public
domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,
WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO
OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
CCVP, the Cisco logo, and the Cisco Square Bridge logo are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn is a service mark of
Cisco
Systems, Inc.; and Access Registrar, Aironet, BPX, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, Cisco, the Cisco Certified Internetwork Expert logo,
Cisco
IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step,
Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iPhone, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, iQuick Study,
LightStream, Linksys, MeetingPlace, MGX, Networking Academy, Network Registrar, Pa cke t, PIX, ProConnect, ScriptShare, SMARTnet, StackWise, The Fastest Way to
Increase Your Internet Quotient, and TransPath are registered trademarks of Cisco
All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a partnership relationship
between Cisco and any other company. (0705R)
User Guide for Resource Manager Essentials 4.1
Copyright © 1998-2007, Cisco Systems, Inc. All rights reserved.
Systems, Inc. and/or its affiliates in the United States and certain other countries.
IMPLIED, INCLUDING, WITHOUT
CONTENTS
Open Source License Acknowledgements xxv
Preface xxix
Audience xxxi
Conventions xxxi
Product Documentations xxxi
Related Documentation xxxiii
Obtaining Documentation, Obtaining Support, and Security Guidelines xxxiii
Overview of RME 1-1
RME Feature List 1-1
Home (Tab) 1-2
Device Management Status 1-3
Collection Status 1-3
Recently Completed Jobs 1-3
24 Hour Syslog Severity Summary 1-4
24 Hour Changes 1-4
System Tasks 1-4
Device Management Tasks 1-4
Reports 1-4
Management Tasks 1-5
OL-11714-01
Devices (Tab) 1-5
Inventory 1-5
Device Management 1-6
Group Administration 1-8
Config Mgmt (Tab) 1-8
Archive Management 1-8
Config Editor 1-10
NetConfig 1-11
Software Mgmt (Tab) 1-11
Job Mgmt (Tab) 1-13
Reports (Tab) 1-14
Tools (Tab) 1-15
Change Audit and Audit Trail 1-16
Syslog 1-17
User Guide for Resource Manager Essentials 4.1
iii
Contents
NetShow 1-18
Admin (Tab) 1-19
cwcli Framework 1-19
RME Device Center 1-20
RME Process and the Dependency Processes 1-23
Shortcut Links 1-24
What's New in this Release 2-1
New Features in RME 4.1 2-1
Adding and Troubleshooting Devices Using Device Management 3-1
Understanding the Device and Credentials Repository 3-3
Device Management Administration Settings 3-3
Automatic Addition of Device and Credential Repository Devices to RME 3-4
Verifying the Device Credentials While Adding Devices to RME 3-5
Using the RME Devices Window 3-6
Adding Devices to RME 3-7
Licensing Behavior While Adding Devices 3-8
Adding Devices to RME Manually 3-8
Editing Device Attributes While Adding Devices to RME 3-10
Adding Devices to RME Automatically 3-12
Editing RME Device Attributes 3-12
Attribute Error Report 3-16
RME Device Attributes Export File Format 3-16
Exporting RME Device Credentials 3-17
Deleting Devices from RME 3-18
Understanding the RME Device States 3-19
Working With Normal Devices 3-20
Exporting the Normal Devices Credentials 3-21
Suspending the Normal Devices 3-21
Deleting the Normal Devices 3-22
Resubmitting the Normal Devices 3-23
Generating the Inventory and Configuration Collection Status Report 3-23
iv
Working With Pending Devices 3-24
Working With Suspended Devices 3-25
Resubmitting the Suspended Devices 3-26
Deleting the Suspended Devices 3-27
Working With Pre-deployed Devices 3-27
Exporting the Pre-deployed Device Credentials 3-28
User Guide for Resource Manager Essentials 4.1
OL-11714-01
Suspending the Pre-deployed Devices 3-29
Deleting the Pre-deployed Devices 3-30
Resubmitting the Pre-deployed Devices 3-31
Diagnosing Pre-deployed Devices 3-31
Working With Alias Devices 3-36
Resolving an Alias Device 3-37
Working With Conflicting Device Types 3-38
Resolving the Conflicting Device Type 3-39
Deleting the Conflicting Device Type 3-40
Checking and Viewing Device Credentials 3-40
Generating Device Credentials Report 3-42
Credential Verification Report 3-42
Credential Error Report 3-44
Verifying Device Credentials 3-44
Viewing Job Details 3-45
Contents
Device List Manipulation Service 3-47
XML DTD for DLMS 3-48
Guidelines for Creating the XML File 3-48
Adding Devices to Device Credentials Using DLMS 3-49
Listing the Devices and Their Status Using DLMS 3-50
Getting the Device Credentials Data 3-52
Setting the Device Credentials Using DLMS 3-53
Getting the Device IP Address 3-57
Sample DLMS XML Request File 3-58
Sample Java and PERL Scripts to Invoke the Servlet 3-63
Device Manageability Status 3-67
Understanding Device Manageability Status Report 3-67
Using RME Device Selector 3-68
Using Simple Search 3-70
Using Advanced Search 3-71
Using Advanced Search—An Example 3-75
Using the All Tab 3-76
Using the Search Results Tab 3-78
Using the Selection Tab 3-78
Device Icons and Device Types 3-79
OL-11714-01
Managing RME Device Groups Using Group Administration 4-1
Using RME Group Administration 4-2
Creating a User-defined Group 4-3
User Guide for Resource Manager Essentials 4.1
v
Contents
Entering the Group Properties Details in Properties: Create Dialog Box 4-3
Defining the Group Rules in the Rules: Create Dialog Box 4-5
Assigning Group Membership in the Membership: Create Dialog Box 4-6
Understanding the Summary: Create Dialog Box 4-7
Editing a User-defined Group 4-8
Viewing Group Details 4-8
Viewing Membership Details 4-9
Refreshing Membership 4-10
Deleting Groups 4-10
Understanding the Grouping Rules 4-11
RME Group Administration Process 4-16
Understanding RME Device State Transition 5-1
RME 3.x Behavior 5-1
States in RME 4.x 5-2
State Transitions 5-3
Pending 5-3
Pre-deployed 5-4
Normal 5-4
Aliased 5-4
Suspended 5-4
Conflicting 5-4
RME 4.x Scenarios 5-5
Device Addition 5-5
Inventory Detailed Device Report 5-6
Configuration Deployment Using Config Editor 5-6
Configuration Changes Using NetConfig 5-7
Software Image Upgrade 5-8
Managing Inventory Collection and Polling Using Inventory 6-1
How to Use Inventory 6-1
Pre-requisites 6-2
Collecting and Updating Inventory Data 6-2
Viewing Reports and Graphs 6-3
vi
Using the Inventory Job Browser and Viewing Inventory Collection Status 6-4
Using the Inventory Job Browser 6-4
Viewing Job Details 6-7
Creating and Editing an Inventory Collection or Polling Job 6-8
Stopping, Cancelling or Deleting an Inventory Collection or Polling Job 6-10
User Guide for Resource Manager Essentials 4.1
OL-11714-01
Viewing Inventory Collection Status 6-10
Inventory Administrative Operations 6-11
Setting Change Report Filters 6-12
Changing the Schedule for System Inventory Collection or Polling 6-22
Cisco.com Fetch Interval 6-23
Generating Inventory Reports 6-24
Generating a 24 Hour Inventory Change Report 6-28
Generating a Hardware Report 6-29
Generating a Software Report 6-29
Generating a Detailed Device Report 6-30
Generating a Chassis Slot Summary 6-31
Generating Chassis Slot Details 6-31
Generating MultiService Port Details 6-31
Generating a Hardware Summary Graph 6-32
Generating a Software Version Graph 6-32
Generating a Chassis Summary Graph 6-33
Generating a PSIRT Summary Report 6-33
Generating End of Sale/End of Life Report 6-35
Contents
Using Inventory Custom Report Templates 6-38
Creating a Custom Report Template 6-38
Adding a Rule 6-40
Modifying a Rule 6-42
Deleting a Rule 6-43
Modifying a Custom Template 6-43
Deleting a Custom Template 6-44
Understanding Template Rules Evaluation 6-44
Running a Custom Report 6-45
Custom Report Output 6-45
Examples of Custom Template Definitions 6-47
Template Definition Example 1 6-48
Template Definition Example 2 6-48
Template Definition Example 3 6-48
Template Definition Example 4 6-48
Template Definition Example 5 6-48
Template Definition Example 6 6-49
Template Definition Example 7 6-49
Template Definition Example 8 6-49
Template Definition Example 9 6-49
Template Definition Example 10 6-50
OL-11714-01
User Guide for Resource Manager Essentials 4.1
vii
Contents
Template Definition Example 11 6-50
Template Definition Example 12 6-50
Using Device Center for Inventory Tasks 6-50
Generating Reports 7-1
Using the Reports Job Browser 7-1
Using the Reports Generator 7-4
Defining Custom Report Templates 7-5
Creating a Custom Report Template 7-6
Editing a Custom Report Template 7-6
Deleting a Custom Report Template 7-6
Viewing Archived Reports 7-7
Purging Reports Jobs and Archived Reports 7-8
Setting the Reports Archive Default Directory 7-10
Archiving Configurations and Managing Them Using Archive Management 8-1
Performing Archive Management Tasks 8-1
Performing Archive Management Administrative Tasks 8-3
Performing Configuration Management Administrative Tasks 8-3
Preparing to Use the Archive Management 8-4
Entering Device Credentials 8-4
Modifying Device Configurations 8-5
Enabling rcp 8-5
Enabling scp 8-5
Enabling https 8-6
Configuring Devices to Send Syslogs 8-6
Modifying Device Security 8-7
Router Commands 8-7
Switches Commands 8-7
Content Networking—Content Service Switch Commands 8-8
Content Networking—Content Engine Commands 8-8
Cisco Interfaces and Modules—Network Analysis Modules 8-8
Security and VPN—PIX Devices 8-8
viii
Using Job Approval for Archive Management 8-9
Configuring Transport Protocols 8-9
Requirements to Use the Supported Protocols 8-10
Supported Protocols for Configuration Management Applications 8-13
Defining the Protocol Order 8-13
Configuring Default Job Policies 8-14
User Guide for Resource Manager Essentials 4.1
OL-11714-01
Defining the Default Job Policies 8-14
Usage Scenarios When Job Password is Configured on Devices 8-17
Setting Up Archive Management 8-20
Moving the Configuration Archive Directory 8-20
Enabling and Disabling the Shadow Directory 8-21
Configuring Exclude Commands 8-22
Configuring Fetch Settings 8-23
Understanding Configuration Retrieval and Archival 8-24
Timestamps of Configuration Files 8-25
How Running Configuration is Archived 8-25
Change Audit Logging 8-26
Defining the Configuration Collection Settings 8-26
Purging Configurations from the Configuration Archive 8-29
Checking Configuration Archival Status 8-31
Configuration Archival Reports 8-32
Successful Devices Report 8-32
Failed Devices Report 8-33
Partially Successful Devices Report 8-33
Contents
Scheduling Sync Archive Job 8-34
Generating an Out-of-Sync Report 8-36
Scheduling Sync on Device Job 8-37
Using the Configuration Version Tree 8-39
Understanding the Config Viewer Window 8-40
Viewing the Configuration Version Summary 8-42
Configuration Quick Deploy 8-44
Performing a Configuration Quick Deploy 8-44
Configuring Labels 8-46
Creating a Label 8-47
Editing a Labeled Configuration 8-48
Viewing the Labeled Configuration 8-49
Deleting the Labeled Configuration 8-50
Using Search Archive 8-50
Creating a Custom Query 8-51
Running a Custom Query 8-52
Editing a Custom Query 8-53
Deleting the Custom Queries 8-53
Searching Archive 8-54
Search Archive Result 8-55
OL-11714-01
User Guide for Resource Manager Essentials 4.1
ix
Contents
Device Configuration Quick View Report 8-56
Comparing Configuration 8-59
Comparing Startup vs. Running Configurations 8-59
Comparing Running vs. Latest Archived Configurations 8-60
Comparing Two Configuration Versions of the Same Device 8-60
Compare Two Configuration Versions of Different Devices 8-61
Understanding the Config Diff Viewer Window 8-63
Using Archive Management Job Browser 8-65
Retrying a Config Job 8-68
Stopping a Config Job 8-70
Deleting the Config Jobs 8-71
Viewing the Archive Management Job Details 8-72
Baseline Template 8-73
Baseline Templates Window 8-76
Creating a Baseline Template 8-77
Creating a Basic Baseline Template 8-77
Creating an Advanced Baseline Template 8-78
Creating an Advanced Baseline Template— Example 8-82
Editing a Baseline Template 8-86
Exporting a Baseline Template 8-87
Importing a Baseline Template 8-87
Deleting a Baseline Template 8-88
Deploying a Baseline Template 8-88
Deploying a Baseline Template Using User Interface 8-89
Deploying a Baseline Template Using File System 8-92
Using Baseline Jobs 8-95
Running Compliance Check 8-96
Understanding the Baseline Compliance Report 8-98
Deploying the Commands 8-99
Deleting the Compliance Jobs 8-103
Making and Deploying Configuration Changes Using NetConfig 9-1
NetConfig Tasks 9-1
Preparing to Use NetConfig 9-2
Verifying Device Credentials 9-2
Modifying Device Security 9-3
Verifying Device Prompts 9-3
Configuring Default Job Policies 9-3
Assigning Task Access Privileges to Users 9-4
User Guide for Resource Manager Essentials 4.1
x
OL-11714-01
Enabling Job Approval 9-4
Rolling Back Configuration Changes 9-4
Creating Rollback Commands 9-4
Configuring a Job to Roll Back on Failure 9-4
Understanding NetConfig User Permissions 9-5
Job Approval Permissions 9-5
User-defined Tasks Permissions 9-5
Administrator Task Permissions 9-5
Job Editing Permissions 9-5
Using the NetConfig Tab 9-6
Starting a New NetConfig Job 9-6
Browsing and Editing Jobs Using the NetConfig Job Browser 9-11
Viewing Job Details 9-15
Setting Job Approvers 9-18
Contents
Configuring Default NetConfig Job Policies 9-18
Password Policy for NetConfig Jobs 9-18
Setting the Transport Protocol Order for NetConfig Jobs 9-18
Creating and Editing User-defined Tasks 9-18
Parameterized Templates 9-22
Assigning Tasks to Users 9-25
Handling Interactive Commands 9-26
Using NetConfig User-defined Templates and Adhoc Tasks 9-26
Handling Multi-line Commands 9-27
Using System-defined Tasks 9-27
Understanding the System-defined Task User Interface (Dialog Box) 9-30
Adhoc Task 9-32
Authentication Proxy Task 9-33
Banner Task 9-34
CDP Task 9-35
Certification Authority Task 9-37
Crypto Map Task 9-38
DNS Task 9-40
Enable Password Task 9-41
HTTP Server Task 9-43
Local Username Task 9-44
IGMP Configuration Task 9-47
Interface IP Address Configuration Task 9-49
Internet Key Exchange (IKE) Configuration Task 9-50
OL-11714-01
User Guide for Resource Manager Essentials 4.1
xi
Contents
NTP Server Configuration Task 9-52
RADIUS Server Configuration Task 9-53
RCP Configuration Task 9-56
Reload Task 9-57
SNMP Community Configuration Task 9-58
SNMP Security Configuration Task 9-60
SNMP Traps Configuration Task 9-62
Syslog Task 9-67
SSH Configuration Task 9-70
TACACS Configuration Task 9-72
TACACS+ Configuration Task 9-73
Telnet Password Configuration Task 9-75
Transform System-Defined Task 9-76
Web User Task 9-77
Use-defined Protocol Task 9-78
Cable BPI/BPI+ Task 9-79
Cable DHCP-GiAddr and Helper Task 9-80
Cable Downstream Task 9-82
Cable Upstream Task 9-84
Cable Interface Bundling Task 9-87
Cable Spectrum Management Task 9-88
Cable Trap Source Task 9-90
cwcli netconfig 9-91
Editing and Deploying Configurations Using Config Editor 10-1
Config Editor Tasks 10-1
Benefits of Configuration Editor 10-2
Setting Up Preferences 10-7
Overview: Editing a Configuration File 10-8
Working With the Configuration Editor 10-8
Processed Mode 10-9
Raw Mode 10-9
Editing Configuration Files by Handling Interactive Commands in Config Editor Jobs 10-10
Modifying Credentials 10-11
Removing a Configuration File 10-12
Saving a Configuration File 10-12
Undoing All 10-13
Replacing All 10-14
Printing a Configuration File 10-15
xii
User Guide for Resource Manager Essentials 4.1
OL-11714-01
Exporting Changes of a Configuration File 10-15
Deploying a Configuration File 10-16
Closing a Configuration File 10-18
Selecting Configuration Tools 10-18
Comparing Versions of Configuration Files 10-19
Displaying Your Changes 10-20
Overview: Syntax Checker 10-21
Interface to External Syntax Checker 10-21
Registering an External Syntax Checker Application With CMIC 10-22
Viewing the List of Modified Configs 10-23
Overview: Opening a Configuration File 10-24
Opening a Configuration File - By Device and Version 10-24
Opening a Configuration File - By Pattern Search 10-25
Opening a Configuration File - By Baseline 10-27
Baseline Configuration Editor 10-28
Contents
Opening an External Configuration File 10-28
What Happens During Configuration Deployment in Overwrite and Merge Modes 10-30
Overview: Downloading a Configuration File 10-30
Starting a New Download Job 10-31
Selecting Configs 10-31
Scheduling a Job 10-32
Configuring Job Policies for Config Editor 10-36
Reviewing the Work Order 10-38
Viewing the Status of all Deployed Jobs 10-39
Using NetShow Commands 11-1
Working With NetShow Jobs 11-2
Viewing the Permission Report 11-2
NetShow Job Browser 11-3
Viewing Job Details 11-5
Masking Credentials 11-7
Creating Jobs 11-7
Editing Jobs 11-10
Copying Jobs 11-13
Stopping Jobs 11-13
Retrying Jobs 11-14
Deleting Jobs 11-14
OL-11714-01
User Guide for Resource Manager Essentials 4.1
xiii
Contents
Archiving NetShow Job Output 11-15
Viewing and Analyzing NetShow Output 11-15
Deleting Output Archive 11-17
Command Sets 11-17
System-Defined Command Sets 11-18
Managing Command Sets 11-19
Viewing Command Set Details 11-19
Creating a New Command Set 11-19
Editing Command Sets 11-20
Deleting Command Sets 11-21
Adding and Deleting Adhoc Commands 11-22
Assigning Command Sets 11-22
Showing Assigned Command Sets 11-23
Assigning Command Sets to Users 11-23
Assigning Custom Command Execution Privilege 11-23
Launching show Commands From Device Center 11-24
Using cwcli netshow Command 11-26
Administering NetShow Settings 11-26
Configuring Job Policies 11-27
Defining Default Job Policies 11-27
Purging Jobs 11-28
Defining Protocol Order 11-29
Setting Log Levels 11-30
Assigning Approval Lists 11-31
Setting Up Job Approval 11-31
Generating a Standard Audit Trail Report 11-32
Managing Software Images Using Software Management 12-1
Setting Up Your Environment 12-3
Requirements on CiscoWorks Server 12-3
Logging Into Cisco.com 12-4
Using Job Approval for Software Management 12-6
Software Management Administration Tasks 12-6
Viewing/Editing Preferences 12-7
Selecting and Ordering Protocol Order 12-10
How Recommendation Filters Work for an IOS Image 12-11
Updating Upgrade Information 12-13
xiv
Software Repository 12-15
Software Repository Synchronization 12-16
User Guide for Resource Manager Essentials 4.1
OL-11714-01
Scheduling a Synchronization Report 12-17
Viewing a Synchronization Report 12-18
Removing a Synchronization Report Job 12-18
Adding Images to the Software Repository 12-19
Adding Images to the Software Repository From Cisco.com 12-19
Adding Images to the Software Repository From Devices 12-22
Adding Images to the Software Repository From a File System 12-25
Adding Images to the Software Repository From a URL 12-26
Adding Images to the Software Repository From the Network 12-28
Synchronizing Software Image Status With Cisco.com 12-31
Deleting Images From the Software Repository 12-32
Exporting of Images from Software Repository 12-32
Searching for Images From the Software Repository 12-33
Software Image Attributes 12-33
Understanding Software Image Attributes 12-34
Understanding Default Attribute Values 12-34
Finding Missing Attribute Information 12-35
Editing and Viewing the Image Attributes 12-35
Contents
Software Distribution 12-36
Upgrade Analysis 12-37
Planning an Upgrade From Cisco.com 12-37
Planning an Upgrade From Repository 12-38
Understanding the Upgrade Analysis Report 12-39
Software Distribution Methods 12-41
Planning the Upgrade 12-42
Identifying Possible Changes 12-42
Satisfying the Prerequisites 12-42
Maintaining Your Software Image Repository 12-43
Testing the New Images 12-43
Configuring Devices for Upgrades 12-44
Meeting Minimum Device Requirements 12-44
Meeting Additional Device Requirements 12-44
Additional SFB Checks 12-45
Configuring Telnet and SSH Access 12-45
Configuring SCP 12-47
Configuring rcp 12-47
Configuring TFTP 12-51
Configuring HTTP 12-53
Meeting Microcode and Modem Firmware Requirements 12-53
Scheduling the Upgrade 12-53
OL-11714-01
User Guide for Resource Manager Essentials 4.1
xv
Contents
Authorizing a Distribution Job 12-54
Distributing by Devices [Basic] 12-55
Distributing by Devices [Advanced] 12-59
Distributing by Images 12-64
Support for IOS Software Modularity 12-68
Patch Distribution 12-69
Patch Distribution - by Devices 12-70
Patch Distribution - by Patch 12-73
Remote Staging and Distribution 12-76
Understanding Upgrade Recommendations 12-83
Upgrade Recommendation for Cisco IOS Devices 12-84
Upgrade Recommendation for Catalyst Devices 12-84
Upgrade Recommendation for VPN 3000 Series 12-85
Upgrade Recommendation for Catalyst 1900/2820 12-85
Upgrade Recommendation for Other Device Types 12-86
Using Software Management Job Browser 12-86
Changing the Schedule of a Job 12-88
Retry a Failed Distribution Job 12-88
Undo a Successful Distribution Job 12-89
Stopping a Job 12-90
Deleting Jobs 12-91
Understanding the Software Management Job Summary 12-91
Understanding User-supplied Scripts 12-92
Locating Software Management Files 12-95
Tracking Network Changes Using Change Audit 13-1
How Does it Differ From Syslog? 13-1
Performing Change Audit Tasks 13-2
Performing Maintenance Tasks 13-3
Setting the Purge Policy 13-3
Performing a Forced Purge 13-4
Config Change Filter 13-6
Defining Exception Periods 13-6
Creating an Exception Period 13-7
Enabling and Disabling an Exception Period 13-7
Editing an Exception Period 13-8
Deleting an Exception Period 13-8
xvi
Defining Automated Actions 13-8
Understanding the Automated Action Window 13-9
User Guide for Resource Manager Essentials 4.1
OL-11714-01
Creating an Automated Action 13-9
Editing an Automated Action 13-11
Enabling and Disabling an Automated Action 13-12
Exporting and Importing an Automated Action 13-12
Deleting an Automated Action 13-13
Using Change Audit Reports 13-13
Generating an Exception Period Report 13-14
Generating 24 Hours and Standard Change Audit Reports 13-16
Understanding Change Audit Report 13-19
ChangeAudit Process 13-20
Stopping and Restarting the Change Audit Process 13-21
Enabling and Tracking Syslogs Using Syslog Analyzer and Collector 14-1
Overview: Common Syslog Collector 14-4
Viewing Status and Subscribing to a Common Syslog Collector 14-5
Viewing Common Syslog Collector Status 14-5
Subscribing to a Common Syslog Collector 14-6
Understanding the Syslog Collector Properties File 14-7
Timezone List Used By Syslog Collector 14-10
Contents
Using Syslog Analyzer 14-10
Using Syslog Service on Windows 14-11
Checking the Syslog Configuration File on UNIX 14-12
Stopping and Restarting Syslog Analyzer 14-12
Viewing Syslog Analyzer Status 14-13
Configuring Devices to Send Syslogs 14-13
Configuring the Device Using Telnet 14-14
Configuring the Device Using NetConfig Syslog Task 14-16
Syslog Administrative Tasks 14-18
Setting the Backup Policy 14-19
Setting the Purge Policy 14-20
Performing a Forced Purge 14-21
Defining Custom Report Templates 14-22
Creating a Custom Report Template 14-23
Adding a Message Type 14-24
Deleting a Message Type 14-25
Editing a Message Type 14-25
Selecting a Message Type 14-26
Editing a Custom Template 14-26
Deleting a Custom Template 14-26
OL-11714-01
User Guide for Resource Manager Essentials 4.1
xvii
Contents
Running a Custom Report 14-27
Defining Automated Actions 14-29
Creating an Automated Action 14-30
`Editing an Automated Action 14-32
Guidelines for Writing Automated Script 14-34
Enabling or Disabling an Automated Action 14-34
Exporting or Importing an Automated Action 14-35
Deleting an Automated Action 14-35
Automated Action: An Example 14-36
Verifying the Automated Action 14-37
Defining Message Filters 14-38
Creating a Filter 14-38
Editing a Filter 14-39
Enabling or Disabling a Filter 14-40
Exporting or Importing a Filter 14-40
Deleting a Filter 14-41
Overview: Syslog Analyzer Reports 14-41
Understanding Message Reports 14-44
Generating a 24-Hour Report 14-45
Generating a Syslog Custom Summary Report 14-45
Generating a Severity Level Summary Report 14-45
Generating a Standard Report 14-46
Generating an Unexpected Device Report 14-47
Using Device Center 14-48
Creating a Custom Report: Example 14-48
Prerequisites 14-48
Procedures 14-48
Verification 14-50
Tracking RME Server Changes Using Audit Trail 15-1
Audit Trail Record 15-1
Generating a Standard Audit Trail Report 15-5
Understanding the Audit Trail Report 15-6
Performing Maintenance Tasks 15-7
Setting the Purge Policy 15-7
Performing a Forced Purge 15-8
xviii
Checking Bug Status Using Bug Toolkit 16-1
Bug Summary Report 16-1
User Guide for Resource Manager Essentials 4.1
OL-11714-01
Logging Into Cisco.com 16-3
Understanding the Bug Summary Report 16-3
Locate Device Report 16-4
Understanding the Locate Device Report 16-7
Working With SmartCase 17-1
Launching Cisco.com Service Request Tool 17-1
Working With Contract Connection 18-1
Accessing and Using Contract Connection 18-1
Getting Device Type Summary Report and Contract Status Detailed Report 18-2
Device Type Summary Report 18-2
Contract Status Detailed Report 18-4
Scheduling Jobs 18-6
Viewing Job Status 18-7
Contents
Archiving and Viewing Generated Reports 18-8
CLI Utilities 19-1
CWCLI 19-1
Overview: CLI Framework (cwcli) 19-2
cwcli Global Arguments 19-2
Remote Access 19-4
Overview: cwcli config Command 19-7
Using the cwcli config Command for Batch Processing 19-7
Getting Started With cwcli config 19-7
Uses of cwcli config 19-8
Remote Access 19-10
Running cwcli config 19-10
cwcli config Command Parameters 19-11
Parameters For All cwcli config Commands 19-11
cwcli config Syntax Examples 19-14
cwcli config Core Arguments 19-17
Examples of cwcli config 19-18
cwcli config Command Man Page 19-18
Arguments 19-19
cwcli config Subcommand Man Pages 19-23
Overview: cwcli netconfig Command 19-30
cwcli netconfig Remote Access 19-39
Overview: cwcli export Command 19-40
Using the cwcli export Command 19-41
OL-11714-01
User Guide for Resource Manager Essentials 4.1
xix
Contents
Running cwcli export changeaudit 19-45
Running cwcli export config 19-55
Running cwcli export inventory Command 19-59
XML Schema for cwcli export inventory Data 19-60
Overview: cwcli inventory Command 19-74
Using the cwcli inventory Command 19-76
Running the cwcli inventory cda Command 19-78
Running the cwcli inventory crmexport Command 19-86
Running the cwcli inventory deletedevice Command 19-89
Running the cwcli inventory getdevicestate Command 19-91
Overview: cwcli invreport Command 19-93
Overview: cwcli netshow Command 19-98
Running cwcli netshow Command 19-99
Executing Netshow CLI Remotely 19-104
Performance Tuning Tool 19-105
PTT Features 19-105
Profiles and PTT 19-105
Default Profile 19-106
Perftune - Windows and Perftune - Solaris 19-106
PTT Commands 19-107
.syslogConf.pl Utility 19-108
Software Management CLI Utility 19-110
Running cwcli swim Command 19-110
Executing SWIM CLI Remotely 19-113
Enabling Approval and Approving Jobs Using Job Approval 20-1
Job Approval Workflow 20-2
Specifying Approver Details 20-2
Creating and Editing Approver Lists 20-3
Assigning Approver Lists 20-4
Setting Up Job Approval 20-4
Approving and Rejecting Jobs 20-5
Job Management 20-8
RME Job Browser 20-8
Setting System-wide Parameters Using System Preferences 21-1
Application Log Level Settings 21-1
Job Purge 21-3
Scheduling a Purge Job 21-4
xx
User Guide for Resource Manager Essentials 4.1
OL-11714-01
Enabling a Purge Job 21-5
Disabling a Purge Job 21-6
Performing an Immediate Purge 21-6
RME Device Attributes 21-7
RME Secondary Credentials 21-8
Collection Failure Notification 21-9
Configuring Trap Notification Messages 21-10
Examples for Collection Failure Notification 21-10
Fields in a Trap Notification Message 21-11
RME Troubleshooting Tips and FAQs A-1
Device Management A-1
Inventory A-5
Inventory Reports A-15
Archive Management A-21
Contents
NetConfig A-28
Config Editor A-30
Software Management A-32
Syslog Analyzer and Collector A-91
Job Approval A-97
Bug Toolkit A-99
cwcli config A-101
cwcli export A-103
NetShow A-105
Administration A-111
Contract Connection A-112
Understanding Syslog Formats B-1
RME Command Reference C-1
Managing Devices When RME Server is Within a NAT Boundary D-1
Configuring RME Server for the NAT Environment D-1
Managing Devices Outside the NAT Boundary D-1
I
NDEX
OL-11714-01
User Guide for Resource Manager Essentials 4.1
xxi
Contents
xxii
User Guide for Resource Manager Essentials 4.1
OL-11714-01
Open Source License Acknowledgements
The following acknowledgements pertain to this software license.
OpenSSL/Open SSL Project
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit
(
http://www.openssl.org/).
This product includes cryptographic software written by Eric Young (eay@cryptsoft.com).
This product includes software written by Tim Hudson (tjh@cryptsoft.com).
License Issues
The OpenSSL toolkit stays under a dual license, i.e. both the conditions of the OpenSSL License and the
original SSLeay license apply to the toolkit. See below for the actual license texts. Actually both licenses
are BSD-style Open Source licenses. In case of any license issues related to OpenSSL please contact
openssl-core@openssl.org.
OpenSSL License:
© 1998-1999 The OpenSSL Project. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided
that the following conditions are met:
1. Redistributions of source code must retain the copyright notice, this list of conditions and the
following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and
the following disclaimer in the documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software must display the following
acknowledgment: “This product includes software developed by the OpenSSL Project for use in the
OpenSSL Toolkit. (
4. The names “OpenSSL Toolkit” and “OpenSSL Project” must not be used to endorse or promote
products derived from this software without prior written permission. For written permission, please
contact openssl-core@openssl.org.
5. Products derived from this software may not be called “OpenSSL” nor may “OpenSSL” appear in
their names without prior written permission of the OpenSSL Project.
http://www.openssl.org/)”
OL-11714-01
User Guide for Resource Manager Essentials 4.1
xxv
Open Source License Acknowledgements
6. Redistributions of any form whatsoever must retain the following acknowledgment:
“This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit
(
http://www.openssl.org/)”
THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT “AS IS”' AND ANY EXPRESSED OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
NO EVENT SHALL THE OpenSSL PROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.
This product includes cryptographic software written by Eric Young (eay@cryptsoft.com). This product
includes software written by Tim Hudson (tjh@cryptsoft.com).
Original SSLeay License:
© 1995-1998 Eric Young (eay@cryptsoft.com). All rights reserved.
This package is an SSL implementation written by Eric Young (eay@cryptsoft.com).
The implementation was written so as to conform with Netscapes SSL.
This library is free for commercial and non-commercial use as long as the following conditions are
adhered to. The following conditions apply to all code found in this distribution, be it the RC4, RSA,
lhash, DES, etc., code; not just the SSL code. The SSL documentation included with this distribution is
covered by the same copyright terms except that the holder is Tim Hudson (tjh@cryptsoft.com).
Copyright remains Eric Young’s, and as such any Copyright notices in the code are not to be removed.
If this package is used in a product, Eric Young should be given attribution as the author of the parts of
the library used. This can be in the form of a textual message at program startup or in documentation
(online or textual) provided with the package.
Redistribution and use in source and binary forms, with or without modification, are permitted provided
that the following conditions are met:
1. Redistributions of source code must retain the copyright notice, this list of conditions and the
following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
the following disclaimer in the documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software must display the following
acknowledgement:
“This product includes cryptographic software written by Eric Young (eay@cryptsoft.com)”.
The word ‘cryptographic’ can be left out if the routines from the library being used are not
cryptography-related.
4. If you include any Windows specific code (or a derivative thereof) from the apps directory
(application code) you must include an acknowledgement: “This product includes software written
by Tim Hudson (tjh@cryptsoft.com)”.
xxvi
THIS SOFTWARE IS PROVIDED BY ERIC YOUNG “AS IS” AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
User Guide for Resource Manager Essentials 4.1
OL-11714-01
Open Source License Acknowledgements
EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The license and distribution terms for any publicly available version or derivative of this code cannot be
changed. i.e. this code cannot simply be copied and put under another distribution license [including the
GNU Public License].
OL-11714-01
User Guide for Resource Manager Essentials 4.1
xxvii
Open Source License Acknowledgements
xxviii
User Guide for Resource Manager Essentials 4.1
OL-11714-01
Preface
This document describes the applications that make up Resource Manager Essentials (RME). It provides
instructions for configuring, administering, and operating RME.
The Resource Manager Essentials User Guide is organized as follows:
Chapter Description
Chapter 1, “Overview of RME” Gives you an overview of RME.
Chapter 2, “What's New in this
Release”
Chapter 3, “Adding and
Troubleshooting Devices Using
Device Management”
Chapter 4, “Managing RME
Device Groups Using Group
Administration”
Chapter 5, “Understanding RME
Device State Transition”
Chapter 6, “Managing Inventory
Collection and Polling Using
Inventory”
Chapter 7, “Generating Reports” Gives you an overview of the reports framework in RME.
Chapter 8, “Archiving
Configurations and Managing
Them Using Archive
Management”
Chapter 9, “Making and
Deploying Configuration
Changes Using NetConfig”
Chapter 10, “Editing and
Deploying Configurations Using
Config Editor”
Provides you with the list of launch points for the various tasks that you can perform with
the various RME applications. You can also review the new features provide for this
release.
Describes how RME manages devices. Device Management uses the device credentials
that are present in Common Services Device and Credentials database.
RME allows you to select devices from Device and Credentials database to manage in
RME.
Describes how you can group RME devices. RME allows you to define several groups of
devices based on a set of criteria and manage the same.
Describes how device states are transitioned in RME.
Describes how to use the Inventory application. 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.
Describes how to use the Configuration Management application.
Configuration Management gives you easy access to the configuration files for all files or
Cisco IOS-based Catalyst switches, Content Service Switches, Content Engines, and Cisco
routers in your RME inventory.
Describes how to use the NetConfig application.
NetConfig allows you to make configuration changes to your managed network devices
whose configurations are archived in the Configuration Archive.
Describes how to use the Config Editor application.
Config Editor you to edit a configuration file that exists in the configuration archive.
OL-11714-01
User Guide for Resource Manager Essentials 4.1
xxix
Preface
Chapter Description
Chapter 11, “Using NetShow
Commands”
Chapter 12, “Managing
Software Images Using Software
Management”
Chapter 13, “Tracking Network
Changes Using Change Audit”
Chapter 14, “Enabling and
Tracking Syslogs Using Syslog
Analyzer and Collector”
Chapter 15, “Tracking RME
Server Changes Using Audit
Trail”
Chapter 16, “Checking Bug
Status Using Bug Toolkit”
Chapter 17, “Working With
SmartCase”
Chapter 18, “Working With
Contract Connection”
Chapter 19, “CLI Utilities” Describes how to use Command Line Utilities like cwcli, PTT, syslogConf.pl and Software
Chapter 20, “Enabling Approval
and Approving Jobs Using Job
Approval”
Appendix A, “RME
Troubleshooting Tips and FAQs”
Appendix B, “Understanding
Syslog Formats”
Appendix C, “RME Command
Reference”
Appendix D, “Managing
Devices When RME Server is
Within a NAT Boundary”
Describes how to use the NetShow application.
NetShow enables you to define show commands within Command Sets and run these
commands
Describes how to use the Software Management application.
To ensure rapid, reliable software upgrades, Software Management automates many steps
associated with upgrade planning, scheduling, downloading, and monitoring.
Describes how to use the Change Audit application.
Change Audit tracks and reports changes made in the network. It allows other RME
applications to log change information to a central repository.
Describes how to use the Syslog application.
Syslog lets you centrally log and track system error messages, exceptions, and other
information (such as device configuration changes).
Describes how to use the Audit Trail application.
Audit Trail tracks and reports changes that the RME administrator makes on the RME
server.
Describes how to use the Bug Toolkit application.
Bug Toolkit helps you identify the bugs filed against devices in their network and check
the status of the bugs.
Describes how to use the SmartCase application.
SmartCase enables you to access Cisco.com from Resource Manager Essentials (RME) to
open a Cisco.com case, or to query and update an existing case.
Describes how to use the Cisco Contract Connection application.
Contract Connection lets you verify which of your Cisco devices are covered by a service
contract.
Management CLI.
Describes how job approval can be enabled and used.
Describes the troubleshooting tips for all the RME applications.
Describes the two file formats supported in RME—Comma-Separated Values (CSV) File
and XML Schemas.
Provides a list of the RME commands.
Describes Network Address Translation (NAT) support in Resource Manager Essentials
and provides details of the tasks you need to perform to enable support.
xxx
User Guide for Resource Manager Essentials 4.1
OL-11714-01
Preface
Audience
This document provides descriptions and scenarios for system administrators, network managers, and
other users who might or might not be familiar with RME. Many of the tools described are accessible to
system administrators only.
Conventions
This document uses the following conventions:
Item Convention
Commands and keywords boldface font
Variables for which you supply values italic font
Displayed session and system information
Information you enter
Variables you enter
Menu items and button names boldface font
Selecting a menu item in paragraphs Option > Network Preferences
Selecting a menu item in tables Option > Network Preferences
screen font
boldface screen font
italic screen font
Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the
publication.
Caution Means reader be careful. In this situation, you might do something that could result in equipment
damage or loss of data.
Product Documentations
The following product documentation is available:
Note Although every effort has been made to validate the accuracy of the information in the printed and
electronic documentation, you should also review the Resource Manager Essentials documentation on
Cisco.com for any updates.
Release Notes for Resource Manager Essentials
• Release Notes for Resource Manager Essentials on Solaris, Software Release 4.1.
• Release Notes for Resource Manager Essentials on Windows, Software Release 4.1.
OL-11714-01
User Guide for Resource Manager Essentials 4.1
xxxi
Preface
These documents are available in the following formats:
• PDF on the LMS 3.0 Documentation CD-ROM.
• On Cisco.com at
http://www.cisco.com/en/US/products/sw/cscowork/ps2073/prod_release_notes_list.html
User Guide for Resource Manager Essentials 4.1
This document is available in the following formats:
• PDF on the LMS 3.0 Documentation CD-ROM.
• From the Resource Manager Essentials online help.
• On Cisco.com at
http://www.cisco.com/en/US/products/sw/cscowork/ps2073/products_user_guide_list.html
Supported Devices Table
• Supported Devices for Resource Manager Essentials 4.1
• Supported Devices for Software Management Application
• Supported Devices for Configuration Management Application
These documents are available on Cisco.com at
http://www.cisco.com/en/US/products/sw/cscowork/ps2073/products_device_support_tables_list.html
Context-Sensitive Online Help for Resource Manager Essentials 4.1
You can access the online help by selecting an option from the navigation tree, then click Help (extreme
right corner of your browser window).
The entire User Guide can be viewed in the Adobe Portable Document Format (PDF) from within the
Online Help. To view the PDF, Adobe Acrobat 6.0 or later is required.
The RME device package support for RME is available at install time. You can access the device package
help from the Online help.
Step 1 Select an option from RME desktop and click Help.
The Help launches in a separate browser window.
Step 2 Click Main at the extreme right corner of the page.
The Help window is refreshed and you see these nodes in the left navigation pane:
• CiscoWorks Common Services
• Resource Manager Essentials
Step 3 Expand the Resource Manager Essentials node.
The following leaf and node appear in the left navigation pane:
• RME User Guide (leaf)
• Device Packages (node)
Step 4 Expand the Device Packages node to view the help for device packages.
xxxii
User Guide for Resource Manager Essentials 4.1
OL-11714-01
Loading...