Veritas NetBackup™ Commands Reference Guide

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

Name

nbcomponentupdate — update the JRE version

SYNOPSIS

nbcomponentupdate -product [NetBackup | OpsCenterServer | OpsCenterAgent | OpsCenterViewBuilder | RemoteJavaConsole] -component value -path component_path | -revert [-logpath path] [-help | -?] [-dryrun | -force] [-version value] [-skipmajorversioncheck]

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

On Windows systems, the directory path to this command is install_path\netbackup\bin\goodies\

DESCRIPTION

This utility lets you upgrade the installed version of the JRE in Veritas NetBackup and OpsCenter products. This utility does not support JRE update for NetBackup Plug-in for VMware vCenter.

The NetBackup installed version of the JRE is the supported major version for that NetBackup release. Use this utility to update to a minor version of the supported major JRE version. For example, if NetBackup 8.0 installed JRE 1.8.0.31, the supported major version is 1.8. Use this utility to update to JRE 1.8.0.92.

Veritas recommends that you update to another major JRE version only if the JRE vendor declares an end-of-life for the installed JRE version. For example, if the JRE vendor declares an end-of-life for JRE 1.8, which is also the installed JRE version in your environment, update to JRE 1.9.

Close the product, such as NetBackup, before you attempt to update the JRE. If the product is active when you attempt the update, the utility exits with an error message that requests you to close the product.

Caution:

Do not stop the utility while the JRE update is in progress. This action can cause the product that uses the JRE, such as NetBackup, to become unstable.

If there are additional versions of the JRE installed on your system for different applications, the NetBackup JRE does not interfere with them. The NetBackup JRE does not provide integration with web browsers and does not allow Java Applets or Web Start to run. For that reason, the NetBackup JRE cannot be used in a browser-based attack that uses Java Applet or Web Start vulnerabilities.

More information about the nbcomponentupdate command is available.

https://www.veritas.com/support/en_US/article.000115043

If you use OpsCenter or the Remote Administration Console, the location of the command is as follows:

  • OpsCenter Server

    UNIX/Linux: SYMCOpsCenterServer/bin/

    Windows: install_path\server\bin\

  • OpsCenter Agent

    Windows: install_path\agent\bin\

  • OpsCenter View Builder

    Windows: install_path\viewbuilder\bin

  • Remote Administration Console

    Windows: install_path\java

OPTIONS

-component value

Updates the specified component. The only valid value for this option is JRE.

-dryrun

Runs a test to verify if the operation is allowed.

-force

Skips the interactive mode. If you use -force and the -product is RemoteJavaConsole, you must use the -version option.

-help | -?

Prints the help.

-logpath path

Specifies the location of the log files. By default, the logs are generated in the system temp folder. On a Windows computer, you can specify the path %temp%nbcomponentupdate_date_time.log. Please note that the behavior of the option depends on what is specified.

  • If the path you specify is a folder or a drive, the log file is generated in the specified location. If you specify -logpath as C:\logs, the log file is C:\logs\nbcomponentupdate_date_time.log.

  • If you have specified a file name for -logpath and the file does not exist in that location, a new file is created with the specified name. If you specify C:\samplelogfile.log, the logs are generated in the C:\samplelogfile.log file.

  • If you have specified a file name in the log path and the file exists in that location, the logs are appended to that file. If you specify -logpath as C:\samplelogfile.log, the logs are appended to the samplelogfile.log file.

Note:

Do not specify a network path such as an NFS or a CIFS share for the log path.

-path component_path

Specifies the path where the new version of JRE for the upgrade is located. The component_path is either the installed JRE location or the extracted JRE folder.

-product [NetBackup | OpsCenterServer | OpsCenterAgent | OpsCenterViewBuilder | RemoteJavaConsole]

Updates the JRE version of the specified product. This option is not case-sensitive. If the selected product is the NetBackup Remote Administration Console, the command lists all installed Remote Administration Console versions. You are then prompted to select a supported version of Remote Administration Console you want to update.

-revert

Reverts the currently installed update of the JRE to the previously installed JRE version.

-skipmajorversioncheck

Allows the utility to perform a JRE update to any higher major or higher minor version.

-version value

The version of the Remote Java Console that you want to upgrade or revert. This option is only available if you specify RemoteJavaConsole for the -product option. This limitation is because only the Remote Java Console maintains multiple versions that you can upgrade or revert.

If you do not specify this option, the utility lists all the installed Remote Java Console version. The utility then prompts you to select a supported version of the console to upgrade or revert. If you use the -force option, you must specify the -version option.

EXAMPLES

Example 1: A dry run for an OpsCenter upgrade

C:\Program Files\Symantec\OpsCenter\server\bin>nbcomponentupdate -product OpsCenterServer 
-component jre -path f:\JRE_Download\jre1.8.0_66 -logpath %temp%\nbcomponentupdate.log 
-dryrun

Command line: C:\Program Files\Symantec\OpsCenter\server\bin\nbcomponentupdate.exe -product 
OpsCenterServer -component jre -path f:\JRE_Download\jre1.8.0_66 -logpath C:\Users\ADMINI~1
\AppData\Local\Temp\2\nbcomponentupdate.log -dryrun

Java Runtime Envrionment(JRE) version installed with product 'Veritas OpsCenter Server'
  : 1.8.0_31 (64bit)
Java Runtime Envrionment(JRE) version found at path 'f:\JRE_Download\jre1.8.0_66'
  : 1.8.0_66 (64bit)

This utility will update the Java Runtime Envrionment(JRE) binaries present at 'C:\Program 
Files\Symantec\OpsCenter\server\jre' path

This utility may start and stop all (or some) services depending upon the present state of 
services.

Upgrade operation is permitted.
Please re-run this command without 'dryrun' option.

Example 2: An interactive update for NetBackup

$ /usr/openv/netbackup/bin/goodies/nbcomponentupdate -product NetBackup -component jre 
-path /downloadedJre/jre1.8.0_91/

Command line: /usr/openv/netbackup/bin/goodies/nbcomponentupdate -product NetBackup 
-component jre -path /downloadedJre/jre1.8.0_91/

Java Runtime Envrionment(JRE) version installed with product 'Veritas NetBackup'
  : 1.8.0_31 (64bit)
Java Runtime Envrionment(JRE) version found at path '/downloadedJre/jre1.8.0_91'
  : 1.8.0_91 (64bit)

This utility will update the Java Runtime Envrionment(JRE) binaries present at '/usr/openv/
java/jre' path

This utility may start and stop all (or some) services depending upon the present state of 
services.

Do you want to continue (Y[es]/N[o]): Yes

Performing upgrade steps ...

[1/4] Pre-installation step is in progress
[1/4] Pre-installation step is completed successfully

[2/4] Installation step is in progress
[2/4] Installation step is completed successfully

[3/4] Post-installation step is in progress
[3/4] Post-installation step is completed successfully

[4/4] Commit and Cleanup step is in progress
[4/4] Commit and Cleanup step is completed successfully


After upgrading, Java Runtime Envrionment(JRE) version installed with product 'Veritas 
NetBackup'                                 : 1.8.0_91 (64bit)

Successfully upgraded Java Runtime Envrionment(JRE) for Veritas NetBackup.
The log file generated for this operation is /tmp/logs/nbcomponentupdate/
nbcomponentupdate_12-08-2016_16.15.13.log

Example 3: Non-interactive revert for NetBackup

# ./nbcomponentupdate -product NetBackup -component jre -revert -force
Command line: /usr/openv/netbackup/bin/goodies/nbcomponentupdate -product NetBackup 
-component jre -revert -force

Java Runtime Envrionment(JRE) version installed with product 'Veritas NetBackup'
  : 1.8.0_91 (64bit)
After revert, Java Runtime Envrionment(JRE) version with product 'Veritas NetBackup'
  : 1.8.0_31 (64bit)

This utility will update the Java Runtime Envrionment(JRE) binaries present at '/usr/openv/
java/jre' path

This utility may start and stop all (or some) services depending upon the present state of 
services.

Performing revert steps ...

[1/4] Pre-installation step is in progress
[1/4] Pre-installation step is completed successfully

[2/4] Installation step is in progress
[2/4] Installation step is completed successfully

[3/4] Post-installation step is in progress
[3/4] Post-installation step is completed successfully

[4/4] Commit and Cleanup step is in progress
[4/4] Commit and Cleanup step is completed successfully

After reverting, Java Runtime Envrionment(JRE) version installed with product 'Veritas NetBackup'
  : 1.8.0_31 (64bit)

Successfully reverted Java Runtime Envrionment(JRE) for Veritas NetBackup.
The log file generated for this operation is /tmp/logs/nbcomponentupdate/
nbcomponentupdate_22-08-2016_13.07.42.log

Example 4: An interactive revert for Remote Java Console

D:\sandbox>nbcomponentupdate.exe -product remotejavaconsole -component jre -revert 
-logpath D:\LogFolder
Command line: D:\sandbox\nbcomponentupdate.exe -product remotejavaconsole -component jre 
-revert -logpath D:\LogFolder


Following NetBackup Remote Java Console instances found on the host are supported by the 
utility:

1> NetBackup - Java (NB-Java) 7.7           JRE : 1.8.0_31 (64bit)

2> NetBackup - Java (NB-Java) 7.7.1         JRE : 1.8.0_31 (64bit)

3> NetBackup - Java (NB-Java) 7.7.2         JRE : 1.8.0_77 (64bit)

** NOTE **
Unsupported versions of Veritas NetBackup Remote Java Console found on the host:
NetBackup - Java (NB-Java) 7.6, NetBackup - Java (NB-Java) 7.5

Please enter choice [(1 - 3) or Q(uit) to exit]: 3

After revert, Java Runtime Envrionment(JRE) version with product 'Veritas NetBackup Remote 
Java Console'         : 1.8.0_31 (64bit)

This utility will update the Java Runtime Envrionment(JRE) binaries present at 'D:\RJC772\
Java\jre' path

Do you want to continue (Y[es]/N[o]): y

Performing revert steps ...

[1/4] Pre-installation step is in progress
[1/4] Pre-installation step is completed successfully

[2/4] Installation step is in progress
[2/4] Installation step is completed successfully

[3/4] Post-installation step is in progress
[3/4] Post-installation step is completed successfully

[4/4] Commit and Cleanup step is in progress
[4/4] Commit and Cleanup step is completed successfully

After reverting, Java Runtime Envrionment(JRE) version installed with product 'Veritas 
NetBackup Remote Java Console'             : 1.8.0_31 (64bit)

Successfully reverted Java Runtime Envrionment(JRE) for Veritas NetBackup Remote Java 
Console.
The log file generated for this operation is D:\LogFolder\
nbcomponentupdate_22-08-2016_16.22.13.log