Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (9.0.0.1, 9.0)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
    5.  
      IPV6 updates
  2. Appendix A. NetBackup Commands
    1.  
      acsd
    2.  
      add_media_server_on_clients
    3.  
      backupdbtrace
    4.  
      backuptrace
    5.  
      bmrc
    6.  
      bmrconfig
    7.  
      bmrepadm
    8.  
      bmrprep
    9.  
      bmrs
    10.  
      bmrsrtadm
    11.  
      bp
    12.  
      bparchive
    13.  
      bpbackup
    14.  
      bpbackupdb
    15.  
      bpcatarc
    16.  
      bpcatlist
    17.  
      bpcatres
    18.  
      bpcatrm
    19.  
      bpcd
    20.  
      bpchangeprimary
    21.  
      bpclient
    22.  
      bpclimagelist
    23.  
      bpclntcmd
    24.  
      bpclusterutil
    25.  
      bpcompatd
    26.  
      bpconfig
    27.  
      bpdbjobs
    28.  
      bpdbm
    29.  
      bpdgclone
    30.  
      bpdown
    31.  
      bpduplicate
    32.  
      bperror
    33.  
      bpexpdate
    34.  
      bpfis
    35.  
      bpflist
    36.  
      bpgetconfig
    37.  
      bpgetdebuglog
    38.  
      bpimage
    39.  
      bpimagelist
    40.  
      bpimmedia
    41.  
      bpimport
    42.  
      bpinst
    43.  
      bpkeyfile
    44.  
      bpkeyutil
    45.  
      bplabel
    46.  
      bplist
    47.  
      bpmedia
    48.  
      bpmedialist
    49.  
      bpminlicense
    50.  
      bpnbat
    51.  
      bpnbaz
    52.  
      bppficorr
    53.  
      bpplcatdrinfo
    54.  
      bpplclients
    55.  
      bppldelete
    56.  
      bpplinclude
    57.  
      bpplinfo
    58.  
      bppllist
    59.  
      bpplsched
    60.  
      bpplschedrep
    61.  
      bpplschedwin
    62.  
      bppolicynew
    63.  
      bpps
    64.  
      bprd
    65.  
      bprecover
    66.  
      bprestore
    67.  
      bpretlevel
    68.  
      bpschedule
    69.  
      bpschedulerep
    70.  
      bpsetconfig
    71.  
      bpstsinfo
    72.  
      bpstuadd
    73.  
      bpstudel
    74.  
      bpstulist
    75.  
      bpsturep
    76.  
      bptestbpcd
    77.  
      bptestnetconn
    78.  
      bptpcinfo
    79.  
      bpup
    80.  
      bpverify
    81.  
      cat_convert
    82.  
      cat_export
    83.  
      cat_import
    84.  
      configureCerts
    85.  
      configureCertsForPlugins
    86.  
      configureMQ
    87.  
      configurePorts
    88.  
      configureWebServerCerts
    89.  
      create_nbdb
    90.  
      csconfig cldinstance
    91.  
      csconfig cldprovider
    92.  
      csconfig meter
    93.  
      csconfig reinitialize
    94.  
      csconfig throttle
    95.  
      duplicatetrace
    96.  
      importtrace
    97.  
      jbpSA
    98.  
      jnbSA
    99.  
      ltid
    100.  
      manageClientCerts
    101.  
      mklogdir
    102.  
      nbauditreport
    103.  
      nbcatsync
    104.  
      NBCC
    105.  
      NBCCR
    106.  
      nbcertcmd
    107.  
      nbcertupdater
    108.  
      nbcldutil
    109.  
      nbcloudrestore
    110.  
      nbcomponentupdate
    111.  
      nbcplogs
    112.  
      nbcredkeyutil
    113.  
      nbdb_admin
    114.  
      nbdb_backup
    115.  
      nbdb_move
    116.  
      nbdb_ping
    117.  
      nbdb_restore
    118.  
      nbdb_unload
    119.  
      nbdb2adutl
    120.  
      nbdbms_start_server
    121.  
      nbdbms_start_stop
    122.  
      nbdc
    123.  
      nbdecommission
    124.  
      nbdelete
    125.  
      nbdeployutil
    126.  
      nbdevconfig
    127.  
      nbdevquery
    128.  
      nbdiscover
    129.  
      nbdna
    130.  
      nbemm
    131.  
      nbemmcmd
    132.  
      nbfindfile
    133.  
      nbfirescan
    134.  
      nbftadm
    135.  
      nbftconfig
    136.  
      nbgetconfig
    137.  
      nbhba
    138.  
      nbholdutil
    139.  
      nbhostidentity
    140.  
      nbhostmgmt
    141.  
      nbhypervtool
    142.  
      nbidpcmd
    143.  
      nbimageshare
    144.  
      nbinstallcmd
    145.  
      nbjm
    146.  
      nbkmiputil
    147.  
      nbkmscmd
    148.  
      nbkmsutil
    149.  
      nboraadm
    150.  
      nborair
    151.  
      nbpem
    152.  
      nbpemreq
    153.  
      nbmlb
    154.  
      nbperfchk
    155.  
      nbplupgrade
    156.  
      nbrb
    157.  
      nbrbutil
    158.  
      nbregopsc
    159.  
      nbreplicate
    160.  
      nbrepo
    161.  
      nbrestorevm
    162.  
      nbseccmd
    163.  
      nbsetconfig
    164.  
      nbsnapimport
    165.  
      nbsnapreplicate
    166.  
      nbsqladm
    167.  
      nbstl
    168.  
      nbstlutil
    169.  
      nbstop
    170.  
      nbsu
    171.  
      nbsvrgrp
    172.  
      resilient_clients
    173.  
      restoretrace
    174.  
      stopltid
    175.  
      tldd
    176.  
      tldcd
    177.  
      tpautoconf
    178.  
      tpclean
    179.  
      tpconfig
    180.  
      tpext
    181.  
      tpreq
    182.  
      tpunmount
    183.  
      verifytrace
    184.  
      vltadm
    185.  
      vltcontainers
    186.  
      vlteject
    187.  
      vltinject
    188.  
      vltoffsitemedia
    189.  
      vltopmenu
    190.  
      vltrun
    191.  
      vmadd
    192.  
      vmchange
    193.  
      vmcheckxxx
    194.  
      vmd
    195.  
      vmdelete
    196.  
      vmoprcmd
    197.  
      vmphyinv
    198.  
      vmpool
    199.  
      vmquery
    200.  
      vmrule
    201.  
      vmupdate
    202.  
      vnetd
    203.  
      vssat
    204.  
      vwcp_manage
    205.  
      vxlogcfg
    206.  
      vxlogmgr
    207.  
      vxlogview
    208.  
      W2KOption
  3.  
    Index

Name

vxlogview — display logs generated by the unified logging component

SYNOPSIS

vxlogview[-A] [-b StartDate] [-e EndDate] [-D] [-G Directory] [-g LogSet] [-I] [-i FileID] [-K HostName] [-L SeverityLevel] [-m Entity] [-N Level MsgTypes] [-n NumberofDays] [-o OriginatorID] [-P ProcessID] [-p ProductID] [-r Result] [-s Subject] [-T ThreadID] [-t hh:mm:ss] [-X ContextToken] [-y]

vxlogview -a [-p ProductID] {[-d DisplayOption,...] [-R ResourceDirectory] [-z TimeZone] [-l Locale]}

vxlogview -q QueryName -f FileName {[-d DisplayOption,...][-R ResourceDirectory] [-z TimeZone] [-l Locale]}

vxlogview -p ProductID -g LogSet | -i FileID {[-d DisplayOption,...] [-R ResourceDirectory] [-z TimeZone] [-l Locale]}

vxlogview -p ProductID -w queryString {[-d DisplayOption,...] [-R ResourceDirectory] [-z TimeZone] [-l Locale]}

vxlogview -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.

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 Veritas 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/.conf file (UNIX) and the install_path\VERITAS\msg\LC.CONF file (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 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/.conf file (UNIX) and the install_path\VERITAS\msg\LC.CONF file (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 (-p ProductID) and file ID (-i FileID) 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'

SEE ALSO

See vxlogcfg.

See vxlogmgr.