Veritas NetBackup™ Commands Reference Guide

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

Name

bpclient — manage client entries on a master server

SYNOPSIS

bpclient -All [-M master_server] [-l | -L | -H]

bpclient -client client_name [-M master_server] [-l | -L | -H]

bpclient -client client_name [-M master_server] -add | -update [-dynamic_address 0|1] [-free_browse 0|1|2] [-list_restore 0|1|2|3] [-max_jobs [1-99] [-current_host host_name] [[-online] | [-offline [[-ut] -onlineat time]] | [-online_backup] | [-offline_backup [[-ut] -online_backup_at time]] | [-online_restore] | [-offline_restore [[-ut] -online_restore_at time]]] [-WOFB_enabled 0|1] [-WOFB_FIM 0|1] [-WOFB_usage 0|1] [-WOFB_error 0|1] [-connect_options 0|1|2 0|1|2 0|1|2|3] [-granular_proxy granular_proxy_host] [-client_direct 0|1|2] [-client_direct_restore 0|1|2]

bpclient -client client_name [-M master_server] -delete

bpclient -client client_name -add_alias alias_name | -delete_alias alias_name [-M master_server]

bpclient -client client_name -add_all_aliases | -delete_all_aliases | -list_all_aliases [-M master_server]

bpclient -policy policy_name -validate -fi

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

The bpclient command describes how a NetBackup server connects to NetBackup clients.

OPTIONS

-add

Adds a new client entry.

-add_alias | -delete_alias alias_name

Adds a new entry for a client alias or deletes an existing client alias entry.

-add_all_aliases | -delete_all_aliases | -list_all_aliases

Does one of the following:

  • -add_all_aliases adds a new entry for every client alias.

  • -delete_all_aliases deletes all aliases.

  • -list_all_aliases outputs a list of all alias entries.

-All

Lists all client entries. Only the client entries appear that are added explicitly by using the bpclient command.

-client client_name

Specifies the name of the client to list or update.

-client_direct 0 | 1 | 2

Client Direct improves backup performance by using the OpenStorage storage server instead of the media server to transfer data to the client. The -client_direct option setting determines if and when the client uses this feature. The following settings are possible:

0 = Never use Client Direct as the data transfer method on the specified host. Always use the normal data transfer method. This setting is the default condition.

1 = Prefer to use Client Direct. Probes for the Client Direct capabilities on the storage server that is identified during the backup. If the probe passes, NetBackup uses the Client Direct data transfer method on the specified client. If the probe fails, is uses the normal data transfer method.

2 = Always use Client Direct. Tries to use only the Client Direct method with the specified client. If this method fails for any reason, the job fails. No other transfer method is tried.

-client_direct_restore 0 | 1 | 2

Client Direct Restore improves restore performance by using the OpenStorage storage server instead of the media server to restore data to the client. The -client_direct option setting determines if and when the client uses this feature. The following settings are possible:

0 = Never use Client Direct Restore as the data transfer method on the specified host. Always use the normal data transfer method. This setting is the default condition.

1 = Prefer to use Client Direct Restore. The command probes for Client Direct Restore capabilities on the storage server that is identified during the restore. If the probe passes, NetBackup uses the Client Direct Restore data transfer method on the specified client. If the probe fails, is uses the normal data transfer method.

2 = Always use Client Direct Restore. Tries to use only the Client Direct Restore method with the specified client. If this method fails for any reason, the job fails. No other transfer method is tried.

-connect_options 0|1|2 0|1|2 0|1|2|3

This option applies only to the client names that are local to the NetBackup server that makes the connection.

First set of arguments, Ports, represents the following:

0 = Reserved Port: Use a reserved port number.

1 = Non-reserved Port: Connect to the client's bpcd by using a non-reserved port number. If you select this option, enable Allow Nonreserved Ports for the selected client.

2 = Use Default: Use Default is the default. Use the value that the DEFAULT_CONNECT_OPTIONS configuration entry on the server defines.

The second set of arguments, BPCD Connect Back, represents the following:

0 = Random Port: NetBackup randomly chooses a free port in the allowed range to perform the traditional connect-back method.

1 = VNETD port: This method does not require a connect-back to a random port. The connect-back is to the Veritas Network Daemon (vnetd) instead. The Veritas Network Daemon was designed to enhance firewall efficiency with NetBackup during server-to-server and server-to-client communications.

2 = Use Default: The default option. Use the value that the DEFAULT_CONNECT_OPTIONS configuration entry on the server defines.

The third set of arguments (Daemon Connection Port) represents the following:

0 = Automatic: This option means that VNETD is used if possible; otherwise Legacy is used.

1 = Use the VNETD port.

2 = Use the Legacy port number.

3 = Use Default: The default option. Use the value that the DEFAULT_CONNECT_OPTIONS configuration entry on the server defines.

Note:

If the vnetd Daemon Connection Port is used, the BPCD Connect Back setting is not applicable. If the vnetd Daemon Connection Port is used, non-reserved ports are always used regardless of the value of the Ports setting.

-current_hostname host_name

The current host name of the client. This option is meaningful only when the option -dynamic_address 1 is used. Usually, you do not have to enter a -current_hostname value. The client normally contacts the master server to set the host name and the IP address.

-delete

Deletes an existing client entry.

-dynamic_address 0 | 1

0 = The client name is assumed to be a valid host name for the client (default).

1 = The client is assumed to have a dynamic host name (such as DHCP).

-fi

Validates the -snapshot_method_args options on the bpplinfo command. See - validate option.

-free_browse 0 | 1 | 2

A method that allows users to get around the checking that the server does when it browses images (owner or group). By default, normal users are not allowed to browse into scheduled backups on Windows.

0 = Allow

1 = Deny

2 = Use

By default, both the client and the server should be set up to 0 (allow). To browse freely, either the client or the server must be set up to 2 (use). Neither can be set up for 1 (deny).

-granular_proxy granular_proxy_host

Specifies the Windows granular proxy host for a source client. You can use this option when you duplicate backup images that are enabled by the Granular Recovery Technology (GRT).

-H

Lists host-specific client information.

-l

Lists the limited client information.

-L

Lists all client information in a VERBOSE format.

-list_restore 0 | 1 | 2 | 3

Sets up on the server to disallow list and restore requests from a particular client. The value in the client database overrides the bp.conf file setting.

0 = Not specified (default)

1 = Allow both list and restore requests

2 = Allow list requests only

3 = Deny both list and restore requests

-M master_server

Name of the master server that contains the client entries. The first server name in the local configuration is the default master server.

-max_jobs [1-99]

The maximum number of jobs up to 99 that are allowed to run concurrently on this client. You can configure this item in the NetBackup Administration Console. It is labeled "Maximum data streams." To perform this function by using this GUI, select the following: Host Properties > Master Servers > (double-click the master server name) > Client Attributes.

-online | -offline

Sets the client state to online or offline for both backups and restores.

-onlineat time

Sets the client state to online for both backups and restores at the time specified.

-online_backup | -offline_backup

Set the client state to online or offline for backup.

-online_backup_at time

Sets the client state to online for backup at the time specified.

-online_restore | -offline_restore

Set the client state to online or offline for restore.

-online_restore_at time

Sets the client state to online for restore at the time specified.

-policy policy_name

Specifies the name of the backup policy to validate. This option is used with the - validate and - fi options.

-update

Updates an existing client entry.

-ut

Specifies the time in UNIX time.

-validate

When using NetBackup commands to create a snapshot-based policy such as VMware or Hyper-V, this option validates the policy. To validate a policy that is created with the bpplinfo -snapshot_method_args command, - validate must be used with the - fi option.

For more information on using NetBackup commands to create a VMware or Hyper-V policy, see the NetBackup for VMware Guide or the NetBackup for Hyper-V Guide.

-WOFB_enabled 0|1

0 = disables Windows Open File Backup for the client that is specified in client_name.

1 = enables Windows Open File Backup for the client that is specified in client_name.

-WOFB_error 0 | 1

0 = Abort Backup on Error. Specifies that a backup aborts if it fails for a snapshot-related issue after the snapshot is created and while the backup uses the snapshot to back up open or active files on the file system.

1 = Disable Snapshot and Continue. Specifies that if the snapshot becomes invalid during a backup, the volume snapshots for the backup are destroyed. The backup continues with Windows Open File Backups disabled.

-WOFB_FIM 0 | 1

0 = Use Volume Snapshot Provider (VSP) as the snapshot provider for the Windows Open File Backups. VSP is supported only on the clients that use NetBackup Release 6.x. Clients that use NetBackup Release 7.x only use VSS. If you run a Release 7.x client and select VSP with this option, NetBackup automatically runs VSS instead.

1 = Use Microsoft's Volume Shadow Service (VSS) as the snapshot provider for Windows Open File Backups.

-WOFB_usage 0|1

0 = Individual Drive Snapshot. Specifies that the snapshot be of an individual drive. When this property is enabled, snapshot creation and file backup are done sequentially on a per volume basis.

1 = Global Drive Snapshot. Specifies that the snapshot is of a global drive. The snapshots are taken at one time for all the volumes that require snapshots for the backup job (or stream group for multistreamed backups).

EXAMPLES

Example 1 - Determine if the client hagar is in the client database on the master server:

# bpclient -client hagar -L

Example 2 - Add casper to the client database on the master server. It also allows a maximum of five concurrent jobs to be run on casper.

# bpclient -client casper -add -max_jobs 5

Example 3 - List all client information verbosely for client ollie.

# bpclient -client ollie -L
Client Name: ollie
 Current Host:
        Hostname: ollie
        IP Address: 0.0.0.0
Dynamic Address:        no
Free Browse:   Allow
List Restore:  Not Specified
Max Jobs This Client:  Not Specified
WOFB Enabled:  yes
WOFB FIM:      VSP
WOFB Usage:    Individual Drive Snapshot
WOFB Error Control:    Abort on Error
Client Direct: Prefer to use client-side deduplication or
               Prefer to move data direct to storage
Client Direct Restore: Move data via media server
OST Proxy:     Off
OST Proxy Server:      Unspecified
Connect options:       2 2 3