Veritas NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- add_media_server_on_clients
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpclient
- bpclimagelist
- bpclntcmd
- bpclusterutil
- bpcompatd
- bpconfig
- bpdbjobs
- bpdbm
- bpdgclone
- bpdown
- bpduplicate
- bperror
- bpexpdate
- bpfis
- bpflist
- bpgetconfig
- bpgetdebuglog
- bpimage
- bpimagelist
- bpimmedia
- bpimport
- bpinst
- bpkeyfile
- bpkeyutil
- bplabel
- bplist
- bpmedia
- bpmedialist
- bpminlicense
- bpnbat
- bpnbaz
- bppficorr
- bpplcatdrinfo
- bpplclients
- bppldelete
- bpplinclude
- bpplinfo
- bppllist
- bpplsched
- bpplschedrep
- bpplschedwin
- bppolicynew
- bpps
- bprd
- bprecover
- bprestore
- bpretlevel
- bpschedule
- bpschedulerep
- bpsetconfig
- bpstsinfo
- bpstuadd
- bpstudel
- bpstulist
- bpsturep
- bptestbpcd
- bptestnetconn
- bptpcinfo
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCertsForPlugins
- configureMQ
- configurePorts
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig throttle
- csconfig reinitialize
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- manageClientCerts
- mklogdir
- nbauditreport
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcloudrestore
- nbcomponentupdate
- nbcplogs
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbfindfile
- nbfirescan
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbregopsc
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbsetconfig
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- resilient_clients
- restoretrace
- stopltid
- tl4d
- tl8d
- tl8cd
- tldd
- tldcd
- tlhd
- tlhcd
- tlmd
- tpautoconf
- tpclean
- tpconfig
- tpext
- tpreq
- tpunmount
- verifytrace
- vltadm
- vltcontainers
- vlteject
- vltinject
- vltoffsitemedia
- vltopmenu
- vltrun
- vmadd
- vmchange
- vmcheckxxx
- vmd
- vmdelete
- vmoprcmd
- vmphyinv
- vmpool
- vmquery
- vmrule
- vmupdate
- vnetd
- vssat
- vwcp_manage
- vxlogcfg
- vxlogmgr
- vxlogview
- W2KOption
Name
vxlogcfg — modify unified logging configuration settings
SYNOPSIS
-a -p ProductID -c ConfigPath -n Names [-q]
-a -p ProductID -o OriginatorID -s keyname=value [-q]
-a -p ProductID -g LogSet -s keyname=value [-q]
-d -p ProductID
-l [-p ProductID [-o OriginatorID]] [-q]
-l [-p ProductID [-g LogSet]] [-q]
-r -p ProductID [-o OriginatorID] [-s keyname] [-q]
-r -p ProductID [-g LogSet] [-s keyname] [-q]
-v
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/
On Windows systems, the directory path to this command is install_path\NetBackup\bin\
DESCRIPTION
Use the vxlogcfg command to change the logging settings for NetBackup unified logging. It registers and unregisters the product log configurations during installation and uninstallation.
Unified logging uses a standardized naming format for log files, as follows:
productID-originatorID-hostID-date-rotation.log
For more information about the unified logging naming format, and the logging originator IDs, refer to the NetBackup Logging Reference Guide.
OPTIONS
Specify the product log configuration to register or unregister. Use fully-qualified path names for all directory paths. If a directory name contains spaces, use quotes around the path name for that directory (for example, "the Program Files" directory).
- -a, --add
Registers or creates the product log configuration settings. Any existing log settings are overwritten. Do not use this option to add a product to the list of those that use unified logging. Instead, use it only to modify existing unified logging settings. See examples.
- -c, --config ConfigPath
Provides the absolute path from which the product log configuration settings should be read.
On UNIX systems, use the absolute path to the product log configuration file (for example,
/opt/vrts/ProductA/log.conf.)On Windows systems, use the path to the product log registry settings (for example,
\\SOFTWARE\VERITAS\PRODUCTA\)- -d, --delete
Unregisters and removes the product log configuration settings from the main logging configuration file, if there are no originator IDs configured for the product. The corresponding product log configuration file is also deleted.
- -g, --logset LogSet
Creates or modifies log configuration settings for the specified LogSet. LogSet is supplied as the text string "Default" or the text string "ALL." If the LogSet is "Default," then the -s configuration settings are the default settings. If the LogSet is "ALL, then the -s configuration settings are given to all the originators of a given product ID.
- -l, --list
Lists one of the following:
All of the configured products.
All of the originator IDs and LogSet
All of the configuration settings that are defined for a product ID and originator ID pair, or a product ID and LogSet
- -n, --names Name
Specifies abbreviated or short names for the product. Separate multiple names with a comma.
- -o, --orgid OrgID
Creates or modifies log configuration settings for the specified originator ID. The Originator ID can be supplied as a valid originator ID (a number), or, the text string "Default," or the text string "ALL." If the Originator ID is "Default," then the -s configuration settings are the default settings. If the Originator ID is "ALL, then the -s configuration settings are given to all the originators of a given product ID.
- -p, --prodid ProductID
Creates or modifies the log configuration settings for a productID.
- -q, --quiet
Prevents the display of error or informational messages (Quiet Mode).
- -r, --remove
Unregisters and removes the log configuration settings for the specified OID and product from the product logging configuration file. Individual settings can be removed with the "-s, --setting keyname=value" option.
Caution:
Always use the -r option with the -o option. Otherwise, all of the existing NetBackup log settings are removed and no further logging is performed for all of NetBackup.
- -s, --setting keyname=value
Sets the individual configuration settings when used with -a (add option). keyname is the configuration setting's name and value is the value for that setting. You can use multiple -s keyname=value arguments on the command line.
- -s, --setting keyname
Removes a configuration setting when it is used with the -r option. Use only one keyname with the -r option. To remove multiple settings, provide multiple -s options. See the Keynames and Values section for particular keynames.
- -v, --version
Displays the version information for this command.
KEYNAMES AND VALUES
Following are the keynames and values that can be specified on the -s option. For NetBackup, the vxlogcfg command places these keynames and values in the /usr/openv/netbackup/nblog.conf file on UNIX and in install_path\NetBackup\nblog.conf on Windows. For PBX, these are placed in /etc/vx/VxICS/icsul.conf on UNIX and in the registry entry SOFTWARE\VERITAS\VxICS\logcfg on Windows.
Keynames and the values for UNIX and Windows
- LogDirectory
Provides an absolute path or relative path to a directory. No default value. If you specify a relative path for an originator ID, the path is relative to the product ID log directory that is specified by Default.LogDirectory in the log configuration file.
Caution:
When you use the LogDirectory keyname to redirect unified logs to an alternate directory, stop and restart the NetBackup services. This action makes redirection take effect.
- DebugLevel
Sets the verbosity level for the debug log messages. (Debug logs are intended for Veritas engineers.) Valid values are 0 through 6.
- DiagnosticLevel
Sets the verbosity level for the diagnostic log messages. (Diagnostic logs are intended for NetBackup administrators and users.) Valid values are 0 through 6. Zero (0) means no debug messages.
- DynaReloadInSec
Dynamically reloads debug and diagnostic settings. Integers 0-60 reload after 60 seconds. Integers greater than 60 reload at the specified number of seconds.
- LogToStdout
Sends all log messages to standard output (by default the terminal) and to the log file. Valid values are true and false (default value).
- LogToStderr
Sends the application log messages to
Stderr(by default the terminal) and to the log file. Valid values are true and false (default value).- LogToOslog
Sends the application log messages to the operating system log (syslog on UNIX and the event logs on Windows). Valid values are true and false (default value).
- RolloverMode
Specifies when log files are rolled over. If you roll over a log file, it closes the current log file and opens a new one. The purpose is to keep log file size low and allow older log files to be deleted or archived. Valid values are FileSize, LocalTime, Periodic, FileSize | LocalTime, FileSize | Periodic and None.
FileSizeindicates that the rollover occurs when the log reaches the size that the MaxLogFileSizeKB sets.FileSizeis the default value.LocalTimeindicates the log file should be rolled over one time per day at a specified time by RolloverAtLocalTime.Periodic indicates the log file should be rolled over after the number of specified seconds by RolloverAtLocalTime.
FileSize | LocalTime indicates that the log files are logged over when FileSize or LocalTime is reached, whichever occurs first.
FileSize| Periodic indicates that the log files are logged over when FileSize or Periodic is reached, whichever occurs first.None indicates that log files are not rolled over.
- MaxLogFileSizeKB
Specifies the maximum size that is allowed for the log file (in kilobytes) before rollover occurs, if the RolloverMode is set to FileSize. Valid values are 1 through 4294967295. The default value is 51200 (51.2 MB).
- RolloverPeriodInSeconds
Specifies a period of time in seconds after which the log file is rolled over, if the RolloverMode is set to Periodic. Valid values are 1 through 2147483648. The default value is 43200 (12 hours).
- RolloverAtLocalTime
Specifies the time of day at which the log file is rolled over, if the RolloverMode is set to LocalTime. Valid values are 00:00 through 23:59. The default value is 00:00 (Midnight local time).
- NumberOfLogFiles
Specifies the maximum number of files to retain in the log directory for each unified logging originator. Valid values are 1 through 4294967295.
The vxlogmgr --auto command uses NumberOfLogFiles to determine how many log files to delete or move that starts with the oldest files. For example, a log directory contains seven files that a particular originator created. NumberOfLogFiles is set to 5. The vxlogmgr --auto --del command deletes the two oldest files that the originator created.
- LogRecycle
Valid values are true, false. The default value is false. If true, the number of log files does not exceed the NumberOfLogFiles.
- OIDNames
Specifies one or more alternate names for the unified logging originator that the -o option specifies. These names can be used in place of Originator IDs when you perform searches by using the vxlogview command. Each name can be up to 80 characters in length. Multiple names can be specified, separated by a space.
- L10nLib
Specifies the absolute path and file name of the external localization library. This option is for Veritas internal use only. Use of this option can disable unified logging.
- L10nResource
Specifies the name of a localization resource that is associated with a unified logging product or originator. This option is for Veritas internal use only. Use of this option can disable unified logging.
- L10nResourceDir
This setting specifies the name of a localization resource directory that is associated with a unified logging product or originator. This option is for Veritas internal use only. Use of this option can disable unified logging.
The following four keynames operate only on UNIX systems.
- LogFilePermissions
An octal number that specifies the UNIX file permissions that are assigned to log the files that the originator created, which the -o option specified. In most cases, this option is not needed.
- SyslogIdent
Specifies a string that is attached to the beginning of every syslog message when LogToOslog is set to true. SyslogIdent can be any string up to 80 characters long. In most cases, this option is not needed.
- SyslogOpt
Specifies the syslog option value that is passed to the syslog openlog function. Log messages are directed to the UNIX syslog when LogToOslog is enabled. Valid values are 0 through 4294967295. In most cases, this option is not needed.
- SyslogFacility
Specifies the syslog facility value that is associated with log messages directed to the syslog. Log messages are directed to the syslog when LogToSyslog is enabled. In most cases, this option is not needed.
Valid values are: LOG_KERN, LOG_USER, LOG_MAIL, LOG_DAEMON, LOG_AUTH, LOG_LPR, LOG_NEWS, LOG_UUCP, LOG_CRON, LOG_LOCAL0, LOG_LOCAL1, LOG_LOCAL2, LOG_LOCAL3, LOG_LOCAL4, LOG_LOCAL5, LOG_LOCAL6, LOG_LOCAL7. The default is LOG_USER.
The following three keynames operate only on Windows systems.
- NtEventLogCategory
Specifies the category number that are associated with log messages that are directed to the Windows event log if LogToOslog is enabled. In most cases, there should be no need to use this option.
- LogFileSDDL
Specifies the Windows Security Descriptor Definition Language (SDDL) string. This string sets the Access Control List (ACL) for the log files that the originator created, which the -o option specified. In most cases, there should be no need to use this option.
- NtEventLogSourceName
Specifies the Windows Event log that log messages are directed to if the LogToOslog option is enabled on Windows. This option is for internal use only. Use of this option can disable unified logging.
EXAMPLES
Example 1 - Set the LogDirectory for NetBackup and originator ID 111 on UNIX:
# vxlogcfg -a --prodid 51216 --orgid 111 -s LogDirectory=/usr/openv/logs
Example 2 - Set the DebugLevel and DiagnosticLevel for all unified logging originators in NetBackup:
# vxlogcfg -a --prodid 51216 -o ALL -s DebugLevel=3 -s DiagnosticLevel=3
Example 3 - Set the default RolloverMode for product ID 1:
# vxlogcfg -a --prodid 1 -o Default -s RolloverMode=FileSize
Example 4 - Display configuration settings for originator 2 for product ID 1.
# vxlogcfg -l --prodid 1 --orgid 2
Example 5 - List all the originators that are configured for product ID 1.
# vxlogcfg -l --prodid 1
Example 6 - List all configured products.
# vxlogcfg -l
FILES
UNIX systems:
/usr/openv/netbackup/nblog.conf /etc/vx/VxICS/icsul.conf