Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.2)
  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.  
      configureCertsForPlugins
    85.  
      configureMQ
    86.  
      configurePorts
    87.  
      configureWebServerCerts
    88.  
      create_nbdb
    89.  
      csconfig cldinstance
    90.  
      csconfig cldprovider
    91.  
      csconfig meter
    92.  
      csconfig throttle
    93.  
      csconfig reinitialize
    94.  
      duplicatetrace
    95.  
      importtrace
    96.  
      jbpSA
    97.  
      jnbSA
    98.  
      ltid
    99.  
      manageClientCerts
    100.  
      mklogdir
    101.  
      nbauditreport
    102.  
      nbcatsync
    103.  
      NBCC
    104.  
      NBCCR
    105.  
      nbcertcmd
    106.  
      nbcertupdater
    107.  
      nbcldutil
    108.  
      nbcloudrestore
    109.  
      nbcomponentupdate
    110.  
      nbcplogs
    111.  
      nbdb_admin
    112.  
      nbdb_backup
    113.  
      nbdb_move
    114.  
      nbdb_ping
    115.  
      nbdb_restore
    116.  
      nbdb_unload
    117.  
      nbdbms_start_server
    118.  
      nbdbms_start_stop
    119.  
      nbdc
    120.  
      nbdecommission
    121.  
      nbdelete
    122.  
      nbdeployutil
    123.  
      nbdevconfig
    124.  
      nbdevquery
    125.  
      nbdiscover
    126.  
      nbdna
    127.  
      nbemm
    128.  
      nbemmcmd
    129.  
      nbfindfile
    130.  
      nbfirescan
    131.  
      nbftadm
    132.  
      nbftconfig
    133.  
      nbgetconfig
    134.  
      nbhba
    135.  
      nbholdutil
    136.  
      nbhostidentity
    137.  
      nbhostmgmt
    138.  
      nbhypervtool
    139.  
      nbimageshare
    140.  
      nbinstallcmd
    141.  
      nbjm
    142.  
      nbkmsutil
    143.  
      nboraadm
    144.  
      nborair
    145.  
      nbpem
    146.  
      nbpemreq
    147.  
      nbperfchk
    148.  
      nbplupgrade
    149.  
      nbrb
    150.  
      nbrbutil
    151.  
      nbregopsc
    152.  
      nbreplicate
    153.  
      nbrepo
    154.  
      nbrestorevm
    155.  
      nbseccmd
    156.  
      nbsetconfig
    157.  
      nbsnapimport
    158.  
      nbsnapreplicate
    159.  
      nbsqladm
    160.  
      nbstl
    161.  
      nbstlutil
    162.  
      nbstop
    163.  
      nbsu
    164.  
      nbsvrgrp
    165.  
      resilient_clients
    166.  
      restoretrace
    167.  
      stopltid
    168.  
      tl4d
    169.  
      tl8d
    170.  
      tl8cd
    171.  
      tldd
    172.  
      tldcd
    173.  
      tlhd
    174.  
      tlhcd
    175.  
      tlmd
    176.  
      tpautoconf
    177.  
      tpclean
    178.  
      tpconfig
    179.  
      tpext
    180.  
      tpreq
    181.  
      tpunmount
    182.  
      verifytrace
    183.  
      vltadm
    184.  
      vltcontainers
    185.  
      vlteject
    186.  
      vltinject
    187.  
      vltoffsitemedia
    188.  
      vltopmenu
    189.  
      vltrun
    190.  
      vmadd
    191.  
      vmchange
    192.  
      vmcheckxxx
    193.  
      vmd
    194.  
      vmdelete
    195.  
      vmoprcmd
    196.  
      vmphyinv
    197.  
      vmpool
    198.  
      vmquery
    199.  
      vmrule
    200.  
      vmupdate
    201.  
      vnetd
    202.  
      vssat
    203.  
      vwcp_manage
    204.  
      vxlogcfg
    205.  
      vxlogmgr
    206.  
      vxlogview
    207.  
      W2KOption

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] [-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\Veritas\NetBackup\bin\goodies

DESCRIPTION

Use the nbcloudrestore command to restore in-cloud assets. The command supports Windows, RedHat 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.

-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.

-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.