Important Update: Cohesity Products Documentation
All Cohesity product documentation are now managed via the Cohesity Docs Portal: https://docs.cohesity.com/HomePage/Content/home.htm. Some documentation available here may not reflect the latest information or may no longer be accessible.
NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpcleanrestore
- 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
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCerts
- configureMQ
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- mklogdir
- msdpcldutil
- msdpimgutil
- nbauditreport
- nbcallhomeproxyconfig
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcmdrun
- nbcomponentupdate
- nbcplogs
- nbcredkeyutil
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdb2adutl
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbepicfile
- nbfindfile
- nbfirescan
- nbfp
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhsmcmd
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nblogparser
- nbmariadb
- nbmysql
- nbmlb
- nborair
- nboracmd
- nbpem
- nbpemreq
- nbmariadb
- nbmlb
- nbperfchk
- nbpgsql
- nbplupgrade
- nbrb
- nbrbutil
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbshvault
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqlcmd
- nbsqlite
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- netbackup_deployment_insights
- resilient_clients
- restoretrace
- stopltid
- tiermover
- tldd
- tldcd
- 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
vxlogview — display logs generated by the unified logging component
SYNOPSIS
[-A] [-b StartDate] [-e EndDate] [-D] [-G Directory] [-g LogSet] [-I] [-i FileID] [-K HostName] [-L SeverityLevel] [-m Entity] [-N LevelMsgTypes] [-n NumberofDays] [-o OriginatorID] [-P ProcessID] [-p ProductID] [-r Result] [-s Subject] [-T ThreadID] [-t hh:mm:ss] [-X ContextToken] [-y]
-a [-p ProductID] {[-d DisplayOption,...] [-R ResourceDirectory] [-z TimeZone] [-l Locale]}
-q QueryName -f FileName {[-d DisplayOption,...][-R ResourceDirectory] [-z TimeZone] [-l Locale]}
-p ProductID -g LogSet | -i FileID {[-d DisplayOption,...] [-R ResourceDirectory] [-z TimeZone] [-l Locale]}
-p ProductID -w queryString {[-d DisplayOption,...] [-R ResourceDirectory] [-z TimeZone] [-l Locale]}
-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
The vxlogview utility lets you view the logs that unified logging generates. Search criteria can be specified by using command-line options to view specific logs.
Only the following types of users can access the logs: root and service users in Linux systems, and administrative users in Windows systems.
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 name format and the logging originator IDs, refer to the NetBackup Logging Reference Guide.
OPTIONS
Specify the logs you want to view.
- -A, --audit
Displays the audit messages.
- -a, --all
Displays all log messages from log files that multiple Cohesity products generate.
- -b, --stdate StartDate
Displays the messages that are logged at the given start date and time.
The required date and time values format in NetBackup commands varies according to your locale. The
/usr/openv/msg/.conffile (UNIX) and theinstall_path\msg\LC.CONFfile (Windows) contain information such as the date-time formats for each supported locale. The files contain specific instructions on how to add or modify the list of supported locales and formats.See the "About specifying the locale of the NetBackup installation" topic in the NetBackup Administrator's Guide, Volume II for more information.
Surround the date by single quotes in UNIX and double quotes in Windows. For example:
-b '1/1/2013 12:00:00 AM'
If -b is not specified, messages are displayed from the beginning of the log file to the given end time (see the -e option).
- -D, --debug
Displays debug log messages.
- -d, --display DisplayOption,...
Displays the specified message fields. Separate multiple DisplayOptions with commas.
DisplayOption may be one or more of the following:
D - Display date
T - Display timestamp
m - Display message type
p - Display process ID
t - Display thread ID
P - Display product ID
O - Display originator ID
c - Display context token
s - Display application log entry severity
U - Display timestamp in YYYY-MM-DDThh:mm:ss.mmm+xx:yy format
H - Display hostname
u - Display application or diagnostic Unique Message ID
x - Display actual log message text
w - Display who logged the diagnostic or the debug message
i - Display short name for a product
o - Display short name for an originator
all - Display all fields of the log record
If -d is not specified, the following fields are displayed by default.
- Date
- Time
- Who (for diagnostic and debug messages only)
- Severity (application messages only)
- UMI (application and diagnostic messages only)
- message text
- -e, --endate EndDate
Displays the messages that are logged up to a given end day and time.
The required date and time values format in NetBackup commands varies according to your locale. The
/usr/openv/msg/.conffile (UNIX) and theinstall_path\msg\LC.CONFfile (Windows) contain information such as the date-time formats for each supported locale. The files contain specific instructions on how to add or modify the list of supported locales and formats.See the "About specifying the locale of the NetBackup installation" topic in the NetBackup Administrator's Guide, Volume II for more information.
Surround the date with single quotes in UNIX and double quotes in Windows. For example:
--endate '1/1/2013 12:00:00 PM'
If the -e option is unspecified, vxlogview displays messages from the given start date-time (see the -b option) to the end of the log file.
- -f, --filename FileName
Specifies the path name and file name of a file that contains one or more queries. Use with the -q option.
- -G, --logdir Directory
Displays logs from the specified directory instead of a configured log directory. An absolute path must be specified for the directory.
- -g, --logset LogSet
Displays log configuration settings for the specified LogSet.
- -I, --diag
Displays diagnostic log messages.
- -i, --fileid FileID
Displays the messages that a given file ID or shared originator ID logged. It searches only the log files that the specified process has created. By limiting the log files that it has to search, vxlogview returns a result faster. By comparison, the vxlogview -o option searches all unified log files for messages that the specified process logs.
- -K, --hostname HostName
Displays the messages that the specified host name logged.
- -L, --app -C | -E | -F | -M | -W
Displays the application log messages. The following parameters can be used with -L to specify the severity level:
-C, --crit : A critical error has occurred which may impact the availability of the application.
-E, --err : An error has occurred that does not affect the entire application.
-F, --info : An informational message.
-M, --emerg : An emergency condition exists that may result in an operating system failure or shutdown.
-W, --warning : A warning is issued for a problem that has been detected.
- -l, --locale Locale
Displays the messages in the specified locale. The default is English. The messages are displayed in the current system locale if this option is not given.
- -m, --who Entity
Displays the messages that are logged by the given entity method name or function name.
- -N, --level Level -D | -I
Displays debug messages (-D) or diagnostic log messages (-I) for a given level (Level).
- -n, --days NumberOfDays
Displays the messages that are logged for the last NumberOfDays days.
- -o, --orgid OriginatorID
Displays the messages that the specified originator ID has logged. You can use the ID number or the short name for the originator. For example, the Policy Execution Manager can be specified by nbpem or by 116, its originator ID number.
- -P, --pid ProcessID
Displays the messages that the specified process ID has logged.
- -p, --prodid ProductID
Displays the messages that the product (identified by a given product ID) logged. Instead of an identifier, the user can provide the abbreviated name of product. The NetBackup product ID is 51216, and the PBX product ID is 50936.
- -R, --resdir ResourceDirectory
Uses the resources from the specified directory instead of a configured localization resource directory.
- -r, --result Result
Displays the audit messages that have the specified result. Result can be either 0 or 1.
- -S, --tailloop
Continuously displays the new messages that a given product ID and file ID pair log. The product ID (-pProductID) and file ID (-iFileID) must accompany the tailloop option (-S) on the command line. The file ID can be a shared originator ID or an originator ID that is not shared with any other ID. tailloop starts by displaying to the console the last 10 messages that have been logged. It then displays any new log messages. Use Ctrl-C at any time to stop the loop.
- -s, --subject Subject
Displays the audit messages that have the specified Subject.
- -T, --tid ThreadID
Displays the messages that the specified thread ID has logged.
- -t, --tail hh:mm:ss
Displays the messages for the last hh:mm:ss time period.
- -v, --version
Displays the version information for this command.
- -w, --where QueryString
Specifies a WHERE clause to use when you query the log messages such that a subset of messages can be displayed. For more detail on QueryString, refer to the NetBackup Logging Reference Guide.
- -X, --ctx ContextToken
Displays the messages that belong to the given context instance. Context tokens identify context instances. If the context token is specified as "all," it displays all of the context names and associated tokens.
- -y, --displayhost
Displays the host name with each displayed log message. Use this option if the log files come from different hosts and you want to display which message came from which host.
- -z, --timezone GMT+hh:ss | GMT-hh:ss
Displays the messages with time adjusted as per the given timezone.
EXIT STATUS
The following exit values are returned:
0 -- Successful completion.
-1 -- An error occurred.
QUERY STRINGS
A query string is a text expression, similar to a database WHERE clause, that is used to retrieve log entries from the Unified Logging system. The expression is a combination of relational operators, constant integers, constant strings, and names of log fields that evaluate to a single value. Logical operators, such as AND and OR, are used to group expressions.
Supported relational operators include: < (less than), > (greater than) <= (less than or equal to, >= (greater than and equal to), = (equal to), and != (not equal to).
Supported logical operators include && (logical AND) and || (logical OR).
Predefined log fields can be in all uppercase or all lowercase (for example: PID | pid). These fields consist of the following:
CTXTOK -- Context token (string)
ENDATE -- Locale-specific end date (long integer or string)
FILEID -- Shared originator ID (integer)
HOSTNAME -- Name of source host (string with quotes)
LEVEL -- Debug and diagnostic level. Default is to display all (integer 0-6)
MSGTYPE -- The following message types are supported:
DEBUG | debug DIAG | diag APP | app AUDIT | audit
ORGID -- Originator identifier (integer or string)
PID -- Process Identifier (integer)
PREVTIME -- Previous time (string hh:mm:ss)
PRODID -- Product identifier (integer or string)
RETURNVAL -- The audit message outcome field (0 or 1)
SEV -- Severity level. The following severity types are supported:
INFO | info WARNING | warning ERR | err CRIT | crit EMERG | emerg
STDATE -- Locale-specific start date (long integer or string)
SUBJECT -- Audit message subject field (string)
TID -- Thread ID (integer)
WHO -- Who logged the message (string)
EXAMPLES
The following examples are valid for UNIX, which uses single quotes to enclose option arguments. In Windows, use double quotes.
Example 1 - Display the log messages for all the installed products:
# vxlogview -a
Example 2 - Display the log messages for PBX (product ID 50936). You must be an authorized user with administrator (root) privileges. It displays only the date, time, message type, and message text:
# vxlogview --prodid 50936 --display D,T,m,x
Example 3 - Display the log messages for NetBackup that were logged between the dates 11/18/10 and 11/21/10:
# vxlogview --where "(prodid = 'NB') && (stdate >= '11/18/10 0:0:0 AM' && endate <= '11/21/10 10:12:00 AM')"
Example 4 - Display the log messages that were created on or after the date and time 1/03/13, 11:00:00 a.m.:
# vxlogview -b '1/03/13 11:00:00 AM'
Example 5 - Display the log messages that were logged within the last hour:
# vxlogview --tail 1:00:00
Example 6 - Display the audit log messages that have a result of 0:
# vxlogview --audit -r 0
Example 7 - Display the context log messages for the "job_context" instance:
# vxlogview --ctx 'jobid=4'