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
vxlogmgr — manages the log files generated by the products that support Unified Logging
SYNOPSIS
{ -c | -m } -f AbsoluteDir [-a]
{ -d | -F } [-a]
{-c | -m | -A filename} -f AbsoluteDir [-p ProductID] [-o OriginatorID] [-n Days] [-t Time] [-b StartDate] [-g LogSet] [-e EndDate] [-q] [-z]
{-c | -m | -A filename} -f AbsoluteDir -w QueryString [-q] [-z]
{-d | -F | -s} [-p ProductID] [-o OriginatorID] [-n Days] [-t Time] [-b StartDate] [-g LogSet] [-e EndDate] [-q] [-z]
{-d | -F | -s} -w QueryString [-q] [-z]
-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 vxlogmgr utility manages the log files that the unified logging-enabled applications generate. Log file management includes actions such as deleting or moving the log files that are based on log management configuration settings.
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 log management action to perform.
- -A, --arch FileName
Creates an archive named FileName for the specified set of conditions. The compressed zip file requires WinZip and wzzip on Windows to produce a zip file. On UNIX, a tar utility and GnuZip are required to produce a tar.gzip file.
- -a, --auto
Retrieves the log files that are based on individual configuration settings for NumberOfLogFiles. The actions are taken based on the given action type (such as move, copy, or delete). When the -a option is specified, the other options cannot be used.
- -b, --stdate 'StartDate'
Manages the log files that are created at the specified start date.
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.
It is surrounded by single quotes in UNIX and double quotes in Windows. For example:
UNIX: --stdate '1/1/2013 12:00:00 AM'
Windows: --stdate "1/1/2013 12:00:00 AM"
- -c, --cp
Copies log files from the folder that is configured by the product to the specified folder.
- -d, --del
Deletes the log files from the folder that the product configures.
- -e, --endate 'EndDate'
Manages the log files that are created up to the specified EndDate.
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.
This option must be surrounded by single quotes in UNIX and double quotes in Windows.
UNIX: --endate '1/1/2013 12:00:00 PM'
Windows: --stdate "1/1/2013 12:00:00 AM"
- -f, --dir AbsoluteDir
Specifies the absolute name of the directory into which the log files are to be copied.
On UNIX systems, this directory must be on the same device as the
opt/openv/netbackup/logsdirectory, because the logs are hard linked rather than copied.This option is valid only with the -c option.
- -F, --flush
Deletes all log files for the host that originates this command except the most current log file. If the host that runs this command uses a shared directory, all log files for all hosts that use the same directory are removed. Only the most current file is preserved for the host that originated the flush command.
- -m, --mv
Moves log files from the folder that the product that is configured to the specified folder.
- -n --days NumberOfDays
Manages the log files that are created in last NumberOfDays days for the specified action.
- -o, --origid OriginatorID
Manages the log files that are identified by a given originator ID (OriginatorID).
- -p, --prodid ProductID
Manages the log files that are identified by a given product ID (ProductID) for the specified action. Instead of an identifier, the user can provide the product name.
- -q, --quiet
Prevents messages from being displayed (Quiet Mode).
- -s, --vw
Views the log files for a given query.
- -t, --tail hh:mm:ss
Manages the log files for the last hh:mm:ss hours.
- -v, --version
Displays the version information for this command.
- -w, --where QueryString
Retrieves a subset of logs that is based on a query string or condition (QueryString).
- -z, --displaytimezone
Displays the time zone information along with the log file display.
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 relation operators include:
< Less than
> Greater than
<= Less than and equal to
>= Greater than and equal to
= Equal to
!= Not equal to
Supported logical operators include && (logical AND) and || (logical OR).
Predefined log fields include:
PRODID Product identifier (integer or string)
ORGID Originator identifier (integer or string)
STDATE Locale-specific start date (long integer or string [such as 'mm/dd/yy'])
ENDATE Locale-specific end date (long integer or string [such as 'mm/dd/yy'])
PREVTIME Previous time (string [hh:mm:ss])
EXAMPLES
Example 1 - Automatically move the older log files that NetBackup created to the folder /tmp/nblogs. The --auto option depends on the configuration setting NumberOfLogFiles.
# vxlogmgr -m --auto --dir /tmp/nblogs
Example 2 - Delete the last 15 days of NetBackup log files:
# vxlogmgr -d --prodid NB -n 15
Example 3- Copy the log files created from date 01/22/12 by NetBackup:
# vxlogmgr -c --where "(prodid = NB) && (stdate >= '01/22/12')"
UNIX systems:
--dir /usr/openv/logs
Windows systems:
--dir c:\temp\logfiles
Example 4 - Copy the log files that are created between 10/10/11 and 10/28/11 inclusive by product ID 100:
# vxlogmgr -c --where "(PRODID == 100) && ((STDATE >= '10/10/11')
UNIX systems:
&& (ENDATE <= '10/28/11'))" --dir /usr/openv/logs
Windows systems:
&& (ENDATE <= '10/28/11'))" --dir c:\temp\logfiles