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

bppllist — list policy information

SYNOPSIS

bppllist [policyname] [-L | -l | -U] [-allpolicies] [-inventory] [-M master_server,...] [-hwos] [-byclient client] [-keyword "keyword phrase"] [-verbose] [generation -generation]

 

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

bppllist lists policies within the NetBackup database.

Any authorized users can initiate this command.

For more about NetBackup authorization, see the NetBackup Security and Encryption Guide.

OPTIONS

-allpolicies

Lists all policies.

-hwos

Lists possible hardware and the operating system.

-L

Displays a full (long) listing. See the policyname option for details on the fields shown.

-l

Displays the information in raw output mode.

-M master_server,...

Lists the policy information for one or more specified masters.

-U

Displays information in user list mode. This listing is similar to the long-type list, but it has fewer entries.

-byclient client

Lists the policy information for all policies that contain the client indicated.

-inventory

Creates an inventory of the current NetBackup policies and compares it to the previously created inventory. You can create touch file LOG_CLASS_QUERIES in /usr/openv/netbackup to log changes to policies.

The changes are logged in /usr/openv/netbackup/logs/PolicyQueries.log. The customer is responsible for the administration of the log file (periodic truncation, etc.).

-keyword "keyword phrase"

The value is associated with all backups created by using this policy. The keyword phrase can be used to link related policies. It can also be used during restores to search only for the backups that have the keyword phrase association.

policyname

Specifies the policy in the NetBackup database.

The following describes the fields in the output of a bppllist policyname command:

CLASS

  • Field 1 - Policy name

  • Field 2 - Name (internal)

  • Field 3 - Options

  • Field 4 - Protocol version

  • Field 5 - Time zone offset from GMT

  • Field 6 - Audit reason

INFO

  • Field 1 - Policy type

    0 = Standard (UNIX and Linux clients), 1 = Proxy, 4 = Oracle, 6 = Informix-On-BAR, 7 = Sybase, 8 = MS-SharePoint portal server, 11 = DataTools-SQL-BackTrack, 13 = MS- Windows, 15 = MS-SQL-Server, 16 = MS-Exchange-Server, 17 = SAP, 18 = DB2, 19 = NDMP, 20 = FlashBackup, 21=Splitmirror, 25 = Lotus Notes, 29 = FlashBackup-Windows, 35 = NBU-Catalog, 36 = Generic, 38 = PureDisk export, 39 = Enterprise_Vault, 40 = VMware, 41 = Hyper-V

  • Field 2 - Follow NFS mounts. 0 = no, 1 = yes

  • Field 3 - Client compress. 0 = no, 1 = yes

  • Field 4 - Job priority. Valid values are 0-99999.

  • Field 5 - Proxy client.

  • Field 6 - Client encrypt. 0 = no, 1 = yes

  • Field 7 - Disaster recovery. Catalog use DR file option. 0 = no, 1 = yes

  • Field 8 - Maximum jobs allowed per client. Valid values are 0-999.

  • Field 9 - Cross mount points. 0 = no, 1 = yes

  • Field 10 - max frag size (deprecated)

  • Field 11 - Active. Specifies if the policy is active or not. 0 = yes, 1 = no

  • Field 12 - Collect TIR (true image restore) info. 0=do not collect TIR info, 1=collect TIR info without move detection, 2=collect TIR info with move detection

  • Field 13 - Enable block level incremental backups. 0 = no, 1 = yes

  • Field 14 - Individual file restore from raw

  • Field 15 - Streaming

  • Field 16 - Frozen image (internal use)

  • Field 17 - Backup copy (internal use)

  • Field 18 - Date when policy becomes effective

  • Field 19- Class ID

  • Field 20 - Number of backup copies to create. Valid values are 1-4.

  • Field 21 - Enable checkpoints. 0 = no, 1 = yes

  • Field 22 - Checkpoint interval.

  • Field 23 - Unused.

  • Field 24 - Enable Instant Recovery. 0 = no, 1 = yes

  • Field 25 - Perform offhost backup. 0 = no, 1 = yes

  • Field 26 - Enable use alternate client for backup. 0 = no, 1 = yes

  • Field 27 - Enable data mover. 0 = no, 1 = yes

  • Field 28 - Data mover type

    -1 = Unknown data mover type, 1 = Third party copy, 2 = Media server copy, 3 = Network attached storage, 5 = NDMP

  • Field 29- Collect BMR (Bare Metal Restore) information. 0 = no, 1 = yes

  • Field 30 - Storage service (lifecycle) is in use by residence. 0 = no, 1 = yes

  • Field 31 - Enable Granular Restore. 0 = no, 1 = yes

  • Field 32 - Job subtype (internal)

  • Field 33 - Use virtual machine. 0 = No virtual machine, 1 = VMware, 2 = Hyper-V, 3 = VxVI

  • Field 34 - Ignore the client side deduplication setting. 0 = no, 1 = yes

  • Field 35 - Enable Exchange Database backup source. String output.

  • Field 36 - Use NetBackup Accelerator. 0 = no, 1 = yes

  • Field 37 - Enable Granular Restore. 0 = no, 1 = yes

  • Field 38 - Discovery lifetime. Time in seconds for which application discovery is valid.

  • Field 39 - Enable fast backup. 0 = no, 1 = yes

KEY

  • Field 1 - Policy keyword phrase (string).

RES

  • Field 1 - Residence or storage unit, one for each copy

POOL

  • Field 1 - volume pool name, one for each copy

FOE

  • Field 1 - Fail on error. 0 = continue, 1 = fail all copies

SHAREGROUP

  • Field 1 - Media share group (media owner), a value pair for each copy

DATACLASSIFICATION

  • Field 1 - Policy data classification. platinum = highest classification, gold = 2nd highest, silver = 3rd highest, bronze = lowest rank

HYPERVSERVER

  • Indicates that the policy is for a Hyper-V server

NAMES

  • Generic list of names defined by the query type

BCMD

  • This field is obsolete and is scheduled to be removed from NetBackup.

RCMD

  • This field is obsolete and is scheduled to be removed from NetBackup.

APPLICATIONDEFINED

  • Application or client defined multipurpose string

ORABKUPDATAFILEARGS

  • Lists the values used to override the default arguments for Oracle data files backup using RMAN

ORABKUPARCHLOGARGS

  • Lists the values used to override the default arguments for Oracle archived redo log backup using RMAN

CLIENT

  • Client in the policy

SCHED

  • Field 1 - Schedule name for the specified policy

  • Field 2 - Backup type for the schedule. 0 = Full schedule, 1 = Differential incremental schedule, 2 =Cumulative incremental schedule, 3 = User backup schedule, 4 = User archive schedule

  • Field 3 - Number of multiplexing copies to run. Valid values are 1-32.

  • Field 4 - Frequency of the schedule in seconds. Valid values are 1-2147040000 (3550 weeks).

  • Field 5 - Retention level of the schedule. All retention levels except 9 and 25 are user editable. Valid values are 0-100. See the -rl retention_level option description for a complete list of default values and their retention levels.

    Note:

    If you run this command on a pre-NetBackup 8.0 media server, the output only displays the retention levels between 0 and 24.

  • Field 6 - u_wind/o/d. Reserved for future use

  • Fields 7-8 - Reserved for future use

  • Field 9 - Alternate read server

  • Field 10 - Maximum fragment size in megabytes

  • Field 11 - Calendar. 0 = Schedule is frequency-based, 1 = Schedule is calendar-based with no retries, 2 = Schedule is calendar-based with retries

  • Field 12 - Number of copies that are configured for a backup. Valid values are 2-4.

  • Field 13 - Fail on error setting for each copy

  • Field 14 - Synthetic backup. 0 = no, 1 = yes

  • Field 15 - PFI fast recover enable. 0 = no, 1 = yes

  • Field 16 - Priority of migration job

  • Field 17 - Storage service (lifecycle) used for residence. 0 = no, 1 = yes

  • Field 18 - Checksum change detection enable. 0 = no, 1 = yes

SCHEDCALEDATES

  • Exclude calendar dates in Epoch time. Example: To exclude dates of 06/04/2013, 06/07/2013 and 06/18/2013 (all at 05:00:00 GMT) is shown as follows: SCHEDCALEDATES 1346734800 1346994000 1347944400

SCHEDCALENDAR

  • If schedule type is CALENDAR, this field indicates whether retries are allowed after run day. 0 = no, 1 = yes

SCHEDCALDAYOWEEK

  • Include calendar days of week in day-week format, where day is 1-7 (Sunday is 1) and week is week number of the month. Example: To include days of the week Sunday, Week 1; Tuesday, Week 1; Wednesday, Week 4 is shown as follows: SCHEDCALDAYOFWEEK 1,1;3,1;4,4

SCHEDWIN

  • Seven pairs of the form start,duration, which expresses the start and duration of the window for each day of the week. The starting day is Sunday. Start value is the number of seconds past midnight. Duration is the number of seconds past start.

SCHEDRES

  • Residence or storage unit, a value pair for each copy (storage_unit storage_unit). Example: 2 copies are specified, with copy 1 going to stu_msdp_myhost1, and copy 2 going to stu_advdisk_myhost2: SCHEDRES stu_msdp_myhost1 stu_advdisk_myhost2 *NULL* *NULL* *NULL* *NULL* *

SCHEDPOOL

  • Pool, a value pair for each copy (volume_pool_name volume_pool_name). Example: 2 copies are specified, with copy 1 going to pool NetBackup, and copy 2 going to pool MediaPool_1: SCHEDRES NetBackup MediaPool_1 *NULL* *NULL* *NULL* *NULL* *NULL* *NULL*

SCHEDRL

  • Retention level of the schedule. All retention levels except 9 and 25 are user editable. Valid values are 0-100. See the -rl retention_level option description for a complete list of default values and their retention levels.

    Note:

    If you run this command on a pre-NetBackup 8.0 media server, the output only displays the retention levels between 0 and 24.

SCHEDFOE

  • Fail on error. A value pair for each copy. 0 = continue, 1 = fail all copies

SCHEDSG

  • Share group (media owner), a value pair for each copy. Example: Copies are defined, the first copy having a share group of NONE, the second copy have a share group of ANY. SCHEDSG *NONE* *ANY* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL*

-verbose

Selects verbose mode for logging.