Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (9.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.  
      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.  
      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.  
      nbftadm
    136.  
      nbftconfig
    137.  
      nbgetconfig
    138.  
      nbhba
    139.  
      nbholdutil
    140.  
      nbhostidentity
    141.  
      nbhostmgmt
    142.  
      nbhypervtool
    143.  
      nbidpcmd
    144.  
      nbimageshare
    145.  
      nbinstallcmd
    146.  
      nbjm
    147.  
      nbkmiputil
    148.  
      nbkmscmd
    149.  
      nbkmsutil
    150.  
      nboraadm
    151.  
      nborair
    152.  
      nbpem
    153.  
      nbpemreq
    154.  
      nbmlb
    155.  
      nbperfchk
    156.  
      nbplupgrade
    157.  
      nbrb
    158.  
      nbrbutil
    159.  
      nbregopsc
    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

nbinstallcmd — used to create deployment jobs

SYNOPSIS

nbinstallcmd -policy policy_name -schedule schedule [-master_server hostname] [{-hosts hostname1,hostname2,... | -host_filelist path}]

nbinstallcmd -operation_type {precheck | stage | install} -package package_name [-master_server hostname] [-media_server hostname] {-hosts hostname1,hostname2,... | -host_filelist path} [-limit_jobs max_concurrent_jobs] -use_existing_certs [-components javagui_jre=(include|exclude|match)]

nbinstallcmd -operation_type {precheck | stage | install} -package package_name [-master_server hostname] [-media_server hostname] {-hosts hostname1,hostname2,... | -host_filelist path} [-limit_jobs max_concurrent_jobs] -unix_eca_cert_path path -unix_eca_crl_check_level {use_cdp | use_path | disabled} -unix_eca_trust_store_path path -unix_eca_private_key_path path [-unix_eca_key_passphrasefile path] [-unix_eca_crl_path path] [-components javagui_jre=(include|exclude|match)]

nbinstallcmd -operation_type {precheck | stage | install} -package package_name [-master_server hostname] [-media_server hostname] {-hosts hostname1,hostname2,... | -host_filelist path} [-limit_jobs max_concurrent_jobs] -win_eca_cert_store path -win_eca_crl_check_level {use_cdp | use_path | disabled} [-win_eca_crl_path path] [-components javagui_jre=(include|exclude|match)]

nbinstallcmd -operation_type {precheck | stage | install} -package package_name [-master_server hostname] [-media_server hostname] {-hosts hostname1,hostname2,... | -host_filelist path} [-limit_jobs max_concurrent_jobs] -win_eca_cert_path path -win_eca_crl_check_level {use_cdp | use_path | disabled} -win_eca_trust_store_path path -win_eca_private_key_path path [-win_eca_crl_path path] [-win_eca_key_passphrasefile path] [-components javagui_jre=(include|exclude|match)]

 

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

Use the nbinstallcmd command to create VxUpdate jobs. VxUpdate supports updates for clients and media servers. If you launch the job from a master server, it may target any client or any media server the master server knows. If you launch the job from a client or a media server, only that client or media server is targeted.

Use the -policy and -schedule options to base a job off an existing deployment policy. If the -hosts or -host_filelist switches are used with -policy, the job is limited to a subset of the target hosts configured in the deployment policy. If -hosts and -host_filelist are not used, the job is executed against all target hosts configured in the deployment policy.

Use the -operation_type and -package options to launch a job without a deployment policy. This form of the command requires you to provide information regarding security configuration. The command requires you specify how VxUpdate handles security:

  • Configure external security certificates for UNIX and Linux hosts during the upgrade using a file-based certificate.

  • Configure external security certificates for Windows hosts during the upgrade using a certificate from a certificate store.

  • Configure external security certificates for Windows hosts during the upgrade using a file-based certificate.

  • Do not modify the security, as it is configured correctly.

See the NetBackup Installation Guide and the NetBackup Security and Encryption Guide for more details on these security options.

Logs for the nbinstallcmd command are located in the legacy logging directory. For UNIX and Linux, the logs are found in /usr/openv/netbackup/logs. On Windows, the logs are in install_path\NetBackup\logs.

Note:

Please use shell-specific annotations if any of the file paths in the arguments contain spaces or special characters that must be escaped.

OPTIONS

-components javagui_jre=(include | exclude | match)

Use this option to specify if the Java GUI and JRE should be present on the target systems after the deployment job runs.

A value of include indicates that you want these components to be installed or upgraded on the target systems.

A value of exclude indicates that you do not want the components on the target systems. Any preexisting Java GUI and JRE components are removed.

A value of match indicates that you want to preserve the current state of the Java GUI and JRE components. The components are upgraded if they are present on the pre-upgraded system. The components are not installed if they are not present on the pre-upgraded system.

-hosts [host1,host2,...]

A comma-separated list of host names with no spaces between the entries. You cannot use this option with -host_filelist. If -policy is specified, the hosts that are listed must be included in the policy. If -policy is not specified and the command is executed on the master server, hosts specified must be known to the master server. If -policy is not specified and the command is executed on the target host, this value must match the name of the target host. You cannot specify a mixture of clients and media servers in a single job. All hosts that are listed in a job must either be all clients or all media servers.

-host_filelist [path]

Path to a file with the host names specified on individual lines. You cannot use this option with -hosts. If -policy is specified, the hosts that are specified must be included in the policy. If -policy is not specified and the command is executed on the master server, the hosts that are specified must be known to the master server. If -policy is not specified and the command is executed on the target host, this value must match the name of the target host. You cannot specify a mixture of clients and media servers in a single job. All hosts that are listed in the file must either be all clients or all media servers.

-limit_jobs [max_concurrent_jobs]

The maximum number of concurrent jobs allowed. This option applies only when -policy is not specified. If unspecified, the default value is unlimited.

-master_server hostname

The host name of the master server where the VxUpdate repository exists. This option is not required.

-media_server hostname

The host name of the staging server with which the client communicates. This server must be a media server. This option applies only when -policy is not specified. If unspecified, the master server acts as the staging server. When a media server is used for staging, the packages are cached to it so that it can serve these packages in VxUpdate operations. This option helps optimize the efficiency of the NetBackup master server.

-operation_type {precheck | stage | install}

The type of deployment operation to launch. Required if -policy is not specified. Valid options are:

  • precheck: Performs the various precheck operations, including confirming there is sufficient space on the host for the update.

  • stage: Moves the update package to the host, but does not install it. Also performs the precheck operation.

  • install: Installs the specified package. Also performs the precheck and the stage operations. If you already performed the stage operation, the install command does not move the package again.

-package item

The name of the package you want installed. Required if -policy is not specified. The package must be present in the repository. Use the nbrepo command to view and manage packages.

-policy policy_name

The name of an existing deployment policy. This option is required if -operation_type isn't specified.

-schedule schedule_name

The deployment policy's schedule to execute. Required if -policy is specified.

-unix_eca_cert_path path

Use this option to specify the path to the certificate file for UNIX and Linux hosts. This option applies when:

  • -policy and -use_existing_certs are not specified.

  • The master server supports external security certificates.

  • The target hosts do not yet have external security certificates configured.

  • You want the configuration to occur during the upgrade.

-unix_eca_crl_check_level {use_cdp | use_path | disabled}

Specifies how you want to handle the Certificate Revocation List on UNIX and Linux hosts. Specify use_cdp to use the CRL defined in the certificate. Specify use_path to specify the path to the CRL. Specify disabled to not use a CRL. Applies when:

  • -policy and -use_existing_certs are not specified.

  • The master server supports external security certificates.

  • Your target hosts do not yet have external security certificates configured.

  • You want that configuration to occur during the upgrade.

-unix_eca_crl_path path

Use this option to specify the path to the external certificate authority file for UNIX and Linux hosts. This option is required if you use -unix_eca_crl_check_level use_path. If you attempt to use this option without -unix_eca_crl_check_level use_path, the job fails.

  • -policy and -use_existing_certs are not specified.

  • The master server supports external security certificates.

  • Your target hosts do not yet have external security certificates configured.

  • You want that configuration to occur during the upgrade.

-unix_eca_key_passphrasefile path

Use this option to provide the path to the passphrase file on UNIX and Linux hosts. This option is not required. This option applies when:

  • -policy and -use_existing_certs are not specified

  • The master server supports external security certificates

  • Your target hosts do not yet have external security certificates configured.

  • You want that configuration to occur during the upgrade.

-unix_eca_private_key_path path

Use this option to specify the path to the private key file and the private key file name on UNIX and Linux hosts. This option applies when:

  • -policy and -use_existing_certs are not specified

  • The master server supports external security certificates.

  • Your target hosts do not yet have external security certificates configured.

  • You want that configuration to occur during the upgrade.

-unix_eca_trust_store_path path

Use this option to specify the path to the trust store file on UNIX and Linux hosts. This option applies when:

  • -policy and -use_existing_certs are not specified

  • The master server supports external security certificates.

  • Your target hosts do not yet have external security certificates configured.

  • You want that configuration to occur during the upgrade.

-use_existing_certs

Specify this option when you want the job to use the existing security certificates. This option only applies when -policy is not specified. You cannot use this option with any *eca* option. Specify this option if:

  • The target hosts have existing external certificates.

  • The target hosts have existing NetBackup security certificates you want to continue to use.

-win_eca_cert_path path

Use this option to specify the path to the certificate file for Windows hosts. You cannot use this option with -win_eca_cert_store_path. This option applies when:

  • -policy and -use_existing_certs are not specified

  • The master server supports external security certificates.

  • Your target hosts do not yet have external security certificates configured.

  • You want that configuration to occur during the upgrade.

-win_eca_cert_store path

Use this option to specify the path to the Windows certificate store. You cannot use this option with -win_eca_cert_path, -win_eca_key_passphrasepath, -win_eca_private_key_path, and -win_eca_trust_store_path. You must enter the certificate location as Certificate_Store_Name\Issuer_Distinguished_Name\Subject_Distinguished_Name. This option applies when:

  • -policy and -use_existing_certs are not specified

  • The master server supports external security certificates.

  • Your target hosts do not yet have external security certificates configured.

  • You want that configuration to occur during the upgrade.

-win_eca_crl_check_level {use_cdp | use_path | disabled}

Specifies how you want to handle the Certificate Revocation List on Windows hosts. Specify use_cdp to use the CRL defined in the certificate. Specify use_path to specify the path to the CRL. Specify disabled to not use a CRL. This option applies when:

  • -policy and -use_existing_certs are not specified

  • The master server supports external security certificates.

  • Your target hosts do not yet have external security certificates configured.

  • You want that configuration to occur during the upgrade.

-win_eca_crl_path path

Use this option to specify the path to the external certificate authority file for Windows hosts. This option is required if you use -windows_eca_crl_check_level use_path. If you attempt to use this option without -windows_eca_crl_check_level use_path, the job fails.

-win_eca_key_passphrasefile path

Use this option to provide the path to the passphrase file on Windows hosts. This option is not required. You cannot use this option with -win_eca_cert_store. This option applies when:

  • -policy and -use_existing_certs are not specified

  • The master server supports external security certificates.

  • Your target hosts do not yet have external security certificates configured.

  • You want that configuration to occur during the upgrade.

-win_eca_private_key_path path

Use this option to specify the path to the private key file and the private key file name on Windows hosts. You cannot use this option with -win_eca_cert_store. This option applies when:

  • -policy and -use_existing_certs are not specified

  • The master server supports external security certificates.

  • Your target hosts do not yet have external security certificates configured.

  • You want that configuration to occur during the upgrade.

-win_eca_trust_store_path path

This option lets you specify the path to the trust store and the trust store file name on Windows hosts. You cannot use this option with -win_eca_cert_store. This option applies when:

  • -policy and -use_existing_certs are not specified

  • The master server supports external security certificates.

  • Your target hosts do not yet have external security certificates configured.

  • You want that configuration to occur during the upgrade.

EXAMPLES

Example 1: Initiate a precheck operation for all hosts that are configured in the specified policy.

nbinstallcmd -policy policy-deployment20 -schedule sched-precheck 
-master_server master.domain.com

Example 2: From the master server, initiate a staging job that is not based on a deployment policy. The job should: stage the NetBackup 8.2 client, target several hosts, use a separate media server as the staging server, and not include any security certificate configuration.

nbinstallcmd -operation_type stage -package nbclient_8.2 -master_server 
master.domain.com -media_server media_staging.domain.com -hosts 
client01.domain.com,client02.domain.com -use_existing_certs

Example 3: From the target host, initiate an install operation that is not based on a deployment policy. The operation upgrades the host to NetBackup 8.3 with instructions to configure external security certificates as part of the upgrade.

nbinstallcmd -operation_type install -package nbserver_8.3 
-master_server master.domain.com -hosts media01.domain.com 
-unix_eca_cert_path /usr/home/cert.pem -unix_eca_trust_store_path 
/usr/home/cacert.pem -unix_eca_private_key_path 
/usr/home/private_key.pem -unix_eca_key_passphrasefile 
/usr/home/passphrase_file -unix_eca_crl_check_level use_path 
-unix_eca_crl_path /usr/home/crl_dir

Example 4: From the target host, initiate an install operation not based on a deployment policy. The operation upgrades the host to NetBackup 8.3 using a separate media server as the staging server. It also includes instructions to configure external security certificates originating from a certificate store.

nbinstallcmd -operation_type install -package nbclient_8.3 
-master_server master.domain.com -media_server media_staging.domain.com 
-hosts client01.domain.com -win_eca_cert_store 
MyCertStore\MyIssuer\MyClient -win_eca_crl_check_level use_cdp

Example 5: From the master server, initiate an install operation not based on a deployment policy. The operation applies a NetBackup 8.2 Windows EEB and targets several hosts. The job uses the master server as the staging server and does not include any security certificate configuration.

nbinstallcmd -operation_type install -package nbeeb_1234567.1_8.2 
-master_server master.domain.com -host_filelist path_to_file.txt 
-use_existing_certs

SEE ALSO

See nbrepo.