NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (10.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.  
      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.  
      configureWebServerCerts
    88.  
      create_nbdb
    89.  
      csconfig cldinstance
    90.  
      csconfig cldprovider
    91.  
      csconfig meter
    92.  
      csconfig reinitialize
    93.  
      csconfig throttle
    94.  
      duplicatetrace
    95.  
      importtrace
    96.  
      jbpSA
    97.  
      jnbSA
    98.  
      ltid
    99.  
      mklogdir
    100.  
      msdpcldutil
    101.  
      nbauditreport
    102.  
      nbcallhomeproxyconfig
    103.  
      nbcatsync
    104.  
      NBCC
    105.  
      NBCCR
    106.  
      nbcertcmd
    107.  
      nbcertupdater
    108.  
      nbcldutil
    109.  
      nbcloudrestore
    110.  
      nbcomponentupdate
    111.  
      nbcplogs
    112.  
      nbcredkeyutil
    113.  
      nbdb_admin
    114.  
      nbdb_backup
    115.  
      nbdb_move
    116.  
      nbdb_ping
    117.  
      nbdb_restore
    118.  
      nbdb_unload
    119.  
      nbdb2adutl
    120.  
      nbdbms_start_server
    121.  
      nbdbms_start_stop
    122.  
      nbdc
    123.  
      nbdecommission
    124.  
      nbdelete
    125.  
      nbdeployutil
    126.  
      nbdevconfig
    127.  
      nbdevquery
    128.  
      nbdiscover
    129.  
      nbdna
    130.  
      nbemm
    131.  
      nbemmcmd
    132.  
      nbfindfile
    133.  
      nbfirescan
    134.  
      nbfp
    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.  
      nbreplicate
    160.  
      nbrepo
    161.  
      nbrestorevm
    162.  
      nbseccmd
    163.  
      nbserviceusercmd
    164.  
      nbsetconfig
    165.  
      nbsmartdiag
    166.  
      nbsnapimport
    167.  
      nbsnapreplicate
    168.  
      nbsqladm
    169.  
      nbstl
    170.  
      nbstlutil
    171.  
      nbstop
    172.  
      nbsu
    173.  
      nbsvrgrp
    174.  
      netbackup_deployment_insights
    175.  
      resilient_clients
    176.  
      restoretrace
    177.  
      stopltid
    178.  
      tldd
    179.  
      tldcd
    180.  
      tpautoconf
    181.  
      tpclean
    182.  
      tpconfig
    183.  
      tpext
    184.  
      tpreq
    185.  
      tpunmount
    186.  
      verifytrace
    187.  
      vltadm
    188.  
      vltcontainers
    189.  
      vlteject
    190.  
      vltinject
    191.  
      vltoffsitemedia
    192.  
      vltopmenu
    193.  
      vltrun
    194.  
      vmadd
    195.  
      vmchange
    196.  
      vmcheckxxx
    197.  
      vmd
    198.  
      vmdelete
    199.  
      vmoprcmd
    200.  
      vmphyinv
    201.  
      vmpool
    202.  
      vmquery
    203.  
      vmrule
    204.  
      vmupdate
    205.  
      vnetd
    206.  
      vssat
    207.  
      vwcp_manage
    208.  
      vxlogcfg
    209.  
      vxlogmgr
    210.  
      vxlogview
    211.  
      W2KOption

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.