Important Update: Cohesity Products Documentation


All Cohesity product documentation are now managed via the Cohesity Docs Portal: https://docs.cohesity.com/HomePage/Content/home.htm. Some documentation available here may not reflect the latest information or may no longer be accessible.

NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (11.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.  
      backupdbtrace
    3.  
      backuptrace
    4.  
      bmrc
    5.  
      bmrconfig
    6.  
      bmrepadm
    7.  
      bmrprep
    8.  
      bmrs
    9.  
      bmrsrtadm
    10.  
      bp
    11.  
      bparchive
    12.  
      bpbackup
    13.  
      bpbackupdb
    14.  
      bpcatarc
    15.  
      bpcatlist
    16.  
      bpcatres
    17.  
      bpcatrm
    18.  
      bpcd
    19.  
      bpchangeprimary
    20.  
      bpcleanrestore
    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.  
      bpup
    79.  
      bpverify
    80.  
      cat_convert
    81.  
      cat_export
    82.  
      cat_import
    83.  
      configureCerts
    84.  
      configureMQ
    85.  
      configureWebServerCerts
    86.  
      create_nbdb
    87.  
      csconfig cldinstance
    88.  
      csconfig cldprovider
    89.  
      csconfig meter
    90.  
      csconfig reinitialize
    91.  
      csconfig throttle
    92.  
      duplicatetrace
    93.  
      importtrace
    94.  
      jbpSA
    95.  
      jnbSA
    96.  
      ltid
    97.  
      mklogdir
    98.  
      msdpcldutil
    99.  
      msdpimgutil
    100.  
      nbauditreport
    101.  
      nbcallhomeproxyconfig
    102.  
      nbcatsync
    103.  
      NBCC
    104.  
      NBCCR
    105.  
      nbcertcmd
    106.  
      nbcertupdater
    107.  
      nbcldutil
    108.  
      nbcmdrun
    109.  
      nbcomponentupdate
    110.  
      nbcplogs
    111.  
      nbcredkeyutil
    112.  
      nbdb_admin
    113.  
      nbdb_backup
    114.  
      nbdb_move
    115.  
      nbdb_ping
    116.  
      nbdb_restore
    117.  
      nbdb_unload
    118.  
      nbdb2adutl
    119.  
      nbdbms_start_server
    120.  
      nbdbms_start_stop
    121.  
      nbdc
    122.  
      nbdecommission
    123.  
      nbdelete
    124.  
      nbdeployutil
    125.  
      nbdevconfig
    126.  
      nbdevquery
    127.  
      nbdiscover
    128.  
      nbdna
    129.  
      nbemm
    130.  
      nbemmcmd
    131.  
      nbepicfile
    132.  
      nbfindfile
    133.  
      nbfirescan
    134.  
      nbfp
    135.  
      nbftadm
    136.  
      nbftconfig
    137.  
      nbgetconfig
    138.  
      nbhba
    139.  
      nbholdutil
    140.  
      nbhostidentity
    141.  
      nbhostmgmt
    142.  
      nbhsmcmd
    143.  
      nbhypervtool
    144.  
      nbidpcmd
    145.  
      nbimageshare
    146.  
      nbinstallcmd
    147.  
      nbjm
    148.  
      nbkmiputil
    149.  
      nbkmscmd
    150.  
      nbkmsutil
    151.  
      nblogparser
    152.  
      nbmariadb
    153.  
      nbmysql
    154.  
      nbmlb
    155.  
      nborair
    156.  
      nboracmd
    157.  
      nbpem
    158.  
      nbpemreq
    159.  
      nbmariadb
    160.  
      nbmlb
    161.  
      nbperfchk
    162.  
      nbpgsql
    163.  
      nbplupgrade
    164.  
      nbrb
    165.  
      nbrbutil
    166.  
      nbreplicate
    167.  
      nbrepo
    168.  
      nbrestorevm
    169.  
      nbseccmd
    170.  
      nbserviceusercmd
    171.  
      nbsetconfig
    172.  
      nbshvault
    173.  
      nbsmartdiag
    174.  
      nbsnapimport
    175.  
      nbsnapreplicate
    176.  
      nbsqlcmd
    177.  
      nbsqlite
    178.  
      nbstl
    179.  
      nbstlutil
    180.  
      nbstop
    181.  
      nbsu
    182.  
      nbsvrgrp
    183.  
      netbackup_deployment_insights
    184.  
      resilient_clients
    185.  
      restoretrace
    186.  
      stopltid
    187.  
      tiermover
    188.  
      tldd
    189.  
      tldcd
    190.  
      tpautoconf
    191.  
      tpclean
    192.  
      tpconfig
    193.  
      tpext
    194.  
      tpreq
    195.  
      tpunmount
    196.  
      verifytrace
    197.  
      vltadm
    198.  
      vltcontainers
    199.  
      vlteject
    200.  
      vltinject
    201.  
      vltoffsitemedia
    202.  
      vltopmenu
    203.  
      vltrun
    204.  
      vmadd
    205.  
      vmchange
    206.  
      vmcheckxxx
    207.  
      vmd
    208.  
      vmdelete
    209.  
      vmoprcmd
    210.  
      vmphyinv
    211.  
      vmpool
    212.  
      vmquery
    213.  
      vmrule
    214.  
      vmupdate
    215.  
      vnetd
    216.  
      vssat
    217.  
      vwcp_manage
    218.  
      vxlogcfg
    219.  
      vxlogmgr
    220.  
      vxlogview
    221.  
      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.