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

bpplclients — administer clients within NetBackup policies

SYNOPSIS

bpplclients

bpplclients policy_name | -allunique [-pt policy_type] [-L | -l | -U | -noheader] [-M master_server,...] [-v]

bpplclients policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -add host_name hardware_os [-priority priority]

bpplclients policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -delete host_name ...

bpplclients policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -modify host_name [-hardware hardware] [-os os] [-priority priority]

bpplclients policy_name -rename old_client_name new_client_name [-os os] [-priority priority] [-hardware hardware] [-generation generation] [-reason "string"]

bpplclients policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -add_instance instance_name host_name | -delete_instance {instance_name host_name [instance_name2 host_name2] [...]}

bpplclients policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -add_instance_database instance_name database_name host_name | -delete_instance_database {instance_name1 database_name1 host_name1 [instance_name2 database_name2 host_name2] [...]}

bpplclients policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -add_instance_group instance_group_name | -delete_instance_group instance_group_name ...

 

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

bpplclients does one of the following:

  • Produces a listing of clients.

  • Adds a new client to a policy.

  • Deletes a list of clients from a policy.

  • Modifies an existing client in a policy.

For the -add, -delete, and -modify options, bpplclients returns to the system prompt immediately after it submits the client change request to NetBackup. To determine whether the change was successful, run bpplclients again to list the updated client information.

When the listing option is used, the list is ordered alphabetically by client name. Each client entry is on a single line, with a single entry for each client.

Authorized users can initiate this command.

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

OPTIONS

bpplclients consists of two forms. The bpplclients form that you use determines the options that you use with bpplclients.

The second form of bpplclients produces a listing of information about the clients for a single policy or for all policies. The following options apply to this form:

-add host_name hardware os [priority]

Adds a client to the policy. If the local system has defined the maximum number of clients already, an error is returned. The maximum number of clients is unlimited (the installation default) for NetBackup Enterprise Server and 4 for NetBackup Server. Specify the host name, hardware type, and operating system. The priority option is not implemented at this time.

-add_instance_database instance_name database_name host_name

This option applies to SQL Server intelligent policies. Adds a specific database in an instance to the policy.

-add_instance instance_name host_name

This option applies to SQL Server intelligent policies. Adds an instance to the policy.

-add_instance_group instance_group_name

This option applies to SQL Server intelligent policies. Adds an instance group to the policy.

-delete host_name ...

Deletes one or more clients from the policy. Up to 20 clients can be deleted at a time. Specify the clients as a space-delimited list of host names.

-delete_instance {instance_name host_name [instance_name2 host_name2] [...]}

This option applies to SQL Server intelligent policies. Deletes an instance from the policy. Up to 20 instances can be deleted at a time. Group instances and host names in a space-delimited list.

-delete_instance_database {instance_name1 database_name1 host_name1 [instance_name2 database_name2 host_name2] [...]}

This option applies to SQL Server intelligent policies. Deletes a database in an instance from the policy. Up to 20 databases can be deleted at a time. Group database names, instance names, and host names in a space-delimited list.

-delete_instance_group instance_group_name ...

This option applies to SQL Server intelligent policies. Deletes an instance group from the policy. Up to 20 instance groups be deleted at a time. Specify the names in a space-delimited list.

-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 specified, the command acts on the current version.

-hardware hardware

Specifies the hardware type of this client. In the dialog box for adding clients to a policy with the Backup Policy Management utility, select one of the hardware types.

-L

Displays the listing in long format. No two-line header appears at the top of the listing; the header is embedded in the line for each client. The line for each client includes the following fields:

Client/HW/OS/Pri: (the header)

Client name

Hardware type

Operating system

Priority

Ignore the four additional fields. They are either unused or used for internal processes.

-l

Displays the listing in short format; this option produces a terse listing. It also is called raw output mode. No two-line header appears at the top of the listing; the header is embedded in the line for each client. The listing consists of the following fields:

Field 1 = Client name

Field 2 = Hardware. The operating system type of the client. Example: Linux

Field 3 = Operating system name of the client. Example: RedHat

Field 4 = Priority. The priority of the client in the specified policy.

Fields 5-7 are unused.

This option is useful for scripts or the programs that rework the listing contents into a customized report format.

-M master_server,...

Lists the alternative master servers. This option consists of a comma-delimited list of host names. If this option is present, each master server in the list runs the bpplclients command. Each master server in the list must allow access by the system that issues the bpplclients command. If an error occurs for any master server, the process stops at that point.

If bpplclients produces a list, the list is the composite of the returned information from all the master servers in this list.

If bpplclients adds, deletes, or modifies a client (explained later), the change is made on all the master servers in this list.

-modify host_name ...

Modifies the attributes for a client within a policy. The client was added to the policy previously. The attribute values follow the client name and replace the previous equivalent attribute values for this client. You must modify at least one of the client's attributes. -priority is not implemented at this time.

-noheader

Displays the listing without any header. The listing consists of one line for each client, which contains the hardware type, operating system, and client name.

-os os

Specifies a different operating system for the client. In the dialog box for adding clients to a policy with the Backup Policy Management utility, select one of the operating systems.

The values that you choose for the hardware and the -os options must form a valid combination.

policy_name | -allunique [-pt policy_type]

policy_name specifies the name of a policy. It lists client information only for that policy.

-allunique without -pt policy_type lists client information for all policies that are defined for NetBackup on the master server.

If you use -allunique -pt policy_type, where policy_type is a specific policy type (such as Sybase), the following occurs: The command lists the client information only for the clients that belong to that type of policy.

If the command line contains neither the policy_type nor -allunique option, the listing contains client information for all policies. If this option is used it must be first on the command line.

-pt policy_type

Specifies the policy type by entering one of the following character strings (the default is Standard):

DataStore
DataTools-SQL-BackTrack
DB2
Enterprise-Vault
FlashBackup
Hyper-V
Informix-On-BAR
Lotus-Notes
MS-Exchange-Server
MS-SharePoint
MS-SQL-Server
MS-Windows
NBU-Catalog
NDMP
Oracle
PureDisk-Export
SAP
Split-Mirror
Standard
Sybase
Vault
VMware
-priority priority

Not implemented.

policy_name

Identifies the policy that has the client. This option must be the first option on the command line.

-reason "string"

Indicates the reason that you choose this command action. The reason text string 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 (').

-rename old_client_name new_client_name

old_client_name specifies the current name of the client and new_client_name specifies the new name.

-U

Displays the listing in user format. The listing consists of one line for each client, which contains the hardware type, operating system, and client name. A two-line header begins the listing which is the default format.

-v

Selects the verbose mode. This option causes bpplclients to log additional information for debugging purposes. The information goes into the NetBackup administration daily debug log. This option is meaningful only when you enable the debug log function (that is, when the following directory is defined):

UNIX systems: /usr/openv/netbackup/logs/admin
Windows systems: install_path\NetBackup\logs\admin

This option must precede the -add, -delete, or -modify option on the command line.

EXAMPLES

Example 1 - While the master server runs, list the clients that are known to the master server.

# bpplclients
Hardware         OS               Client
---------------  ---------------  --------------
Windows-x64      Windows2008      marmot
HP9000-800       HP-UX 11.23      squash

This command can also be entered on a client named hatt, with the same results.

Example 2 - List the defined clients for the policy onepolicy:

# bpplclients onepolicy
Hardware         OS               Client
---------------  ---------------  --------------
Solaris          Solaris10        jeckle
RS6000           AIX5             streaky
HP9000-800       HP-UX 11.31      shark

Example 3 - Add the client marmot to the policy twopolicy on the master servers serv1 and serv2. The hardware type for lynx is HP9000; the operating system is HP-UX 11.23. The default priority is used.

# bpplclients twopolicy -M serv1,serv2 -add lynx HP9000 HP-UX 11.23

Example 4 - Delete the clients marmot and vole from the policy twopolicy on the master servers serv1 and serv2.

# bpplclients twopolicy -M serv1,serv2 -delete marmot vole

Example 5 - While the master server hatt runs, list client information for policy BackTrack on master server beaver:

# bpplclients BackTrack -M beaver
Hardware         OS               Client
---------------  ---------------  --------------
Solaris          Solaris10        saturn

Example 6 - Assume that you have a policy that is called my_policy with one defined client. The client name is pear, the operating system is Solaris 10, and the hardware type is Solaris.

# bpplclients my_policy -rename pear apple -os MacOS -hardware Mac

This command changes the client name pear in my_policy to apple. It also changes the os from Solaris to MacOS and hardware from Solaris to Mac.

RETURN VALUES

An exit status of zero (0) means that the command ran successfully.

Any exit status other than zero (0) means that an error occurred.

If the administrative log function is enabled, the exit status is logged in the administrative daily log under the log directory:

UNIX systems: /usr/openv/netbackup/logs/admin

Windows systems: install_path\NetBackup\logs\admin

It has the following form:

bpplclients: EXIT status = exit status

If an error occurred, a diagnostic precedes this message.

FILES

UNIX systems:

/usr/openv/NetBackup/logs/admin/*
/usr/openv/NetBackup/db/policy/policy_name/clients

Windows systems:

install_path\NetBackup\logs\admin\*
install_path\NetBackup\db\policy\policy_name\clients

SEE ALSO

See bpplinfo.