Table Of Contents

Preface

New and Changed Information

Organization of This Guide

Conventions

Related Documentation

Obtaining Documentation and Submitting a Service Request

Preface

---

This guide describes how to administer Cisco Prime Network (Prime Network) using the Prime Network GUI client, utility scripts, and registry modifications.

This preface contains the following sections:

•New and Changed Information

•Organization of This Guide

•Conventions

•Related Documentation

•Obtaining Documentation and Submitting a Service Request

New and Changed Information

The following table describes information that has been added or changed since this guide was first published.

Date Released	Revision	Location
March 25, 2013	Creating proxy for devices behind firewalls—Resolved CSCuf49036 and CSCuf54352. Corrected procedure for connecting to devices when there is a firewall between a GUI client and a managed device.	Manage Configurations with Firewalls (Device Proxy)
March 5, 2013	VNEs in maintenance mode—Resolved CSCue51561. Corrected description of maintenance mode to say that when a VNE is in maintenance state, it does not process traps and syslogs. Also clarified that maintenance VNEs do passively participate in correlation flows.	Table 4-3 in Check VNE Communication State (Connectivity)
	Integrity tests—Resolved CSCud92376. Added the jobSchedulerPruning test.	Table 8-4 in How the Data Purging Mechanism Works
	Unit redundancy—Resolved CSCue38276. Clarified that units can only be specified as standby or active during the Prime Network installation process. Removed erroneous text that said standby units were not displayed in the GUI client (they are displayed).	Overview of Unit and Process Protection
	VNE Inventory option—Resolved CSCue41515. Added text that explains what is shown when user right-clicks VNE and chooses Inventory versus Properties.	Check Device Discovery, VNE Status, and VNE States
March 5, 2013 (continued)	Device prerequisites:
	•Resolved CSCue51335—Added procedure for configuring login sequence for CPT devices on CPT VNEs.	Cisco Carrier Packet Transport Devices—Required Settings
	•Resolved CSCue82126—Added details about prerequisites for adding UCS VNEs and included an overview of the procedure for UCS VNEs.	Cisco Unified Computing System Devices—Required Settings
	•Resolved CSCud16392—Added a missing SNMPv3 command that configured the write community on a device. If not set, Change and Configuration Management would not be able to back up the device's configuration.	SNMP Traps and Informs—Required Device Settings
	Event Collector—Resolved CSCue73373. Fixed syntax errors in procedure for configuring multiple Event Collectors (erroneously used XIDIP on non-Event Collector examples).	Configuring and Enabling Multiple Event Collectors
	Reduced Polling—Resolved CSCue82130. Fixed procedure for enabling the fail-safe option; the command for adding the registry key was missing.	Enable the Reduced Polling Fail-safe Option
January 24, 2013	Adaptive polling—Resolved CSCud98871. Fixed figure that illustrates the adaptive polling mechanism. It was missing the indicator for when a VNE reverts from slow polling back to normal polling. Also fixed text that said a VNE was moved to CPU-only polling after consecutive Maintenance Tolerance polls. (See section for clarification.)	Figure 12-5, and Adaptive Polling
	Data purging—Resolved CSCud89536. Corrected name of workflow engine integrity test.	Table 8-4
	Protection groups—Resolved CSCud31099. Clarified that if one unit in a protection group has a database connection, the other units must also have a database connection.	Create a New Unit Protection Group
	Device prerequisites—Resolved CSCue21401. Added prerequisites for Cisco Unified Computing System (UCS) devices.	Cisco Unified Computing System Devices—Required Settings
November 2012	Initial release.	—

Organization of This Guide

Chapter/ Appendix	Title	Description
1	Set Up Prime Network and Its Components	Lists the major setup tasks you should perform after installing the product, such as setting up fault management, system redundancy, data purging schedules, and so forth.
2	Manage the Prime Network Software Image and Backups	Managing and updating the base software image and licenses, backing up and restoring data, and adding new NE support by downloading and installing new Device Packages.
3	Manage the Prime Network Components: Gateway, Units, and AVMs	Introduces you to the system architecture: Gateways, units, AVMs, and VNEs, including describing the reserved AVMs used by the system. Explains how to check the current properties of components and how to stop and restart them. Also provides procedures for making gateway-level changes such as disabling automatic restarts, controlling client connections, working with firewalls, and so forth.
4	Configure VNEs and Troubleshoot VNE Problems	Guides you through the different methods for adding VNEs. Explains how to manage VNEs, including checking and troubleshooting problems with the communication and investigation states. Also explains how to add new VNE support, and change VNE properties such as its IP address.
5	Manage Redundancy for Units and Processes	Describes unit and process (AVM) protection and redundancy, how to configure AVM redundancy and unit protection groups, and how to change these settings. (For information on gateway high availability, see the Cisco Prime Network 3.10 Gateway High Availability Guide.)
6	Control Device Access Using Device Scopes	Explains the device scope mechanism and how you can use it to control device access, including creating new scopes, moving devices in and out of scopes, and deleting scopes.
7	Manage User Accounts	Explains how Prime Network authenticates and authorizes users, how to configure global password rules, control user access to maps, and create, change, and delete user accounts.
8	Manage the Database and System Data	Provides an overview of the Prime Network database and schemas, including the various types of data that is saved, when data is archived and deleted, and the various checks to protect system stability, including the Automatic Overload Prevention feature. It also provides procedures for working with an embedded database.
9	Control Event Monitoring	Explains how Prime Network handles incoming events. It provides best practices for configuring event listening (the Event Collector) on your system, and explains how to set up and forward trap and e-mail notifications.
10	Manage Workflows, Command Scripts, and Activations	Explains what workflows and activations are, how to get information on existing workflows and activations and checking their history, and aborting and deleting workflows.
11	System Security	Explains the security mechanism used by Prime Network to ensure the security of all communication within and to and from the system. Also explains how to use an external authentication server for user authentication, how to change system-wide passwords, and how to unlock frozen user accounts and set system-wide authorization controls for various features.
12	Perform Advanced VNE Configurations	Describes the polling mechanisms used by Prime Network and how to adjust these settings. Also provides advanced procedures for controlling when a device should be considered unreachable, configuring special collectors and command priorities, and how to stagger VNE Telnet/SSH logins. Also explains how to create a cloud VNE to traverse unmanaged network segments.
A	Device Configuration Tasks for Modeling	Provides a list of device configuration commands you should perform on devices to ensure Prime Network can properly communicate with, model, and monitor the device. Also explains the VNE scheme mechanism and which scheme to apply to a VNE, depending on your network.
B	Prime Network Log Files	Lists the log files created by the system.
C	Manage the Prime Network Registry	Provides a brief introduction to the Prime Network registry and explains how to use the runRegTool command to make registry changes.
D	VNE Properties Reference	Lists all of the properties supported for VNEs, from simple properties such as name and IP address, to the various protocols used by VNEs: SNMP, Telnet/SSH, HTTP, TL1, ICMP.

Conventions

This document uses the following conventions:

Convention	Indication
bold font	Commands and keywords and user-entered text appear in bold font.
italic font	Document titles, new or emphasized terms, and arguments for which you supply values are in italic font.
[ ]	Elements in square brackets are optional.
{x | y | z }	Required alternative keywords are grouped in braces and separated by vertical bars.
[ x | y | z ]	Optional alternative keywords are grouped in brackets and separated by vertical bars.
string	A nonquoted set of characters. Do not use quotation marks around the string, or the string will include the quotation marks.
courier font	Terminal sessions and information the system displays appear in courier font.
< >	Nonprinting characters such as passwords are in angle brackets.
[ ]	Default responses to system prompts are in square brackets.
!, #	An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line.

---

Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication.

---

---

Tip Means the following information will help you solve a problem.

---

---

Caution Means reader be careful. In this situation, you might perform an action that could result in equipment damage or loss of data.

---

Related Documentation

---

Note We sometimes update the documentation after original publication. Therefore, you should also review the documentation on Cisco.com for any updates.

---

For all the related documentation for Cisco Prime Network 3.10, see the Prime Network 3.10 Documentation Overview.

The Cisco Prime Network Technology Center is an online resource for additional downloadable Prime Network support content, including help for integration developers who use Prime Network application programming interfaces (APIs). The website provides information, guidance, and examples to help you integrate your applications with Prime Network. It also provides a platform for you to interact with subject matter experts. To view the information on the Prime Network Technology Center website, you must have a Cisco.com account with partner level access, or you must be a Prime Network licensee. You can access the Cisco Prime Network Technology Center at: http://developer.cisco.com/web/prime-network/home.

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS version 2.0.