Veritas NetBackup™ Commands Reference Guide

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