Table Of Contents
Administering ITM
Ports and Protocols that ITM Uses
Security Considerations
Device Support
System Administration
Configuring Users
Creating Self-Signed Security Certificates Yearly
Backing Up and Restoring ITM Data
Changing the Password for ITM Databases
Configuring Logging
Viewing and Maintaining Log Files
Starting and Stopping ITM Processes
Using SNMP to Monitor ITM
Configuring Your System for SNMP Queries
Determining the Status of Windows SNMP Service
Installing and Uninstalling Windows SNMP Service
Enabling and Disabling Windows SNMP Service
Configuring Security for SNMP Queries
Viewing the System Application MIB Log File
Administering ITM
These topics are intended for system administrators who will perform administrative functions. The topics include:
•
Ports and Protocols that ITM Uses
•
Security Considerations
•
Device Support
•
System Administration
•
Using SNMP to Monitor ITM
Ports and Protocols that ITM Uses
ITM uses the following protocols:
•
SNMP
•
ICMP
•
TCP/IP
•
SMTP
•
RMI
•
HTTP
IP Telephony Monitor (ITM) and CiscoWorks use the TCP and UDP ports described in the following tables:
•
Table 19-1—ITM Incoming Ports
•
Table 19-2—CiscoWorks Common Services Incoming Ports
•
Table 19-3—CiscoWorks Common Services Outgoing Ports
•
Table 19-4—CiscoWorks Common Services Incoming and Outgoing Ports
Table 19-1 ITM Incoming Ports
Port Number
|
Usage
|
162
|
Default port number used by ITM for receiving traps
|
40000-41000
|
Used by Common Transport Mechanism for internal application messaging
|
42344
|
Used by Confidence Testing web service
|
42350-42353
|
Used by messaging software
|
9002
|
Used by the Broker to listen to both the IP telephony server and the device fault server
|
9009
|
Default port number used by the IP telephony server for receiving traps from the device fault server
|
Note
The list of database ports that ITM uses is included in Table 19-2.
Table 19-2 CiscoWorks Common Services Incoming Ports
Port Number/Type
|
Usage
|
42343/tcp
|
Jrun
|
57860/tcp
|
JRun Server Manager ControlServer - Used for Jrun Administration
|
42344/tcp
|
ANI HTTP server
|
1741/tcp
|
Used for CiscoWorks HTTP server
|
1742/tcp
|
Used when the webserver is running in SSL mode
|
43441-43459
|
Used as database ports:
• 43441—Used by CiscoWorks Common Services
• ITM uses the following ports:
– 43443—Used by phone monitoring database engine1
– 43445—Used by Fault History database engine
– 43446—Used by inventory service database engine
– 43447—Used by event processing database engine
– 43448—Used by confidence testing database engine
– 43449—Used by IP Phone Information Facility database engine2
– 43451—Used by drop-in application database engine
– 43459—Used by drop-in application database engine
|
Table 19-3 CiscoWorks Common Services Outgoing Ports
Port Number/Type
|
Usage
|
161/udp
|
Standard port for SNMP Polling
|
162/udp
|
Standard port for SNMP Traps
|
23/tcp
|
Standard port for Telnet
|
22/tcp
|
Standard port for SSH
|
Table 19-4 CiscoWorks Common Services Incoming and Outgoing Ports
Port Number/Type
|
Usage
|
42340/tcp
|
CiscoWorks Daemon Manager, the tool that manages server processes
|
42342/udp
|
Osagent
|
69/udp
|
Standard port for TFTP
|
1683
|
IIOP port for CiscoWorks gatekeeper
|
8088
|
HIOP port for CiscoWorks gatekeeper
|
514/tcp
|
RCP port
|
42351/tcp
|
Default port; alternate port: 44351/tcp (ESS1 Listening port)
|
42353/tcp
|
Default port; alternate port: 44353/tcp (ESS Routing port)
|
42350/udp
|
Default port; alternate port: 44350/udp (ESS Service port)
|
Security Considerations
Security for ITM files is based on the same standards used for CiscoWorks:
Caution 
Do not change the protection of any file or directory to be less restrictive. You may, if you wish, make the protections more restrictive.
•
File ownership and protection
All ITM files are installed with owner CASUSER. Only CASUSER can create, delete, or modify the files installed in NMSROOT.
Note
NMSROOT is the directory where CiscoWorks is installed on your system. If you selected the default directory during installation, it is C:\Program Files\CSCOpx.
Note
File protections are not enforced on FAT partitions.
Device Support
When support for new devices becomes available for ITM, Incremental Device Updates (IDUs) will be announced on the planner page for ITM on Cisco.com. Visit the planner page for announcements, downloads, and installation instructions for IDUs as they become available.
When a new IDU becomes available, you can download it from Cisco.com at http://www.cisco.com/cgi-bin/tablebuild.pl/item-3des. (You will be prompted to log into Cisco.com.)
System Administration
ITM system administration can be performed only by the following types of users:
•
Users in a System Administrator role. These users can perform system administration tasks that can be started from the CiscoWorks desktop. These tasks include:
–
Configuring users
–
Backing up and restoring data
–
Configuring logging
–
Starting and stopping CiscoWorks processes
•
Users who log in as local administrator to the system where ITM is installed. These users can view log files and configure Windows SNMP service on the system.
Configuring Users
This task can be performed only by a user logged in to ITM in the System Administrator role. To give users access to ITM, select Server > Configuration > Setup > Security and select either of the appropriate applications:
•
Add Users
•
Modify/Delete Users
When you add or modify a user, you specify the user's CiscoWorks user role. The user role determines the tasks the user can perform after logging in. There are a limited number of user roles from which to select; the online help for CiscoWorks supplies a general description of each of them.
Note
If you are using ITM Multi-View, there is a unique user role that is applicable only to ITM Multi-View. See the "Viewing Partition Membership Details" section.
To understand how each user role relates to tasks in ITM, select Server > Configuration > Setup > Security > Permissions Report and scroll down until you find IP Telephony Monitor.
Creating Self-Signed Security Certificates Yearly
When you install ITM, ITM creates a self-signed security certificate on the server. Users on some client systems must install the certificate; see the "Responding to Security Alerts" section. Self-signed security certificates expire one year from the date of creation.
Create a new self-signed security certificate yearly before the certificate expires. You can also do so after the certificate expires; however, users might not be able to access ITM until you complete this task.
Step 1
Select Server Configuration > Administration > Security Management > Create Self Signed Certificates. The Create Certificates page appears.
Step 2
Enter the values for the fields described in the following table.
Field
|
Description
|
Usage Notes
|
Country Name
|
Name of your country
|
Use two-character country code.
|
State or Province
|
Name of your state or province
|
Use two-character state or province code or complete name of state or province.
|
Locality
|
Name of your city or town
|
Use two-character city or town code or complete name of city or town.
|
Organization Name
|
Name of your organization
|
Use complete name or abbreviation for your organization.
|
Organization Unit Name
|
Name of department in your organization
|
Use complete name or abbreviation for your department.
|
Host Name
|
Name of server on which ITM is installed
|
Use the DNS name of the server.
Note Use the proper domain name, which should already be displayed in the Host Name field.
|
Email Address
|
Your e-mail address
|
|
Step 3
Click Submit. (Alternatively, click Restore to Default to clear all fields and re-enter information.)
Backing Up and Restoring ITM Data
This topic explains how to access the backup applications, such as Back Up Data Now and Schedule Backup. This topic also explains how to locate the online help procedures for restoring data.
Step 1
Select Server Configuration > Administration > Database Management. The Database Management folder opens.
Step 2
Click the Help button and follow the instructions for backing up and restoring data.
Database files are stored using the backup directory structure described in Table 19-5.
•
Format—/generation_number/suite/directory/filename
•
Example—/1/itemFh/database/itemFh.db
Table 19-5 ITM Backup Directory Structure
Option
|
Description
|
Usage Notes
|
generationNumber
|
Backup number
|
For example, 1, 2, and 3, with 3 being the latest database backup.
|
suite
|
Application, function, or module
|
When you perform a backup, data for all suites is backed up. The CiscoWorks server suite is cmf. The ITM application suites are:
• ama-Confidence testing
• dfm—Data collection and analysis for devices in IP infrastructure
• itemEpm—Event promulgation
• itemFh—Fault History
• itemInv—Device inventory
• pif—IP Phone Information Facility1
• vhm—Data collection and analysis for voice-enabled devices
|
directory
|
What is being stored
|
Each application or suite listed. Directories include database and any suite applications.
|
filename
|
File that has been backed up
|
Files include database (.db), log (.log), version (DbVersion.txt), manifest (.txt), tar (.tar), and data files (datafiles.txt).
|
Changing the Password for ITM Databases
Before You Begin
The procedure in this topic enables you to change the password for the following ITM databases:
•
ama—Confidence testing
•
itemEPM—Event promulgation
•
itemFH—Fault History
•
itemInv—Inventory
•
pif—IP Phone Information Facility
Note
You can change the password for the pif database using this procedure if you have installed IDU 2 or later. Prior to IDU 2, if the pif database is installed on your server, see the online help for IPIU.
Step 1
At the command prompt on the ITM server, stop the daemon manager by entering the following command:
Step 2
Change directory to NMSROOT\conf\itemDb\bin. For example:
cd Program Files\CSCOpx\conf\itemDb\bin
Note
NMSROOT is the folder where ITM is installed on the server. If you selected the default directory during installation, it is C:\Program Files\CSCOpx.
Step 3
Enter ChangeItemDbPasswd.pl, providing a new password as input. For example:
ChangeItemDbPasswd.pl newpassword
Step 4
Retstart the daemon manager by entering the following command:
Configuring Logging
ITM writes application log files for all major functional modules. By default, ITM writes only error and fatal messages to these log files.You cannot disable logging. However, you can:
•
Collect more data when needed by increasing the logging level
•
Return to the default logging level as the norm
This task can be performed by a user logged in to ITM in any of the following roles:
•
System Administrator
•
Network Administrator
•
Network Operator
Step 1
Select IP Telephony Monitor > Configuration > Logging. The Logging: Level Configuration page is displayed.
Note
You cannot disable logging. ITM will always write error and fatal messages to application log files.
Step 2
For each ITM functional module, the Error check box is always selected; you cannot deselect it.
To set all modules to Error, the default logging level:
a.
Click the Default button. A confirmation page is displayed.
b.
Click OK.
To change the logging level for individual modules:
a.
For each module that you want to change, select one (or deselect all) of the following logging levels:
•
Warning—Log error messages and warning messages
•
Informational—Log error, warning, and informational messages
•
Debug—Log error, warning, informational, and debug message
Note
Deselecting all check boxes for a module returns it to Error, the default logging level.
b.
Review your changes. To cancel your changes, click the Cancel button. Otherwise, click the Apply button. Clicking the Apply button starts immediately resetting the changed logging levels for the ITM functional modules.
For information about changing the logging level for the RME-ITM Change Probe on the RME server, see the "Viewing the RME-ITM Change Probe Log File" section.
Note
RME-ITM Change Probe is available only if you have downloaded and installed it and IDU 2 or later from the ITM download site: http://www.cisco.com/cgi-bin/tablebuild.pl/item-3des.
For information about changing the logging level for the system application MIB, see the "Viewing the System Application MIB Log File" section.
Note
Support for the host resources and system application MIBs is available on the server where ITM is installed only if you have downloaded and installed Incremental Device Update (IDU) 4 or later from the ITM download site: http://www.cisco.com/cgi-bin/tablebuild.pl/item-3des.
Viewing and Maintaining Log Files
Each ITM module writes log files to its own folder within the <NMSROOT>\log\itemLogs folder. Table 19-6 lists each ITM module, the name of the folder where the log files are stored, and the related log files.
Note
NMSROOT is the folder where ITM is installed on the server. If you selected the default directory during installation, it is C:\Program Files\CSCOpx.
When a log file reaches a preset maximum size, the module backs up the file and starts writing to a new log file. The maximum size for a log file varies by module. The maximum number of backed up log files that a module keeps also varies.
By default, ITM writes error messages only to log files. You can change the logging level and thereby affect the amount of information stored in log files. To do so, see the "Configuring Logging" section.
Table 19-6 ITM Log Files by Module
Function/Module
|
Folder in <NMSROOT>\log
|
Log Files
|
Alerts and Activities Display
|
\itemLogs\AAD
|
AAD.log
|
Application and Connectivity Poller
|
\itemLogs\VHM
|
Poller.log
|
Confidence Test Integrator
|
\itemLogs\VHM
|
VHMSTIntegrator.log
VHMSTIntegratorOperation.log
STIntegratorUI.log
|
Daily Purging Schedule
|
\itemLogs\DPS
|
DPS.log
|
Detailed Device View
|
\itemLogs\DDV
|
DDV.log
|
Device Fault Integrator
|
\itemLogs\VHM
|
VHMDfmIntegrator.log
|
Device Management
|
\itemLogs\tis
|
DeviceManagement.log
|
Event Processing Adapters
|
\itemLogs\epa
|
adapterServer.log
dfmEvents.log
vhmEvents.log
|
Event Promulgation Module
|
\itemLogs\EPM
|
EPM.log
|
Fault History
|
\itemLogs\FH
|
FHUI.log
FHCollector.log
|
IP Phone Information Facility1
|
\ipiu
|
ipiuapp.log
|
Inventory Collector
|
\itemLogs\VHM
|
InventoryCollector.log
CiscoCallManagerOrCluster Grouping.log
|
Inventory Interactor
|
\itemLogs\VHM
|
Interactor.log
|
Inventory Service
|
\itemLogs\tis
|
TISServer.log
|
Multi-View Manager
|
\itemLogs\PM
|
PM.log
PMClient.log
PMUtil.log
|
Notification Services
|
\itemLogs\NOS
|
nos.log
|
Phone Monitoring2
|
\itemLogs\VHM
|
VHMPhoneInventory.log
|
Phone Reachability3
|
\itemLogs\PR
|
phonereachability.log
|
Polling and Threshold Adapter
|
\itemLogs\VHM
|
PollingThresholdAdapter.log
|
Polling and Threshold Manager
|
\itemLogs\PTM
|
PTMServer.log
PTMClient.log
|
RME Synchronization3
|
\itemLogs\RMESync
|
RMESync.log
Note See also the "Viewing the RME-ITM Change Probe Log File" section.
|
Rediscovery Schedule
|
\itemLogs\Rediscovery
|
Rediscovery.log
|
SAA API library3
Note Adds IP SLA activities to the log files for Phone Reachability and SRST.
|
See Phone Reachability and SRST Monitoring.
|
See the entries for Phone Reachability and SRST Monitoring in this table.
|
SRST Monitoring3
|
\itemLogs\srst
|
srst_audit.log
srst_import.log
srst_import_errors.log
srst_server.log
srst_test_creation_results.log
srst_ui.log
|
View Group Management
|
\itemLogs\VGM
|
vgm.log
|

Note
The ITM application logging service also maintains log files under the following folder: <NMSROOT>\log\itemLogs.
Starting and Stopping ITM Processes
Note
You cannot stop or unregister a process if any process that depends on it is running. You must first stop or unregister all dependent processes, and then stop or unregister the process.
Step 1
Log in to ITM as a system administrator.
Step 2
Select Server Configuration > Administration > Process Management > Stop Process. The Stop Process page appears.
Note
If a process is not listed, it has not yet been started.
Step 3
In the Stop Process page, locate the process you want to stop in the Process list.
Step 4
Select the process you want to stop and click the Finish button.
Step 5
To restart the process, select Server Configuration > Administration > Process Management > Start Process. The Start Process page appears.
Step 6
In the Start Process page, locate the process you want to start in the Process list.
Step 7
Select the process you want to start and click the Finish button.
Table 19-7 provides a complete list of ITM-related CiscoWorks processes.
Table 19-7 ITM-Related CiscoWorks Processes
Name
|
Description
|
Dependency
|
AdapterServer
|
Event adapter takes events from backend servers.
|
None
|
AMADbEngine
|
Confidence Testing Database Engine—Repository for confidence tests and confidence test schedules.
|
None
|
AMADbMonitor
|
Confidence Testing database monitor.
|
AMADbEngine
|
DataPurge
|
Data Purge—Starts as scheduled in the GUI and purges the Fault History database.
|
jrm
|
DfmBroker
|
DFM Broker maintains a registry about VHM and DFM domain managers. A domain manager registers the following information with the broker when its initialization is complete:
• Application name of the domain manager
• Hostname where the domain manager is running
• TCP port at which the HTTP server is listening
When a client needs to connect to the domain manager, it first connects to the broker to determine the hostname and TCP port where that server's HTTP service is listening. It then disconnects from the broker and establishes a connection to the domain manager.
|
None
|
DfmServer
|
Infrastructure device domain manager, a program that provides backend services for ITM. Services include SNMP data retrieval and event analysis. The DfmServer log is NMSROOT/objects/smarts/logs/DFM.log.
|
DfmBroker
|
EPMDbEngine
|
Event Promulgation Module (EPM) database engine—Repository for the EPM module.
|
None
|
EPMDbMonitor
|
EPM database monitor.
|
EPMDbEngine
|
FHDbEngine
|
Fault History database engine—Repository for alerts and events.
|
None
|
FHDbMonitor
|
Fault History database monitor.
|
FHDbEngine
|
INVDbEngine
|
Inventory database engine—Repository for devices.
|
None
|
INVDbMonitor
|
Inventory database monitor.
|
INVDbEngine
|
IPIUDataServer1
|
IP Phone Information Facility server provides information about phones.
|
ESS
|
IPTFHServer
|
Fault History server stores alerts and events and retrieves them from the Fault History database.
|
FHDbMonitor, FHDbEngine, EPMDbEngine, EPMServer
|
ITMCTMStartup
|
ITM Common Transport Mechanism handles messaging among ITM components.
|
None
|
ITMMultiProcLogger
|
ITM Log Server provides the mechanism for different ITM functional modules, which are a part of different processes, to write to the same log file when necessary.
|
None
|
ITMOGSServer
|
ITM Object Grouping Service Server evaluates group membership.
|
CmfDbEngine, ESS
|
NOSServer
|
Notification Server monitors alerts and sends notifications based on subscriptions.
|
EPMDbEngine, EPMServer, INVDbEngine
|
PIFDbEngine1
|
IP Phone Information Facility database engine—Repository for phone data.
|
None
|
PIFServer1
|
Performs phone discovery.
|
PIFDbEngine, ESS
|
PMServer
|
Manages ITM partitions.
|
ESS
|
PTMServer
|
Polling and thresholds server.
|
ITMOGSServer
|
RmeSyncServer2
|
Adds and updates devices with information received from the ITM Adapter on RME.
|
TISServer
|
SRSTServer2
|
Configures and runs SRST tests.
|
PIFServer, PMServer, ESS, TISServer
|
STServer
|
Periodically runs confidence tests against Cisco CallManagers and provides real-time status updates to ITM.
|
AMADbEngine, ESS
|
TISServer
|
Inventory server.
|
INVDbEngine, ESS
|
VHMDFMIntegrator
|
Integrates event handling between infrastructure devices and voice devices.
|
VHMInventoryCollector, ESS
|
VHMInteractor
|
Provides inventory and device information to the Detailed Device View (DDV); updates the DDV with events.
|
VHMInventoryCollector, ESS
|
VHMInventoryCollector
|
Synchronizes voice device inventory with infrastructure device inventory. Handles all inventory events, such as adding and deleting devices.
|
ESS, TISServer, ITMOGSServer
|
VHMPoller
|
• Probes Digital Gateways and voice applications.
• Monitors connectivity between Cisco CallManager cluster and gateways and gatekeepers.
• Provides suspect phone monitoring and confidence test results monitoring.
|
VHMInventoryCollector
|
VHMServer
|
VHM domain manager; a VHM program that provides back-end services for VHM.
|
DfmBroker, VHMInventoryCollector
|
VHMSTIntegrator
|
Integrates the VHM server with the ST server. Receives confidence test messages from the ST server and generates events to the VHM server.
|
STServer, VHMInventoryCollector
|
DfmFileNotifier
|
Logs infrastructure device analysis results into ASCII files.
|
DfmServer
|
EPMServer
|
Sends events to notification services.
|
EPMDbEngine
|
FHPurgeTask
|
Fault History purge task.
|
None
|
Using SNMP to Monitor ITM
Note
Support for the host resources and system application MIBs is available on the server where ITM is installed only if you have downloaded and installed Incremental Device Update (IDU) 4 or later from the ITM download site: http://www.cisco.com/cgi-bin/tablebuild.pl/item-3des.
ITM supports the host resources and system application MIBs. This support enables you to monitor ITM using a third-party SNMP management tool, so that you can:
•
Consistently monitor multiple platforms—One platform on which ITM resides and one or more on which applications in the IP Telephony Environment Monitor (ITEM) suite reside.
•
Access complete hardware and operating system information using the host resources MIB.
•
Assess the application health using the system application MIB, which provides the following information:
–
Applications that ITM installed.
–
Processes associated with applications and current process status.
–
Processes that ran previously and application exit state.
For MIB implementation details and sample MIB walk, see "ITM Support for SNMP MIBs."
Note
You cannot uninstall the MIB support; however, you can stop Windows SNMP service and set the startup type to either Manual or Disabled. See the "Enabling and Disabling Windows SNMP Service" section.
Configuring Your System for SNMP Queries
To enable SNMP queries, SNMP service must be installed and enabled, and support for the System Application and Host Resources MIB must be installed subsequently.
Step 1
Verify that SNMP service is installed and enabled on the server where ITM is installed. See the "Determining the Status of Windows SNMP Service" section.
Step 2
If you determined that SNMP service was not installed, do the following:
a.
Install Windows SNMP Service; see the "Installing and Uninstalling Windows SNMP Service" section.
b.
Install ITM IDU 4 or later from the ITM download site: http://www.cisco.com/cgi-bin/tablebuild.pl/item-3des.
Determining the Status of Windows SNMP Service
Windows SNMP service is a Windows component that you can add or remove when you want to. To enable SNMP queries against the MIBs that ITM supports, SNMP service must be installed and enabled. You can verify the status of Windows SNMP service as follows.
Step 1
Open the Windows administrative tool Services window.
Step 2
Verify the following:
•
SNMP Service is displayed on the Windows administrative tool Services window; if so, Windows SNMP service is installed.
Note
To install Windows SNMP service, see the "Installing and Uninstalling Windows SNMP Service" section.
•
SNMP Service startup type is Automatic or Manual; if so, Windows SNMP service is enabled.
Note
To enable Windows SNMP service, see the "Enabling and Disabling Windows SNMP Service" section.
Installing and Uninstalling Windows SNMP Service
Windows online help provides instructions for adding and removing Windows components, such as Windows SNMP service. To locate the instructions, try selecting the Index tab in Windows online help and entering a keyword or phrase, such as installing SNMP service.
To uninstall Windows SNMP service, follow instructions in Windows help for removing Windows components.
Note
When you uninstall Windows SNMP service from the server where ITM is installed, you also remove support for the host resources and system application MIBs. If you want to install support again, see the "Configuring Your System for SNMP Queries" section.
Enabling and Disabling Windows SNMP Service
You can enable or disable Windows SNMP service using the Windows administrative tool Services. For instructions to open the Services window, see Windows online help.
Step 1
Locate SNMP Service in the Services window. The status and startup type are displayed.
Note
If SNMP Service is not displayed, Windows SNMP service is not installed; see the "Installing and Uninstalling Windows SNMP Service" section.
Step 2
Right-click SNMP Service and select Properties. The SNMP Service Properties window opens:
•
To disable SNMP service, set Startup Type to Disable and click OK.
•
To enable SNMP service, set Startup Type to Automatic or Manual and click OK.
Note
To start SNMP service after you enable it, right-click SNMP Service and select Start.
Configuring Security for SNMP Queries
To improve security, the SNMP set operation is not allowed on any object ID (OID). You should also modify the credentials for SNMP service to not use a default or well-known community string.
Note
You do not need to restart SNMP service to modify credentials for it.
You can modify SNMP service credentials using the Windows administrative tool Services.
Step 1
Locate SNMP Service in the Services window.
Step 2
Right-click SNMP Service and select Properties. The SNMP Service Properties window opens.
Step 3
Select the Security tab.
Step 4
Edit the accepted community names and click OK.
Viewing the System Application MIB Log File
The system application MIB log file, SysAppl.log, is located on the server where ITM is installed in NMSROOT/log.
Note
NMSROOT is the directory where CiscoWorks is installed on your system. If you selected the default directory during installation, it is C:\Program Files\CSCOpx.