* $Id$
***************************************************************************
* $Copyright: Copyright (c) 2016 Veritas Technologies LLC. All rights reserved VT25-0977-2658-84-51-3 $ *
***************************************************************************

 This directory (/usr/openv/netbackup/logs) contains the user_ops 
 sub-directory and, optionally, sub-directories where detailed debug logs
 will be created.

For NetBackup 6.0, new NetBackup services are using Unified Logging (VxUL).
For more information about the logging of new services, please refer to the
trouble shooting guide and the man pages of VxUL command line interfaces -
vxlogview,vxlogmgr and vxlogcfg. 

Following information does not apply to services using VxUL.


 The user_ops sub-directory is created during the install of NetBackup on
 all servers and clients.  It is used by the NetBackup - Java GUI applications
 for placement of job and progress log files generated by the end-user client 
 application (jbp) and temporary files generated while using these 
 applications.  This directory must exist for successful operation of any 
 of these GUI applications and must have public read, write and execute 
 permissions.  One sub-directory in logs/user_ops will exist for every user 
 that is using these GUI applications.  The pruning of files in this 
 sub-directory is done per the semantics of the KEEP_LOGS_DAYS 
 bp.conf option - default is 3 days.  In addition, when the NBJava GUI is 
 installed, a sub-directory of user_ops is created - nbjlogs.  This 
 directory will contain the NBJava GUI debug log files.  It must also exist
 and have public read, write and execute permissions.  Pruning of the files
 in this directory is done in the same manner as with the other 
 sub-directories of user_ops.

 In addition to the directories and files in user_ops generated by the Java
 GUI applications, two sub-directories are created in user_ops for application
 agents - dbext and dbtemplates.  These sub-directories and the sub-directories
 within them must also have public read, write and execute permissions with
 the sticky bit set.  The sticky bit is a permission bit that is set on a
 directory that allows only the owner of a file within that directory or
 the root user to delete or rename the file.

 All other sub-directories in /usr/openv/netbackup/logs are optional and 
 should only be created if unexplained problems are occurring with the
 NetBackup product and more information is required to isolate the problem. 

 Miscellaneous notes about these optional NetBackup logs contained in this 
 directory:
     -each NetBackup process has its own debug log directory
     -one debug log file is created per process per day per NetBackup user. The file names 
      created are of the form:
		<username>.mmddyy_seqno.log	(e.g., user1.110891_00001.log)
		where <username> is the name of the user who initiated/executed the process.
     -debug logging is only in affect for a process if that process's 
      debug log directory is defined.
     -The log files in these directories are automatically deleted by
      the NetBackup request daemon, bprd.  The administrative parameter
      "keep logs x days" determines how long the log files exist.
     -volume of debug logging can be increased by enabling "verbose"
      mode by defining the string "VERBOSE" in the /usr/openv/netbackup/bp.conf
      file.

  WARNING:  Some of these logs can potentially grow very large, and should 
            only be enabled if unexplained problems exist.

 The following directories can be individually created on the server, to cause 
 the corresponding NetBackup server process to log information:

                /usr/openv/netbackup/logs/admin
                /usr/openv/netbackup/logs/bpbrm
                /usr/openv/netbackup/logs/bpbrmds
                /usr/openv/netbackup/logs/bpcd
                /usr/openv/netbackup/logs/bpcompatd
                /usr/openv/netbackup/logs/bpdbjobs
                /usr/openv/netbackup/logs/bpdbm
                /usr/openv/netbackup/logs/bpdm
                /usr/openv/netbackup/logs/bpinst
                /usr/openv/netbackup/logs/bpjava-msvc
                /usr/openv/netbackup/logs/bpjava-susvc
                /usr/openv/netbackup/logs/bpjobd
                /usr/openv/netbackup/logs/bpps
                /usr/openv/netbackup/logs/bprd
                /usr/openv/netbackup/logs/bpstsinfo
                /usr/openv/netbackup/logs/bpsynth
                /usr/openv/netbackup/logs/bptm
                /usr/openv/netbackup/logs/cluster
                /usr/openv/netbackup/logs/liveupdate
                /usr/openv/netbackup/logs/nbauditreport
                /usr/openv/netbackup/logs/nbazd
                /usr/openv/netbackup/logs/nbdb
                /usr/openv/netbackup/logs/nblogadm
                /usr/openv/netbackup/logs/nblogadmhelper
                /usr/openv/netbackup/logs/nbproxy
                /usr/openv/netbackup/logs/nbregopsc
                /usr/openv/netbackup/logs/nbvault
                /usr/openv/netbackup/logs/ncf
                /usr/openv/netbackup/logs/symlogs
                /usr/openv/netbackup/logs/vault
                /usr/openv/netbackup/logs/vnetd
                /usr/openv/netbackup/logs/vxms

 In order for non-root administrators to be able to write to the log files,
 the "admin" directory should be created with access modes of 1777.

 The following directories can be individually created on the client, to cause 
 the corresponding NetBackup client process to log information:

                /usr/openv/netbackup/logs/backint
                /usr/openv/netbackup/logs/bp
                /usr/openv/netbackup/logs/bparchive
                /usr/openv/netbackup/logs/bpbackup
                /usr/openv/netbackup/logs/bpbkar
                /usr/openv/netbackup/logs/bpcd
                /usr/openv/netbackup/logs/bpclimagelist
                /usr/openv/netbackup/logs/bpclntcmd
                /usr/openv/netbackup/logs/bpdb2
                /usr/openv/netbackup/logs/bpdbsbdb2
                /usr/openv/netbackup/logs/bpdbsbora
                /usr/openv/netbackup/logs/bpdhcp
                /usr/openv/netbackup/logs/bpfis
                /usr/openv/netbackup/logs/bpfilter
                /usr/openv/netbackup/logs/bpfsmap
                /usr/openv/netbackup/logs/bpjava-msvc
                /usr/openv/netbackup/logs/bpjava-usvc
                /usr/openv/netbackup/logs/bpkeyutil
                /usr/openv/netbackup/logs/bplist
                /usr/openv/netbackup/logs/bpmount
                /usr/openv/netbackup/logs/bpnbat
                /usr/openv/netbackup/logs/bporaexp
                /usr/openv/netbackup/logs/bporaexp64
                /usr/openv/netbackup/logs/bporaimp
                /usr/openv/netbackup/logs/bporaimp64
                /usr/openv/netbackup/logs/bppfi
                /usr/openv/netbackup/logs/bpps
                /usr/openv/netbackup/logs/bprestore
                /usr/openv/netbackup/logs/bphdb
                /usr/openv/netbackup/logs/bpVMreq
                /usr/openv/netbackup/logs/bpVMutil
                /usr/openv/netbackup/logs/dbclient
                /usr/openv/netbackup/logs/exten_client
                /usr/openv/netbackup/logs/infxbsa
                /usr/openv/netbackup/logs/mtfrd
                /usr/openv/netbackup/logs/nbcssc
                /usr/openv/netbackup/logs/nbdedupmts
                /usr/openv/netbackup/logs/nbfsd
                /usr/openv/netbackup/logs/nbjsonformat
                /usr/openv/netbackup/logs/nbliveup
                /usr/openv/netbackup/logs/nblogadmagent
                /usr/openv/netbackup/logs/nbmsw
                /usr/openv/netbackup/logs/nbostpxy
                /usr/openv/netbackup/logs/nbrestorevm
                /usr/openv/netbackup/logs/patch
                /usr/openv/netbackup/logs/sybackup
                /usr/openv/netbackup/logs/symlogs
                /usr/openv/netbackup/logs/tar
                /usr/openv/netbackup/logs/vnetd
                /usr/openv/netbackup/logs/vxms

 In order for users on the client to be able to write to the log files, some of the
 directories should be created with access modes of 1777. It is recommended that mklogdir
 followed by the directory name should be executed in order to ensure that log directories
 are created with appropriate permissions.

 The following directories are used by processes in netbackup goodies to log

                /usr/openv/netbackup/logs/bpconverttouch


 All the above directories (both server and client) may be created on the
 server by running the mklogdir script which is supplied in the logs
 directory.


 Here are descriptions of NetBackup processes:

	bprd       
		-request daemon
		-can be terminated and initiated from the admin interfaces
		-responds to client and administrative requests
			-restores
			-backups
			-archives
			-"list files backed-up or archived"
			-manual/immediate backups
			-reread configuration database
	bpdm       
		-disk manager
		-used on storage units of type Disk
		-started by bpbrm on backups and restores
		-during backups and restores, one of these is started (on the 
		 server with the storage unit) for each client backup or restore
	bptm
		-removable media (tape)  manager
		-used on storage units of type Logical Tape
		-started by bpbrm on backups and restores
		-during backups and restores, one of these is started (on the 
		 server with the storage unit) for each client backup or restore
		-also responsible for managing the media database 
	    	-used to display info in the Media Reports screen when you 
		 select Media List
	bpbrm      
		-backup/restore manager
		-started by nbjm on backups/archives
		-started by bprd on restores
		-during backups and restores, one of these is started (on the 
		 server with the storage unit) for each client backup or restore
		-responsible for managing both the client and the media manager
		 processes.  uses error status from both to determine ultimate
		 status of backup or restore.
	bpbrmds      
		-backup/restore manager for Disk Staging duplications
		-started by nbjm when handling a Disk Staging schedule 
		-responsible for starting, and managing, a bpduplicate process.
	bpdbm
		-database manager
		-manages policy, config/behavior, storage unit, and error DB's
	bpjobd
		-job manager
		-manages backup and restore jobs for the activity monitor GUIs
	bpsynth
		-NetBackup synthetic backup manager
		-started by nbjm on synthetic backups
		-runs on master server and manages the creation of a 
		 synthetic image.
	bpcompatd
		-compatibility daemon
		-allows NetBackup 6.0 commands to connect to pre-6.0 daemons
	bpcd       
		-legacy client daemon
		-used to provide miscellaneous services
	bpjava-msvc
		-NetBackup-Java application server authentication service program
		-started by vnetd during startup of the NetBackup-Java GUI applications
		-authenticates the user that started the NetBackup-Java GUI application
	bpjava-susvc
		-NetBackup-Java application server user service program on NetBackup 
         servers
		-started by bpjava-msvc upon successful login via the NetBackup-Java
			GUI applications login dialog window
		-services all requests from the NetBackup-Java GUI applications
			for administration and end-user operations on the host on which the 
			NetBackup-Java application server is running
      -additional bpjava-susvc processes get started to respond to requests
         from the NetBackup-Java GUI applications
	bpjava-usvc
		-NetBackup-Java application server user service program on NetBackup 
         clients
		-started by bpjava-msvc upon successful login via the NetBackup-Java
			GUI applications login dialog window
		-services all requests from the NetBackup-Java GUI applications
			for administration and end-user operations on the host on which the 
			NetBackup-Java application server is running
      -additional bpjava-usvc processes get started to respond to requests
         from the NetBackup-Java GUI applications
	bpdbjobs
		-command-line activity monitor for backup and restore jobs
	bparchive  
		-command-line program on clients to initiate archives
		-communicates with bprd on server
	bpbackup   
		-command-line program on clients to initiate backups
		-communicates with bprd on server
	bpbkar     
		-program used on standard clients to generate backup images
		-not used directly by client users
	bplist     
		-command-line program on clients to initiate file lists
		-communicates with bprd on server
	bprestore  
		-command-line program on clients to initiate restores
		-communicates with bprd on server
	bpnbat     
		-command-line program to manage NetBackup Access Control
		 authentication
	bphdb
		-program used to start obackup to do Oracle database backups
	bpdb2
		-log for the DB2 Extension clients
	dbclient
		-log for the DB Extension clients
	infxbsa
		-log for the Informix Extension clients
	tar
		-program used on standard clients to restore backup images
	bp
		-menu user interface for backups, archives, and restores
	bpadm
		-menu user interface for administrative tasks
	bpdbsbdb2
		-command-line program used to initiate template based 
		 user-directed DB2 backup and recovery
		-enables generation of a shell script from a template for DB2
	bpdbsbora
		-command-line program used to initiate template based 
		 user-directed backup and recovery
		-enables generation of a shell script from a template
	bporaexp     
		-command-line program on clients to export Oracle 
                 data in XML format
		-communicates with bprd on server
	bporaexp64     
		-64-bit command-line program on clients to export Oracle 
                 data in XML format
		-communicates with bprd on server
	bporaimp     
		-command-line program on clients to import Oracle 
                 data in XML format
		-communicates with bprd on server
	bporaimp64     
		-64-bit command-line program on clients to import Oracle 
                 data in XML format
		-communicates with bprd on server
	bpfilter     
		-client program used to filter backup images between the media
		 server and bpbkar or tar on the client
	bpkeyutil     
		-command-line program to manage Encryption key files
	vnetd
		-legacy network daemon
		-used to create "firewall friendly" socket connections
		 and provide other miscellaneous services