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

nbhostidentity — imports the NetBackup master server identity after a disaster.

SYNOPSIS

nbhostidentity -import -infile file_path [-altdir directory_path [-noacls]] [-mapuser domain1\user1:domain2\user2 [,domain3\user3:domain4\user4] [-dryrun]

nbhostidentity - testpassphrase - infile file_path

nbhostidentity [-import | -testpassphrase] -help

nbhostidentity -info [-infile file_path] -query string [-json]

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

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

DESCRIPTION

The nbhostidentity command is used to import the master server identity after a disaster. You need to provide the file path and the file name of the disaster recovery package for the master server identity you want to restore.

Disaster recovery packages store the master server identity and are created during catalog backups. NetBackup requires the disaster recovery package to restore the master server identity after a disaster.

Note:

Do not run the nbhostidentity command if you selected the disaster recovery mode during installation. In this scenario, the master server identity is automatically imported during the installation.

Run the nbhostidentity command on the master server after you install NetBackup to manually import the master server identity after a disaster.

The warning message that is shown is displayed when you run the command:

If new certificates are deployed on the media servers or clients after NetBackup master server installation, certificates on those hosts should be redeployed. To identify the hosts that need certificate redeployment, go to NetBackup Administration Console > Host Properties > Clients.

This process requires you to restart the NetBackup services.

Are you sure you want to proceed (y/n)?

Read the warning message carefully and then specify the option.

Press N to terminate the command execution. Press Y to run the nbhostidentity command and restart the NetBackup services.

After you enter Y, you must provide the appropriate passphrase to decrypt the specified disaster recovery package. The host identity import operation fails if the passphrase does not match the one that you have set earlier.

Note:

Ensure that the passphrase is same as what you set at the time of the catalog backup. The passphrase must be the same as the one that is associated with the specified disaster recovery package.

OPTIONS

-altdir directory_path

The -altdir parameter specifies the alternate directory location where you want to restore the disaster recovery package.

-dryrun

Performs a dry run to test the disaster recovery package and its contents. This option is not supported with the -altdir and -noacls options. The option runs the following checks:

  • Passphrase check

  • Host name check

  • User existence check

  • FIPS mode check

-import

Specifies the path name and the file name of the disaster recovery package for the master server identity you want to restore.

The disaster recovery packages are stored in the same location as the disaster recovery files. This location is specified during the catalog backup policy configuration. The disaster recovery package name is same as disaster recovery file name. The extension for the disaster recovery package is .drpkg. You must use the inifile parameter with the -import option.

To run the nbhostidentity -import command, you must be an authorized user with system administrator or superuser privileges.

-import -help

Displays the command usage statement for the -import option.

-infile file_path

The path name and the file name for the disaster recovery package you want to validate or import. This parameter is required for the -import and the - testpassphrase option. If you want to use a network share, you must specify a path to a subfolder on that share.

-info

Provides information about the disaster recovery package and its contents.

-mapuser

Maps the users or groups that are referenced in the disaster recovery package to the existing users or groups on the system. You can map more than one user or group.

This option must not be used along with the -noacls option.

-noacls

Lets you restore files without setting the Access Control List (ACL). This option is available only in case of the disaster recovery package restore to an alternate path.

-query string

Retrieves the data that is queried. Replace string with one of the values shown:

  • files -infile file_path

    Retrieves the identity files that are stored in the disaster recovery package.

  • nonexistingusers | neu

    Retrieves the identity files with the users from the host that does not currently exist.

  • nonexistingusers | neu -infile file_path

    Retrieves the users or groups that are referenced in the disaster recovery package, but do not exist on the system.

-testpassphrase

Used to confirm that the passphrase for a disaster recovery package is correct. You must be an authorized user with system administrator or superuser privileges to run the nbhostidentity -testpassphrase command.

Use of this option begins an interactive session where you are prompted to enter the passphrase for the specified disaster recovery package. The nbhostidentity command confirms the passphrase that is entered matches the one associated with the disaster recovery package. You must use the inifile parameter with the - testpassphrase option.

-testpassphrase -help

Displays the command usage statement for the -testpassphrase option.

-help

Displays the command usage statement for the nbhostidentity command.

EXAMPLES

Example of the nbhostidentity command to recovery a master server identity.

# nbhostidentity -import -infile /dr/nbu_dr_file/
cat_backup_1438271286_INCR.drpkg

Example of the -testpassphrase option with an invalid passphrase.

# ./nbhostidentity -testpassphrase -infile /test2.drpkg
Specify the passphrase that is associated with the disaster recovery 
package.
Passphrase:
The specified passphrase is not valid for the disaster recovery 
package - /test2.drpkg.
nbhostidentity command failed.

Example of the -testpassphrase option with a valid passphrase.

# ./nbhostidentity -testpassphrase -infile /test2.drpkg
Specify the passphrase that is associated with the disaster recovery 
package.
Passphrase:
The specified passphrase is valid for the disaster recovery 
package - /test2.drpkg.
Command is successfully carried out.

SEE ALSO

See nbseccmd.