Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.0)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
  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.  
      bppolicynew
    62.  
      bpps
    63.  
      bprd
    64.  
      bprecover
    65.  
      bprestore
    66.  
      bpretlevel
    67.  
      bpschedule
    68.  
      bpschedulerep
    69.  
      bpsetconfig
    70.  
      bpstsinfo
    71.  
      bpstuadd
    72.  
      bpstudel
    73.  
      bpstulist
    74.  
      bpsturep
    75.  
      bptestbpcd
    76.  
      bptestnetconn
    77.  
      bptpcinfo
    78.  
      bpup
    79.  
      bpverify
    80.  
      cat_convert
    81.  
      cat_export
    82.  
      cat_import
    83.  
      configurePorts
    84.  
      create_nbdb
    85.  
      csconfig
    86.  
      duplicatetrace
    87.  
      importtrace
    88.  
      jbpSA
    89.  
      jnbSA
    90.  
      ltid
    91.  
      mklogdir
    92.  
      nbauditreport
    93.  
      nbcatsync
    94.  
      NBCC
    95.  
      NBCCR
    96.  
      nbcertcmd
    97.  
      nbcertupdater
    98.  
      nbcomponentupdate
    99.  
      nbcplogs
    100.  
      nbdb_admin
    101.  
      nbdb_backup
    102.  
      nbdb_move
    103.  
      nbdb_ping
    104.  
      nbdb_restore
    105.  
      nbdb_unload
    106.  
      nbdbms_start_server
    107.  
      nbdbms_start_stop
    108.  
      nbdc
    109.  
      nbdecommission
    110.  
      nbdelete
    111.  
      nbdeployutil
    112.  
      nbdevconfig
    113.  
      nbdevquery
    114.  
      nbdiscover
    115.  
      nbdna
    116.  
      nbemm
    117.  
      nbemmcmd
    118.  
      nbexecute
    119.  
      nbfindfile
    120.  
      nbfirescan
    121.  
      nbftadm
    122.  
      nbftconfig
    123.  
      nbgetconfig
    124.  
      nbhba
    125.  
      nbholdutil
    126.  
      nbhypervtool
    127.  
      nbjm
    128.  
      nbkmsutil
    129.  
      nboraadm
    130.  
      nbpem
    131.  
      nbpemreq
    132.  
      nbperfchk
    133.  
      nbplupgrade
    134.  
      nbrb
    135.  
      nbrbutil
    136.  
      nbregopsc
    137.  
      nbreplicate
    138.  
      nbrestorevm
    139.  
      nbseccmd
    140.  
      nbsetconfig
    141.  
      nbsnapimport
    142.  
      nbsnapreplicate
    143.  
      nbsqladm
    144.  
      nbstl
    145.  
      nbstlutil
    146.  
      nbsu
    147.  
      nbsvrgrp
    148.  
      resilient_clients
    149.  
      restoretrace
    150.  
      stopltid
    151.  
      tl4d
    152.  
      tl8d
    153.  
      tl8cd
    154.  
      tldd
    155.  
      tldcd
    156.  
      tlhd
    157.  
      tlhcd
    158.  
      tlmd
    159.  
      tpautoconf
    160.  
      tpclean
    161.  
      tpconfig
    162.  
      tpext
    163.  
      tpreq
    164.  
      tpunmount
    165.  
      verifytrace
    166.  
      vltadm
    167.  
      vltcontainers
    168.  
      vlteject
    169.  
      vltinject
    170.  
      vltoffsitemedia
    171.  
      vltopmenu
    172.  
      vltrun
    173.  
      vmadd
    174.  
      vmchange
    175.  
      vmcheckxxx
    176.  
      vmd
    177.  
      vmdelete
    178.  
      vmoprcmd
    179.  
      vmphyinv
    180.  
      vmpool
    181.  
      vmquery
    182.  
      vmrule
    183.  
      vmupdate
    184.  
      vnetd
    185.  
      vxlogcfg
    186.  
      vxlogmgr
    187.  
      vxlogview
    188.  
      W2KOption

Name

nbdiscover — test query rules for automatic selection of VMware virtual machines for backup

SYNOPSIS

nbdiscover -noxmloutput path | -policy policy_name [-sched policy_schedule_type] [-includedonly | -excludedonly] [-noreason] [-escapechar x] [-quotechar x]

nbdiscover -noxmloutput query [-includedonly | -excludedonly] [-noreason] [-escapechar x] [-quotechar x]

 

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

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

DESCRIPTION

The nbdiscover command is similar to the Test Query button in the VMware policy. It returns the virtual machines that NetBackup selects based on the specified query rules. You can specify the name of a policy that contains the query, or the query itself. The -noxmloutput option is required for user-friendly output (the default XML output is not supported for general use).

The nbdiscover command must be run on either the discovery host or the backup host.

For more information on how to create and test rules from the policy's Query Builder, see the NetBackup for VMware Administrator's Guide.

OPTIONS

-escapechar x

Specifies the ASCII decimal value of an alternate escape character to be used in the nbdiscover output when you use the -noxmloutput option. The default escape character is a backslash (\) or -escapechar 92.

-excludedonly x

Returns only excluded virtual machines that do not match the rules in the query.

-includedonly x

Returns only included virtual machines virtual machines that match the rules in the query.

-noreason

Omits from the results any explanation as to why a virtual machine was excluded by the query or failed the query. A virtual machine fails the query if the query cannot exclude the virtual machine and the virtual machine cannot be selected for backup.

-noxmloutput

Displays one virtual machine per line. In the output, a plus sign (+) in the first column indicates that the virtual machine matches the rules in the query. A minus sign (-) indicates that the virtual machine does not match the rules in the query.

-policy policy_name

Specifies a policy that contains a query. nbdiscover filters the virtual machines based on that query and on other policy attributes, such as Primary VM identifier (for example, VM host name or VM display name).

query

Specifies a query without a policy. You must compose the query manually and enclose it in double quotes. For example:

"vmware:/?filter=Displayname Contains 'vm1'"
-quotechar x

Specifies the ASCII decimal value of an alternate quote character to be used in the nbdiscover output when you use the -noxmloutput option. The default quote character is a double quote (") or -quotechar 34.

-sched policy_schedule_type

Specifies the schedule type of the policy when you use the -policy policy_name option.

EXAMPLES

Example 1 - List the virtual machines that either match or do not match the query in the policy pol1. Do not list explanations for the virtual machines that failed the query or that the query excluded.

# nbdiscover -noxmloutput -policy pol1 -noreason
+ "grayvm3"
+ "grayvm5"
+ "grayvm7"
- "vladvm1"
- "vladvm2"
- "bodvm23"
- "bittle4"

Example 2 - List the virtual machines that have display names that contain "vm". Do not list virtual machines that do not have "vm" in the display names:

# nbdiscover -noxmloutput -includedonly "vmware:/?filter=Displayname  /
Contains 'vm'" 
grayvm3
grayvm5
grayvm7
vladvm1
vladvm2
bodvm23

Example 3 - List the virtual machines by whether they are turned on.

# nbdiscover -noxmloutput "vmware:/?filter=Powerstate Equal poweredOn"
+ "grayvm3"
+ "grayvm5"
+ "grayvm7"
- "vladvm1" "VM excluded by discovery filter, display name=[vladvm1], 
             server=esx1.acme.com]."
+ "vladvm2"
+ "bodvm23"
+ "bittle4"

Example 4 - List the virtual machines by whether they are turned on and have "7" in their display name. Do not list explanations for the virtual machines that failed the query or that the query excluded.

# nbdiscover -noxmloutput "vmware:/?filter=Powerstate Equal poweredOn  /
AND Displayname Contains '7'" -noreason
- "grayvm3"
- "grayvm5"
+ "grayvm7"
- "vladvm1"
- "vladvm2"
- "bodvm23"
- "bittle4"

Example 5 - Search all VM backups that have "test" in their vCloud vApp name. This example uses a query to search virtual machines in vCloud Director. nbdiscover must be run on the master server.

# nbdiscover -noxmloutput "vmsearch:/;reqType=search?filter= vCDvApp 
Contains 'test'"
+ "demovm%20(8c879791-2917-4428-8213-bea7ec727717)"
+ "small_vm%20(61e85579-7246-411f-b2f9-9fb570546755)"
+ "small_vm_percent_%25%20(61e85579-7246-411f-b2f9-9fb570546755)"

Example 6 - Show the hierarchy of the vCloud environment that was backed up. The output of this command is in XML. This example uses a query to search virtual machines in vCloud Director. nbdiscover must be run on the master server.

# nbdiscover "vmsearch:/;reqType=browse;viewType=vcloud"
     <?xml version="1.0" encoding="utf-8"?>
     <Start Iteration="vmsearch:/;reqType=browse;viewType=vcloud">
     <VCDSERVER>
          <NBU>
          <NAME>hypervm1.acme.com</NAME>
          </NBU>
          <VCDORG>
               <NBU>
               <NAME>Test_vCloud</NAME>
               </NBU>
               <VCDORGVDC>
                    <NBU>
                    <NAME>TestOrg</NAME>
                    </NBU>
                    <VCDVAPP>
                         <NBU>
                         <NAME>TestvApp</NAME>
                         </NBU>
                    </VCDVAPP>
               </VCDORGVDC>
          </VCDORG>
     <VCDSERVER>
     <StatusMsg NBUStatus="0" Severity="0"></StatusMsg>
     </Start>