NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (10.0)
  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.  
      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.  
      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

nbcloudrestore — restores an in-cloud asset using a Perl script.

SYNOPSIS

nbcloudrestore.pl -master_server host_name -username user -password [password] [-port port_number] [-domainname domain_name -domaintype domain_type] [-source_assetid nb_source_assetid [-filter filter]] [-backupid backup_id] [-destination_assetid destination_assetid] [-recovery_type recovery_type] [ -copy_number copy_number] [-overwrite_existing overwrite_existing] [-recovered_state recovered_state] [-waittime [wait_time]] [-verbose [verbose]]

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

Use the nbcloudrestore command to restore in-cloud assets. The command supports Windows, Red Hat Linux, and SUSE Linux master server platforms.

You must use Perl version 5.10 or later. You must also install the Perl modules that are listed on the NetBackup master server before you run the nbcloudrestore command. The modules must also appear in the list of search paths in the include paths (@INC).

  • Getopt::Long

  • Term::ReadKey

  • HTTP::Response

  • HTTP::Request

  • JSON

  • URI

  • Data::Dumper

  • LWP::UserAgent

  • LWP::Protocol::http

  • Pod::Usage

  • Time::HiRes

OPTIONS

-backupid backup_id

Use this option to provide the backup image identifier to use for this recovery. You can obtain the backup ID from the NetBackup Administration console > NetBackup Management > Catalog or with the bpimagelist command.

-copy_number copy_number

Specify the backup copy you want to restore. Valid values are 1 to 10. If not specified, primary copy is used.

-domainname domain_name

Use this option to provide the domain name for the user that is used to connect to the NetBackup master server.

-domaintype domain_type

Use this option to provide the domain type for the user that is used to connect to the NetBackup master server. Supported values are:

  • NIS

  • NIS+

  • NT

  • Vx

  • Unixpwd

  • Ldap

-destination_assetid destination_asset_id

Use this option to provide the NetBackup asset identifier for the recovery destination. If not specified, the asset is restored to its original location. This option is currently supported only with the recovery API.

-filter [filter]

Use this option to select the backup images for recovery based on the specified filter. This option must be used with the source_assetid option. The date range is specified in the format shown: YYYY-MM-DDTHH:MM:SSZ. You can also use ge to specify greater than or equal to, and le for less than or equal to when you specify the filter. The date range must contain a recovery point. Refer to the Recovery Points tab for the asset in the NetBackup web user interface. If more than one backup image matches the filter, NetBackup selects the most recent one.

-master_server master_server

Use this option to specify the NetBackup master server that is used for running restore jobs.

-overwrite_existing overwrite_existing

Use this option to overwrite an existing cloud asset. Accepted values for this option are true, which overwrites the original database, and false, which retains the original database. This parameter is optional.

-password password

Use this option to provide the password for the user that is used to connect to the NetBackup master server. When you provide an empty value for password parameter, you are prompted for the password. For security reasons, the password is not displayed when you enter it at the prompt.

- port [port_number]

Use this option to provide the port number to connect to the NetBackup master server.

-recovery_type recovery_type

Specify the recovery type. Valid values are ORIGINAL, ALTERNATE, and ROLLBACK.

-recovered_state recovered_state

Use this option with the ALTERNATE recovery type to select the recovered state of a database. Valid values are RECOVERED or NOT RECOVERED. This parameter is optional.

-source_assetid nb_source_asset

Use this option to provide the NetBackup source asset identifier that was used at the time of backup. Recovery is performed using the most recent backup image, unless a filter is specified. You can obtain the source_assetid from the NetBackup web user interface by referring to the list of discovered cloud assets.

-username username

Use this option to provide the user name to connect to the NetBackup master server.

-verbose verbose

Use this option to set verbose levels for diagnostics purpose. Supported values are:

  • 1 for minimal

  • 2 for normal (the default value)

  • 3 for detailed

-wait_time wait_time

Use this option to specify wait time in minutes. NetBackup waits for a completion status for the given duration from the master server before it returns you to the system prompt. If the wait time expires before the operation is complete, the command exits with a time-out status. The operation, however, still completes on the server. If you specify 0 or empty value, the default time-out value of 180 seconds is used.

EXAMPLES

Example 1: Restore an asset using a source asset ID with a date range.

./nbcloudrestore.pl -master_server example.server.com -username root
 -password - source_assetid 18e0a55a-6732-40d9-9c98-323fc2975bdc 
-filter "backupTime ge "2018-05-01T01:01:01Z" and backupTime le 
"2018-05-31T23:20:50Z""

Example 2 - Restore an asset using the backup ID.

./nbcloudrestore.pl - master_server example.server.com -username root
 -password - backupid aws-ec2-ap-south-1-i-02df039d2b6867a1b_1525946138

SEE ALSO

See bpimagelist.