Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.2)
  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.  
      configureCertsForPlugins
    85.  
      configureMQ
    86.  
      configurePorts
    87.  
      configureWebServerCerts
    88.  
      create_nbdb
    89.  
      csconfig cldinstance
    90.  
      csconfig cldprovider
    91.  
      csconfig meter
    92.  
      csconfig throttle
    93.  
      csconfig reinitialize
    94.  
      duplicatetrace
    95.  
      importtrace
    96.  
      jbpSA
    97.  
      jnbSA
    98.  
      ltid
    99.  
      manageClientCerts
    100.  
      mklogdir
    101.  
      nbauditreport
    102.  
      nbcatsync
    103.  
      NBCC
    104.  
      NBCCR
    105.  
      nbcertcmd
    106.  
      nbcertupdater
    107.  
      nbcldutil
    108.  
      nbcloudrestore
    109.  
      nbcomponentupdate
    110.  
      nbcplogs
    111.  
      nbdb_admin
    112.  
      nbdb_backup
    113.  
      nbdb_move
    114.  
      nbdb_ping
    115.  
      nbdb_restore
    116.  
      nbdb_unload
    117.  
      nbdbms_start_server
    118.  
      nbdbms_start_stop
    119.  
      nbdc
    120.  
      nbdecommission
    121.  
      nbdelete
    122.  
      nbdeployutil
    123.  
      nbdevconfig
    124.  
      nbdevquery
    125.  
      nbdiscover
    126.  
      nbdna
    127.  
      nbemm
    128.  
      nbemmcmd
    129.  
      nbfindfile
    130.  
      nbfirescan
    131.  
      nbftadm
    132.  
      nbftconfig
    133.  
      nbgetconfig
    134.  
      nbhba
    135.  
      nbholdutil
    136.  
      nbhostidentity
    137.  
      nbhostmgmt
    138.  
      nbhypervtool
    139.  
      nbimageshare
    140.  
      nbinstallcmd
    141.  
      nbjm
    142.  
      nbkmsutil
    143.  
      nboraadm
    144.  
      nborair
    145.  
      nbpem
    146.  
      nbpemreq
    147.  
      nbperfchk
    148.  
      nbplupgrade
    149.  
      nbrb
    150.  
      nbrbutil
    151.  
      nbregopsc
    152.  
      nbreplicate
    153.  
      nbrepo
    154.  
      nbrestorevm
    155.  
      nbseccmd
    156.  
      nbsetconfig
    157.  
      nbsnapimport
    158.  
      nbsnapreplicate
    159.  
      nbsqladm
    160.  
      nbstl
    161.  
      nbstlutil
    162.  
      nbstop
    163.  
      nbsu
    164.  
      nbsvrgrp
    165.  
      resilient_clients
    166.  
      restoretrace
    167.  
      stopltid
    168.  
      tl4d
    169.  
      tl8d
    170.  
      tl8cd
    171.  
      tldd
    172.  
      tldcd
    173.  
      tlhd
    174.  
      tlhcd
    175.  
      tlmd
    176.  
      tpautoconf
    177.  
      tpclean
    178.  
      tpconfig
    179.  
      tpext
    180.  
      tpreq
    181.  
      tpunmount
    182.  
      verifytrace
    183.  
      vltadm
    184.  
      vltcontainers
    185.  
      vlteject
    186.  
      vltinject
    187.  
      vltoffsitemedia
    188.  
      vltopmenu
    189.  
      vltrun
    190.  
      vmadd
    191.  
      vmchange
    192.  
      vmcheckxxx
    193.  
      vmd
    194.  
      vmdelete
    195.  
      vmoprcmd
    196.  
      vmphyinv
    197.  
      vmpool
    198.  
      vmquery
    199.  
      vmrule
    200.  
      vmupdate
    201.  
      vnetd
    202.  
      vssat
    203.  
      vwcp_manage
    204.  
      vxlogcfg
    205.  
      vxlogmgr
    206.  
      vxlogview
    207.  
      W2KOption

Name

nbcplogs — copy all NetBackup logs to a designated destination

SYNOPSIS

nbcplogs destination [-s mm/dd/yyyy-hh:mm:ss | mm/dd-hh:mm] [-e mm/dd/yyyy-hh:mm:ss | mm/dd-hh:mm] [-d valued | valueh | valuem] [--tmpdir=pathname] [--use-reg-cmd 32|64] [--list-products] [--list-subproducts logproducts] [--nbsu | --no-nbsu] [--help-long] [--write-config] [--compress-before-bundle][--filecopy][--fast]

On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/support/

On Windows systems, the directory path to this command is install_path\NetBackup\bin\support\

DESCRIPTION

The nbcplogs command copies logs from various locations in the NetBackup system to a common area where you can more easily troubleshoot a problem. This utility lets you determine what logs are copied. To reduce the size of the copied logs, you can use the time frame option to specify a start time and an end time.

If you have a case ID provided by Technical Support in the form ########, rename the log files with the case ID number. Then manually upload the files to the Veritas Evidence server. More information is available:

http://www.veritas.com/docs/000097935

For more about nbcplogs, see the NetBackup Troubleshooting Guide.

OPTIONS

--compress-before-bundle

Compresses the log files, then bundles them and adds them to the tarball. Compressing the files first instead of after the files are copied reduces peak disk usage.

destination

Specifies the destination of the logs to be collected.

-d | --duration valued | valueh | valuem

Sets the duration of the log data to be collected. The time units of the duration can be in d[ays], h[ours], or m[in]. For example:

--duration 5h /tmp/logs
--fast

Fast search uses a binary search to strip out the lines that are outside the time frame of the file. This mechanism is useful when you copy large log files such as bpdbm. This option is rarely needed and should be used with caution.

--filecopy

File copy is the default condition. It copies the entire log file.

--help-long

Displays a complete set of options available for the nbcplogs command.

-l | --logslog_type[.sub] [,...]

Limits the log types that are collected to only those specified on the command line. The sub option lets you specify a sub-category of a log type. If no log types are specified, all log types are copied.

--list-products

Lists all the possible logs that can be reported on.

--list-subproducts log_product

Lists all the log subproducts for the specified log product.

--nbsu | --no-nbsu

Enables (--nbsu) or disables (--no-nbsu) running the nbsu utility as part of the nbcplogs command operation. The nbsu command utility gathers a wide range of diagnostic information that is helpful when it is used with the log data that is gathered.

The default condition is that nbsu runs and creates a support package to send to Technical Support.

-s | --start mm/dd/yyyy-hh:mm:ss | mm/dd-hh:mm -e | --end mm/dd/yyyy-hh:mm:ss | mm/dd-hh:mm

Sets the start time (-s) or the end time (-e) for the collection of logs.

The -s option specifies a start date and time for the logs. If no corresponding -e option is used, the utility collects all log data from the start time to the present.

The -e option specifies an end date and time for the logs. If no corresponding -s option is used, the utility collects all log data present in the log files up to the end date.

If no start time or end time is specified, the default time period is the last 24 hours.

--tmpdir=pathname

Specifies the staging directory the command uses when it bundles the logs into a tarball.

If --tmpdir is not specified, the default staging directory is used. That directory is:

Windows: C:\temp

UNIX or Linux: /tmp

--use-reg-cmd [32|64]

This option is required when you run the nbcplogs command on a non-English Windows server.

--write-config

Lets you to view or modify nbcplogs configuration values. This option creates a nbcplogs configuration file (nbcplogs.conf), which you can then edit.

EXAMPLES

Example 1 - Copy all volmgr logs between 1:00 and 2:00.

# nbcplogs --start 01:00 --end 02:00 --logs volmgr /tmp/logs

Example 2 - Copy the last 24 hours of nbpem logs and bpdbm logs, and run the nbsu utility:

# nbcplogs -l nbpem,bpdbm

Example 3 - Display the complete set of options available to use with the nbcplogs command:

# nbcplogs --help-long

Example 4 - List all the log directories available on your system:

# nbcplogs --list-products
*  products:
*    db      : /usr/openv/db/log
*    dberror : /usr/openv/netbackup/db/error
*    nbu     : /usr/openv/netbackup/logs
*    pbx     : /opt/VRTSpbx/log
*    trylogs : /usr/openv/netbackup/db/jobs/trylogs
*    vault   : /usr/openv/netbackup/vault/sessions
*    volmgr  : /usr/openv/volmgr/debug
*    vxul    :

Example 5 - Display the complete set of log subproducts available for the nbcplogs command:

# nbcplogs --list-subproducts vxul*  "vxul" subproducts:
*  vxul.111 = /usr/openv/logs/nbemm aliases: 111, nbemm, vxul.nbemm
*  vxul.116 = /usr/openv/logs/nbpem aliases: 116, nbpem, vxul.nbpem
*  vxul.117 = /usr/openv/logs/nbjm  aliases: 117, nbjm, vxul.nbjm
*  vxul.118 = /usr/openv/logs/nbrb  aliases: 118, nbrb, vxul.nbrb
*  vxul.119 = /usr/openv/logs/bmrd  aliases: 119, bmrd, vxul.bmrd...