NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.1)
  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.  
      bpcleanrestore
    22.  
      bpclient
    23.  
      bpclimagelist
    24.  
      bpclntcmd
    25.  
      bpclusterutil
    26.  
      bpcompatd
    27.  
      bpconfig
    28.  
      bpdbjobs
    29.  
      bpdbm
    30.  
      bpdgclone
    31.  
      bpdown
    32.  
      bpduplicate
    33.  
      bperror
    34.  
      bpexpdate
    35.  
      bpfis
    36.  
      bpflist
    37.  
      bpgetconfig
    38.  
      bpgetdebuglog
    39.  
      bpimage
    40.  
      bpimagelist
    41.  
      bpimmedia
    42.  
      bpimport
    43.  
      bpinst
    44.  
      bpkeyfile
    45.  
      bpkeyutil
    46.  
      bplabel
    47.  
      bplist
    48.  
      bpmedia
    49.  
      bpmedialist
    50.  
      bpminlicense
    51.  
      bpnbat
    52.  
      bpnbaz
    53.  
      bppficorr
    54.  
      bpplcatdrinfo
    55.  
      bpplclients
    56.  
      bppldelete
    57.  
      bpplinclude
    58.  
      bpplinfo
    59.  
      bppllist
    60.  
      bpplsched
    61.  
      bpplschedrep
    62.  
      bpplschedwin
    63.  
      bppolicynew
    64.  
      bpps
    65.  
      bprd
    66.  
      bprecover
    67.  
      bprestore
    68.  
      bpretlevel
    69.  
      bpschedule
    70.  
      bpschedulerep
    71.  
      bpsetconfig
    72.  
      bpstsinfo
    73.  
      bpstuadd
    74.  
      bpstudel
    75.  
      bpstulist
    76.  
      bpsturep
    77.  
      bptestbpcd
    78.  
      bptestnetconn
    79.  
      bptpcinfo
    80.  
      bpup
    81.  
      bpverify
    82.  
      cat_convert
    83.  
      cat_export
    84.  
      cat_import
    85.  
      configureCerts
    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.  
      mklogdir
    101.  
      msdpcldutil
    102.  
      nbauditreport
    103.  
      nbcallhomeproxyconfig
    104.  
      nbcatsync
    105.  
      NBCC
    106.  
      NBCCR
    107.  
      nbcertcmd
    108.  
      nbcertupdater
    109.  
      nbcldutil
    110.  
      nbcloudrestore
    111.  
      nbcomponentupdate
    112.  
      nbcplogs
    113.  
      nbcredkeyutil
    114.  
      nbdb_admin
    115.  
      nbdb_backup
    116.  
      nbdb_move
    117.  
      nbdb_ping
    118.  
      nbdb_restore
    119.  
      nbdb_unload
    120.  
      nbdb2adutl
    121.  
      nbdbms_start_server
    122.  
      nbdbms_start_stop
    123.  
      nbdc
    124.  
      nbdecommission
    125.  
      nbdelete
    126.  
      nbdeployutil
    127.  
      nbdevconfig
    128.  
      nbdevquery
    129.  
      nbdiscover
    130.  
      nbdna
    131.  
      nbemm
    132.  
      nbemmcmd
    133.  
      nbfindfile
    134.  
      nbfirescan
    135.  
      nbfp
    136.  
      nbftadm
    137.  
      nbftconfig
    138.  
      nbgetconfig
    139.  
      nbhba
    140.  
      nbholdutil
    141.  
      nbhostidentity
    142.  
      nbhostmgmt
    143.  
      nbhypervtool
    144.  
      nbidpcmd
    145.  
      nbimageshare
    146.  
      nbinstallcmd
    147.  
      nbjm
    148.  
      nbkmiputil
    149.  
      nbkmscmd
    150.  
      nbkmsutil
    151.  
      nboraadm
    152.  
      nborair
    153.  
      nbpem
    154.  
      nbpemreq
    155.  
      nbmlb
    156.  
      nbperfchk
    157.  
      nbplupgrade
    158.  
      nbrb
    159.  
      nbrbutil
    160.  
      nbreplicate
    161.  
      nbrepo
    162.  
      nbrestorevm
    163.  
      nbseccmd
    164.  
      nbserviceusercmd
    165.  
      nbsetconfig
    166.  
      nbsmartdiag
    167.  
      nbsnapimport
    168.  
      nbsnapreplicate
    169.  
      nbsqladm
    170.  
      nbstl
    171.  
      nbstlutil
    172.  
      nbstop
    173.  
      nbsu
    174.  
      nbsvrgrp
    175.  
      netbackup_deployment_insights
    176.  
      resilient_clients
    177.  
      restoretrace
    178.  
      stopltid
    179.  
      tldd
    180.  
      tldcd
    181.  
      tpautoconf
    182.  
      tpclean
    183.  
      tpconfig
    184.  
      tpext
    185.  
      tpreq
    186.  
      tpunmount
    187.  
      verifytrace
    188.  
      vltadm
    189.  
      vltcontainers
    190.  
      vlteject
    191.  
      vltinject
    192.  
      vltoffsitemedia
    193.  
      vltopmenu
    194.  
      vltrun
    195.  
      vmadd
    196.  
      vmchange
    197.  
      vmcheckxxx
    198.  
      vmd
    199.  
      vmdelete
    200.  
      vmoprcmd
    201.  
      vmphyinv
    202.  
      vmpool
    203.  
      vmquery
    204.  
      vmrule
    205.  
      vmupdate
    206.  
      vnetd
    207.  
      vssat
    208.  
      vwcp_manage
    209.  
      vxlogcfg
    210.  
      vxlogmgr
    211.  
      vxlogview
    212.  
      W2KOption
  3.  
    Index

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