Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (9.0.0.1, 9.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.  
      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.  
      configureCerts
    85.  
      configureCertsForPlugins
    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.  
      manageClientCerts
    101.  
      mklogdir
    102.  
      nbauditreport
    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.  
      nbftadm
    135.  
      nbftconfig
    136.  
      nbgetconfig
    137.  
      nbhba
    138.  
      nbholdutil
    139.  
      nbhostidentity
    140.  
      nbhostmgmt
    141.  
      nbhypervtool
    142.  
      nbidpcmd
    143.  
      nbimageshare
    144.  
      nbinstallcmd
    145.  
      nbjm
    146.  
      nbkmiputil
    147.  
      nbkmscmd
    148.  
      nbkmsutil
    149.  
      nboraadm
    150.  
      nborair
    151.  
      nbpem
    152.  
      nbpemreq
    153.  
      nbmlb
    154.  
      nbperfchk
    155.  
      nbplupgrade
    156.  
      nbrb
    157.  
      nbrbutil
    158.  
      nbregopsc
    159.  
      nbreplicate
    160.  
      nbrepo
    161.  
      nbrestorevm
    162.  
      nbseccmd
    163.  
      nbsetconfig
    164.  
      nbsnapimport
    165.  
      nbsnapreplicate
    166.  
      nbsqladm
    167.  
      nbstl
    168.  
      nbstlutil
    169.  
      nbstop
    170.  
      nbsu
    171.  
      nbsvrgrp
    172.  
      resilient_clients
    173.  
      restoretrace
    174.  
      stopltid
    175.  
      tldd
    176.  
      tldcd
    177.  
      tpautoconf
    178.  
      tpclean
    179.  
      tpconfig
    180.  
      tpext
    181.  
      tpreq
    182.  
      tpunmount
    183.  
      verifytrace
    184.  
      vltadm
    185.  
      vltcontainers
    186.  
      vlteject
    187.  
      vltinject
    188.  
      vltoffsitemedia
    189.  
      vltopmenu
    190.  
      vltrun
    191.  
      vmadd
    192.  
      vmchange
    193.  
      vmcheckxxx
    194.  
      vmd
    195.  
      vmdelete
    196.  
      vmoprcmd
    197.  
      vmphyinv
    198.  
      vmpool
    199.  
      vmquery
    200.  
      vmrule
    201.  
      vmupdate
    202.  
      vnetd
    203.  
      vssat
    204.  
      vwcp_manage
    205.  
      vxlogcfg
    206.  
      vxlogmgr
    207.  
      vxlogview
    208.  
      W2KOption
  3.  
    Index

Name

bpplinclude — maintain list of files automatically backed up by NetBackup policy

SYNOPSIS

bpplinclude policy_name [-v] [-M master_server,...] -L | -l [-generation generation] [-exclude_volumes]

bpplinclude policy_name [-v] [-M master_server,...] [-generation generation] -add pathname or directive ... | -add -f filename | -addtoquery query_string... -addtoquery -f filename | -delete pathname or directive ... | -delete -f filename | -deletefromquery query_string... | -deletefromquery -f filename | -modify old_pathname new_pathname ... [-reason "string"] [-exclude_volumes]

 

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

bpplinclude maintains the policy file list for a NetBackup policy. The policy file list is the list of files that are backed up when NetBackup runs an automatic backup for the policy. The policy file list does not apply to user backups or archives since users select the files when they start those operations.

bpplinclude performs one of the following operations:

  • Adds the pathnames to the policy file list

  • Deletes the pathnames from the policy file list

  • Modifies the pathnames in the policy file list

  • Displays the policy file list for a policy

  • Excludes specified volumes from a policy. This option is only applicable for the NAS-Data-Protection policy type.

For most policies, the -add, -delete, and -modify options include a list of pathnames. The list of pathnames must be the final part of the bpplinclude command line. The pathname must be the entire path from the root of the file system to the desired location.

For the pathname syntax for your client type, see the NetBackup Administrator's Guide, Volume I.

The last part of the path can be a file name, a directory name, or a wildcard specification. You can enclose pathnames in quotes. Use enclosing quotes if the pathname contains special characters or a wildcard specification.

Filepath rules do not verify the existence of the input directories or files. NetBackup backs up only the files it finds and does not require that all entries in the list be present on every client.

For most database agents, the input entries are scripts or a directive. See the NetBackup guide that comes with the database agent product for additional information. Also see the -add pathname option.

The added entries to the policy file list can be directives, rather than pathnames for the following: certain policy attributes (such as Allow multiple data streams) and add-on products (such as NetBackup for NDMP).

See the NetBackup Administrator's Guide, Volume I or the NetBackup guide for the extension product.

The options -l and -L produce nearly identical displays of the policy file list.

bpplinclude sends its error messages to stderr. bpplinclude sends a log of its activities to the NetBackup admin log file for the current day.

Authorized users can initiate this command.

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

Note:

It is not recommended that users modify or delete automanaged policies.

If the user modifies the policy, they must make sure that the policy continues to meet the service level objective as defined by the protection plan.

If the user deletes the policy, they must make sure that the asset is added to another protection plan that meets the service level objective.

OPTIONS

-add pathname ...

Adds the specified pathname to the policy file list. The pathname can be a directory, file name, script, or directive.

A pathname must be enclosed in quotes (") if it contains special characters, such as blank (" "), or a wildcard specification. Use a blank to separate two pathnames, not a comma. bpplinclude interprets a comma as part of the pathname; it concatenates two or more comma-delimited pathnames into a single pathname with embedded commas. The command does not verify the syntax or the existence of the pathnames.

For MS-SQL-Server Intelligent Policies, this option adds a SQL Server object to the backup selections. Valid values are WHOLE_DATABASE, the name of a filegroup, or the name of a file. WHOLE_DATABASE backs up all databases in the SQL Server instance. When you add a filegroup or file, that object is included for all databases in the policy that contain a filegroup or file with that name. Use the bpplclients command to configure the list of instances and databases that is configured for the policy.

For NAS-Data-Protection policy, you can specify backup selection in the following format:

nfs:<array>StorageArrayIPAddress</array><nas_head>Filer_or_NAS_Server
</nas_head><nas_share./volume_name</nas_share>"

Example:

NetApp: 
nfs:<array>10.0.0.1</array><nas_head>ExampleNAS</nas_head><nas_share>
/nas_share_01</nas_share>

Nutanix AFS:
nfs:<array>Example.company.com</array><nas_head>EXAMPLE_AFS</nas_head>
<nas_share>/afs_share_01</nas_share>
-add -f filename

Adds all files that are listed in filename to the policy file list.

-addtoquery query_string...

Adds the specified query string to the end of the policy query rules, or creates a query if none exists. Quotes (") must be escaped with a backslash (\).

For more details and examples, refer to the NetBackup for VMware Guide.

-addtoquery -f filename

Add an entry to the query rules from the specified file, or creates a query if none exists. In the file, quotes (") do not need to be escaped.

For more details and examples, refer to the NetBackup for VMware Guide.

-delete pathname ...

Deletes the specified pathnames, file name, script, or directive from the policy file list. Refer to -add for the pathname-list syntax. If you delete an item from the policy file list, you still can recover any backups or archives for that item. This option must be the final entry on the command line.

-delete -f filename

Deletes the specified file in filename from the policy file list.

-deletefromquery query_string...

Deletes the specified query string from the policy query rules.

For more details and examples, refer to the NetBackup for VMware Guide.

-deletefromquery -f filename

Deletes the file entries from the query rules.

For more details and examples, refer to the NetBackup for VMware Guide.

-exclude_volumes

Excludes specified volumes from being backed up when the policy is executed. Currently, applicable only for the NAS-Data-Protection policy.

-generation generation

Ensures that the command acts on a specific generation or version of a policy. The generation value increments each time a policy is saved. Use bpplinfo or bppllist to list the current generation value. If no generation is indicated, the command acts on the current version.

-L

Displays the contents of the policy file list in long format.

-l

Displays the contents of the policy file list in compact format.

Note:

The -l and -L displays are similar.

-modify {old_path_name new_path_name}

Modifies an entry in the policy file list. The values are a list of pathname pairs {old_path_name new_path_name}. For each pathname pair, new_name_path replaces old_name_path in the policy file list. If no list entry matches old_path_name, then new_path_name is not entered into the policy file list. Refer to the -add option for the pathname syntax. Delimit the list entries with spaces, both within a pathname pair and between pathname pairs. This option must be the final entry on the command line.

-M master_server,...

A list of master servers. This list is a comma-separated list of host names. If this option is present, the command is run on each of the master servers in this list. The master servers must allow access by the system that issues the command. If an error occurs for any master server, the process stops at that point in the list. The default is the master server for the system where the command is entered.

policy_name

Specifies the policy for which the policy file list is to be set.

-reason "string"

Indicates the reason why you choose this command action. The reason text string that you enter is captured and appears in the audit report. Enclose this string with double quotes ("..."). The string must not exceed 512 characters. It cannot begin with a dash character (-) nor contain a single quotation mark (').

-v

Selects the verbose mode for logging. This option is meaningful only when you run with the debug log function on ( that is, when the following directory is defined):

UNIX systems:

/usr/openv/netbackup/logs/admin

Windows systems:

install_path\NetBackup\logs\admin

EXAMPLES

Example 1 - While the backup runs on another master server kiwi, display the policy file list for policy oprdoc_policy on the master server plim:

# bpplinclude oprdoc_policy -L -M plim
Include:    /oprdoc   (UNIX systems)
Include:    c:\oprdoc (Windows systems)

Example 2 - Add and delete the pathnames that include one wildcard entry to illustrate bpplinclude interpretation of wildcards:

UNIX systems:

# bpplinclude mkbpolicy -add /yap /y*
# bpplinclude mkbpolicy -L
     Include: yap
     Include: /y*
# bpplinclude mkbpolicy -delete /y*
# bpplinclude mkbpolicy -L
     Include: /yap

Windows systems:

# bpplinclude mkbpolicy -add C:\yap C:\y*
# bpplinclude mkbpolicy -L
     Include: C:\yap
     Include: C:\y*/y*
# bpplinclude mkbpolicy -delete C:\y*
# bpplinclude mkbpolicy -L
     Include: C:\yap

Note:

bpplinclude does not interpret the wildcard entry y* for -delete as meaning that both yap and y* should be deleted. Only y* is deleted from the include list for mkbpolicy. The interpretation of the wildcard occurs during the actual backup when NetBackup selects files to back up.

Example 3 - Add two entries to the policy file list for a policy, then modify them:

UNIX systems:

# bpplinclude mkbpolicy -add "/ima file" "/ura file"
# bpplinclude mkbpolicy -L
     Include: /ima file
     Include: /ura file
bpplinclude mkbpolicy -modify "/ima file" "/ima file 2" "/ura file" 
"/ura file 2"
bpplinclude mkbpolicy -L
  Include: /ima file 2
  Include: /ura file 2

Windows systems:

# bpplinclude mkbpolicy -add "C:\ima file" "C:\ura file"
# bpplinclude mkbpolicy -L
     Include: C:\ima file
     Include: C:\ura file
# bpplinclude mkbpolicy -modify "C:\ima file" "C:\ima file 2" 
"C:\ura file" "C:\ura file 2"
# bpplinclude mkbpolicy -L
  Include: C:\ima file 2
  Include: C:\ura file 2

Example 4 - Add a raw partition to the policy file list for the policy rc (UNIX clients). The full path name for the device is used (the command is all on one line):

bpplinclude rc -add /devices/sbus@2,0/dma@2,81000/esp@2,80000/ 
sd@6,0:h,raw

For more about UNIX raw partitions, see the NetBackup Administrator's Guide, Volume I.

Example 5 - Display the policy file list for the policy mkb_policy:

# bpplinclude mkb_policy -l

UNIX systems:

INCLUDE /etc/services
    INCLUDE /etc/aliases
    INCLUDE /usr/bin

Windows systems:

INCLUDE C:\services
    INCLUDE C:\aliases
    INCLUDE C:\Programs

Example 6 - Add vm17 to the list of values in the query rules of policy1.

# bpplinclude policy1 -addtoquery ,\"vm17\"

Example 7 - Delete a query from a policy.

# bpplinclude policy1 -deletefromquery -f qfile1

Example 8 - Add a SQL Server filegroup to the policy file list.

# bpplinclude sql_policy -add FG1

FILES

UNIX systems:

/usr/openv/netbackup/logs/admin/*
/usr/openv/netbackup/db/policy/policy_name/includes

Windows systems:

install_path\NetBackup\logs\admin\*
install_path\NetBackup\dv\policy\policy_name\includes

SEE ALSO

See bpplclients.

See bpplinfo.

See bpschedule.

See bppldelete.

See bppllist.