Table Of Contents
Understanding the CWCS Directory Structure
About CWCS Directory Policies
About the CWCS Top-Level Runtime Directories
About the CWCS Common Directories
About the CWCS Solaris-Specific Directories
About the CWCS UNIX-Specific Directories
About the CWCS Windows-Specific Directories
About CWCS File Permissions
About CWCS Property Files
About CWCS Log Files
Understanding the CWCS Directory Structure
The following topics describe the CiscoWorks Common Services (CWCS) directory structure:
•
About CWCS Directory Policies
•About the CWCS Top-Level Runtime Directories
•About CWCS File Permissions
•About CWCS Property Files
•About CWCS Log Files
About CWCS Directory Policies
Consider the following when creating runtime directories:
•Follow the guidelines defined in this chapter.
•Provide administrative options to relocate the folders that expand over time. Such folders will contain files that grow as new applications are added.
•Use the CWCS runtime structure explained here. Doing so will allow your application to maintain compatibility with CWCS and other applications using CWCS.
About the CWCS Top-Level Runtime Directories
The CWCS top-level runtime directories are located in two trees that determine all other directory paths:
•NMSROOT contains the bulk of the product. This is the top-level install directory. The default NMSROOT definition differs for Windows and UNIX systems:
–On Windows: D:\Progra~1\CSCOpx, where D is the drive letter stored in the Windows SystemDrive variable. CWCS uses the abbreviated DOS alias for Windows directory and file names. For example: Progra~1 for the Program Files directory.
–On UNIX: /opt/CSCOpx.
•A directory that contains the logs and application-specific files created at run time. This is the top-level runtime files directory.
A system that ships simultaneously on both UNIX and Windows can have separate runtime trees for each platform, and these may look very different. Accordingly, the following topics describe both the common and platform-specific organization and contents of the top-level runtime directories:
•About the CWCS Common Directories
•About the CWCS Solaris-Specific Directories
•About the CWCS UNIX-Specific Directories
•About the CWCS Windows-Specific Directories
About the CWCS Common Directories
The CWCS directories listed in Table 3-1 are common to all platforms.
Table 3-1 Common Directories
Common Name
|
Directory path
|
Contents
|
BACKUP
|
NMSROOT/backup
|
Location for database and directory manifest files.
|
BIN
|
NMSROOT/bin
|
Program startup scripts - non-binary batch files, shared binaries, shared Windows DLLs.
|
CGI-BIN
|
NMSROOT/cgi-bin
|
cgi-bin 1.1 programs (web server can access this directory).
|
CLIENTINSTALL
|
NMSROOT/cam_repository
|
Client-side install classes and control files.
|
CLIENT-JAVA
|
NMSROOT/www/classpath
|
Java class files for clients and those shared by client and server (web server can access this directory).
|
CLIENT-JAVA-APPS
|
NMSROOT/www/classpath/com/cisco/nm/app_name
|
Java classes for application/CWCS shared server/client code developed by Cisco. Application folders must contain all property files associated with the application.
|
COLLECT
|
NMSROOT/collect
|
Collect Server Info scripts and output files.
|
CONF
|
NMSROOT/conf
|
Configuration data files.
|
DATABASES
|
NMSROOT/databases
|
Original or empty database versions.
|
DBMS
|
NMSROOT/objects/db
|
Install directory for database engine.
|
DBUPGRADE
|
NMSROOT/dbupgrade
|
Database upgrade files.
|
ETC
|
NMSROOT/etc
|
Copyright, readme, .profile, .cshrc, ... files.
|
HELP
|
NMSROOT/htdocs/help
|
Help file directory root.
|
HTDOCS
|
NMSROOT/htdocs
|
HTML tree used by the httpd server (web server can access this directory).
|
HTDOCS-IMAGES
|
NMSROOT/htdocs/images
|
Shared image files, application directories at this level for application specific images.
|
LIB
|
NMSROOT/lib
|
Shared libraries and directories of shared UNIX libraries (*.so).
|
MDC
|
NMSROOT/mdc
|
CWCS Core components.
|
OBJECTS
|
NMSROOT/objects
|
Install directory for non-Java and non-web server accessed CWCS/application code.
|
OBJECTS-APPS
|
NMSROOT/objects/app_name
|
CWCS and application install directories.
|
SELFTEST
|
NMSROOT/selftest
|
Product self-test Perl scripts.
|
SERVER-JAVA
|
NMSROOT/lib/classpath
|
Server-only Java classes.
|
SERVER-JAVA-APPS
|
NMSROOT/lib/classpath/com/cisco/nm/app_name
|
Java classes for application/CWCS server code developed by Cisco. Application folders must contain property files associated with this application unless otherwise defined in CLIENT-JAVA-APPS.
|
SETUP
|
NMSROOT/setup
|
Install information and results.
|
About the CWCS Solaris-Specific Directories
The CWCS directories listed in Table 3-3 are unique to Solaris systems.
Table 3-2 Solaris-Specific Directories
Common Name
|
Directory path
|
Contents
|
DMCONFIG
|
/etc/rc.config.d
|
Solaris Daemon Manager config file.
|
DMSTARTUP
|
/etc/init.d
|
Solaris Daemon Manager startup files.
|
About the CWCS UNIX-Specific Directories
The CWCS directories listed in Table 3-3 are unique to UNIX systems or typically not nested under the NMSROOT tree on UNIX. They are common to all UNIX systems, including Solaris.
Table 3-3 UNIX-Specific Directories
Common Name
|
Directory path
|
Contents
|
FILES
|
User-specified/CSCOpx/files
|
Product data files. The default for User-specified is /var/adm.
|
INSTLOGS
|
/var/tmp
|
UNIX install logs.
|
LOG
|
User-specified/CSCOpx/log
|
Log files generated by CWCS components and apps. The default for User-specified is /var/adm. Note that a few components and applications create logs in other directories. For details, see the "About CWCS Log Files" section.
|
MAN
|
NMSROOT/man
|
UNIX man files for product features.
|
TEMP
|
/tmp
|
Default temporary directory.
|
About the CWCS Windows-Specific Directories
The CWCS directories listed in Table 3-3 are unique to Windows or typically not nested under the NMSROOT tree on Windows.
Table 3-4 Windows-Specific Directories
Common Name
|
Directory path
|
Contents
|
FILES
|
NMSROOT\files
|
Enduser data.
|
INSTALL LOG
|
system drive root (e.g., C:\)
|
Windows install and uninstall log files. Filenames are of the form Ciscoworks_setupxxx.log, where xxx is a number indicating the serial order of the install or uninstall.
|
LOG
|
NMSROOT\log
|
Log files generated by CWCS components and applications. Note that a few components and applications create logs in other directories. For details, see the "About CWCS Log Files" section.
|
PROXY
|
NMSROOT\proxy
|
Proxy working directory.
|
TEMP
|
NMSROOT\temp
|
Default temporary directory.
|
TFTPBOOT
|
NMSROOT\tftpboot
|
TFTP directory.
|
About CWCS File Permissions
In general, the user casuser runs applications for Windows and UNIX platforms. Programs (binaries, scripts, etc) should be executable only by the user casuser in user group casusers. All files should be readable by users that belong to the group casusers.
•On UNIX platforms, set the permissions to:
Executables: rwxr-x--- casuser casusers
All normal data files: rw-r----- casuser casusers
Log files: rw-rw---- casuser casusers
Directories: rwxrwxr-x casuser casusers
•On Windows, set the access bits on the directories that contain the applications to allow execute and access by user groups casusers and Administrators.
Note The user name casuser stands for "Cisco Application Server User". Installation of CWCS on all platforms creates the group casusers and adds the user casuser to that group automatically.
About CWCS Property Files
Table 3-5 lists all the CWCS property files, sorted alphabetically by the components they configure, with their locations. All paths are relative to the top-level NMSROOT directory on each platform (see the "About the CWCS Top-Level Runtime Directories" section).
Table 3-5 CWCS Property Files
Component
|
Directory Path(s)
|
File(s)
|
Description
|
CiscoWorks
|
/lib/classpath/
|
apps-plugin.properties; cw2000-plugin.properties; javaplugin.properties; md.properties; proxy.properties; ss.properties; ssl.properties, sso.properties
|
CiscoWorks configurations
|
/www/classpath/com/cisco/nm/cmf/
|
debug.properties
|
Sets debug levels for MakerChecker, other application modules
|
CiscoWorks Home Page
|
/lib/classpath/com/cisco/nm/cmf/servlet/
|
DesktopServlet.props
|
Sets the URL for the Desktop messagingbanner
|
/MDC/tomcat/webapps/cwhp/WEB-INF/resources
|
cwhpadmin.properties
|
CWHP Admin configuration
|
CMIC
|
/conf/cmic/
|
log-cmic.properties
|
Log4J logging configuration for this component
|
Database Services
|
/www/classpath/com/cisco/nm/cmf/dbservice
|
/DBServer.properties, /orig/DBServer.properties, /servlet/CommServlet.properties
|
CWCS Database configuration
|
/lib/classpath/ianywhere/ml/jdbcodbc/
|
iresource.properties (and national language variants)
|
Sybase SQL Anywhere configuration
|
DCR
|
/lib/classpath/com/cisco/nm/dcr/
|
log4j-dcr.properties
|
Log4J logging configuration
|
/MDC/tomcat/webapps/cwhp/WEB-INF/classes/
|
DCR_Implementation_Details.properties
|
System configuration
|
/objects/dcrimpexp/Adaptors
|
/HPOV6.x/Adaptor.properties, /Netview7.x/Adaptor.properties
|
Import/Export adaptor configurations
|
/objects/dcrimpexp/cnf
|
DCRImpExp.properties
|
Import/Export process parameters
|
/objects/dcrimpexp/conf/
|
log-dcr.properties
|
Log4J logging configuration for this component
|
Device Center
|
/conf/devicecenter/
|
log-devicecenter.properties
|
Device Center logging
|
/lib/classpath/com/cisco/nm/pidm/
|
log4j-pidm.properties
|
Log4J logging configuration for this component
|
/lib/classpath/com/cisco/nm/pidm
|
PIDM_Registration_data
|
Configuration data used for PIDM bypass in Device Center
|
EDS
|
/www/classpath/com/cisco/nm/cmf/eds/...,
|
Various
|
EDS real-time display, error messaging, trap support, GCF, UI configuration.
|
ESS
|
/NMSROOT/objects/ess/conf
|
essproperties.conf
|
ESS configuration
|
Javac
|
/www/classpath/sun/tools/javac/resources/
|
javac.properties
|
Javac configuration
|
Job Scheduler
|
/www/classpath/com/cisco/nm/cmf/scheduler/
|
JobRegistration.properties, JobScheduler.properties
|
Job registration and scheduling configuration
|
JRE 1.4.1
|
/lib/jre141/lib/
|
content-types.properties, flavormap.properties, font.properties (per language) , logging.properties,
|
JRE 1.4.1 content types, flavormap, font properties, logging
|
/setup/, /setup/dependency/
|
Various
|
JRE 1.4.1 setup dependencies
|
Log4J
|
/objects/licenses/
|
log4j-license.properties
|
Log4J license
|
/MDC/tomcat/webapps/cwhp/WEB-INF/classes/
|
log4j.properties, log4j.server.properties
|
Log4j server configuration
|
MDC
|
/MDC/Sybase/Shared/Sun/jdk122/jre/lib/, /MDC/Sybase/Shared/Sun/jdk122/jre/lib/images/cursors/
|
Various
|
JDK 1.2.2 content type, flavormap, font and cursor support for MDC Sybase
|
/MDC/JRE/lib/
|
Various
|
JRE 2content type, flavormap, font and cursor support configuration for MDC
|
/MDC/tomcat/conf/jk/
|
uriworkermap.properties, workers.properties, wrapper.properties
|
Tomcat configurationfor MDC
|
OGS
|
/MDC/tomcat/webapps/cwhp/WEB-INF/classes/
|
log4j-ogs.properties
|
OGS logging properties for log4j
|
/MDC/tomcat/webapps/cwhp/WEB-INF/classes/
|
OGSClient.properties, OGSServer.properties, SharedGroups.properties
|
OGS runtime configuration
|
/lib/classpath/com/cisco/nm/cmf/dbi/
|
dbi.properties, deldev.properties
|
OGS group structure, device deletion
|
PSU
|
/lib/classpath/com/cisco/nm/xms/psu/conf/
|
log4j-psu.properties, psu.properties, tag.properties
|
PSU runtime and logging properties
|
Security
|
/www/classpath/com/cisco/nm/cmf/security/jaas/
|
Twofish.properties
|
TwoFish encryption configuration
|
Visibroker
|
/etc/
|
Orb.properties
|
Basic Visibroker ORBconfig
|
/lib/jre141/lib/endorsed/com/inprise/vbroker (and subdirectories)
|
Various
|
Security, events, HIOP, messages, names support for Visibroker
|
/lib/jre141/lib/images/cursors/
|
Various
|
JRE 1.4.1 cursor support for Visibroker
|
/www/classpath/com/inprise/vbroker/
|
Various
|
Visibroker support
|
Web Services
|
/MDC/tomcat/webapps/cwhp/WEB-INF/resources/work/
|
modules.properties
|
Tomcat worker configuration
|
About CWCS Log Files
Table 3-6 lists the filenames and locations of all logs produced by CWCS components.
The table refers to normal top-level log directories for each platform. These are NMSROOT/log on UNIX and NMSROOT\log on Windows (see the"About the CWCS Top-Level Runtime Directories" section). Nearly all CWCS components write their activity logs there. Paths to log files other than those in the normal log directories are shown in the table relative to NMSROOT on each platform (e.g.: The path to license.log is \Program Files\CSCOpx on Windows, /var/opt/CSCOpx/ on Solaris.).
Table 3-6 CWCS Log Files
Component
|
Directory Path
|
File
|
Description
|
Backup and Restore
|
/MDC/tomcat/vms/maas/Data
|
CLIBackup.log
|
Core-based backup logs (command-line interface)
|
/MDC/etc/backup-restore/debug-log
|
BackupServerDebugOut.txt, RestoreServerDebugOut.txt
|
Core-based backup and restore debug logs
|
Normal top-level log directories
|
dbbackup.log, restorebackup.log
|
CMF-based backup and restore logs
|
CRMLogger
|
Normal top-level Windows log directory only
|
syslog.log
|
Syslogs received from device/machine. Windows only.
|
Normal top-level Windows log directory only
|
syslog_debug.log
|
CRMLogger debugging information and messages from device/machine. Windows only.
|
CWCS General
|
Normal top-level log directories
|
error.log
|
General CWCS errors
|
Normal top-level log directories
|
perlerr.log
|
Perl interpreter errors
|
Normal top-level log directories
|
Proxy.log
|
Proxy activity
|
Normal top-level log directories
|
event.log
|
CWCS events
|
Normal top-level Solaris log directory only
|
daemons.log
|
All Daemon Manager-controlled processes. Solaris only.
|
Database Services
|
/databases/cmf/
|
cmf.log
|
Database access.
|
Normal top-level log directories
|
CmfDbMonitor.log
|
Sybase database operations
|
Normal top-level log directories
|
dbpwdChange.log
|
Database password changes
|
Normal top-level log directories
|
dmgtDbg.log
|
Daemon Manager interactions with Sybase database
|
/objects/db/win32/
|
dbcond8.log
|
Database condition log
|
DCR
|
Normal top-level log directories
|
dcr.log
|
DCR log
|
DiskWatcher
|
Normal top-level log directories
|
diskWatcher.log
|
DiskWatcher warnings
|
EDS
|
Normal top-level log directories
|
EDS-GCF.log, EDS.log
|
All EDS activity
|
ESS
|
Normal top-level log directories
|
ESS.log
|
All ESS activity
|
JRM
|
Normal top-level Windows log directory only
|
jrm.log
|
JRM server activity on Windows only
|
Licensing APIs
|
Normal top-level log directories
|
LicenseServer.log
|
License Server activity
|
Normal top-level log directories
|
license.log
|
Product license changes
|
LWMS
|
Normal top-level log directories
|
lwms.log
|
Lightweight Messaging Service activity
|
OGS
|
Normal top-level log directories
|
OGSClient.log
|
OGS client module log
|
Normal top-level log directories
|
CMFOGSServer.log
|
OGSServer log (CWCS OGS Server only)
|
PSU
|
/lib/classpath/com/cicso/nm/xms/psu/conf/
|
psu.log
|
All PSU activity
|
Visibroker
|
Normal top-level Windows log directory only
|
RmeGatekeeper.log
|
RME Gatekeeper activity from Visibroker vorb package. Windows only
|
Web Services
|
/MDC/Apache/logs/
|
access.log, error.log, mod_jk.log, ssl.log
|
All Apache activity
|
/MDC/tomcat/logs/
|
jasper-YYYYMMDD.log, servlet-YYYYMMDD.log, stderr.log, stdout.log,
|
All Tomcat activities
|
Normal top-level log directories
|
changeport.log
|
Port change information
|
Feedback
