Veritas NetBackup™ Commands Reference Guide

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

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_availability_group -ag_name availability_group_name [-cluster cluster_name] [-ag_idavailability_group_ID]} | {-delete_availability_group -ag_name availability_group_name [-cluster cluster_name] [-ag_id availability_group_ID]}

bpplclients policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] {-add_availability_group_database -ag_name availability_group_name -database database_name [-cluster cluster_name] [-ag_id availability_group_ID]} | {-delete_availability_group_database -ag_name availability_group_name -database database_name [-ag_id availability_group_ID] [-cluster cluster_name]}

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.

  • Adds a SQL Server object to a SQL Server Intelligent policy: instance, instance group, a specific database in an instance, availability group, or availability database.

  • Deletes a SQL Server object from a SQL Server Intelligent policy: instance, instance group, a specific database in an instance, availability group, or availability database.

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.

Note:

Veritas recommends that users do not 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

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

The first form of bpplclients has no options and produces a listing of information about the clients for all policies. For SQL Server Intelligent policies, bpplclients produces a list of the instance groups or the instances and databases for all policies. If you have other policy types, it is best to use bpplclients policy_name to display the backup selections for an MS-SQL-Server policy.

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_availability_group -ag_name availability_group_name [-cluster cluster_name] [-ag_id availability_group_ID]

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

In the policy attributes (bpplinfo), -client_list_type must be set to 3 (AVAILABILITY_GROUP). For advanced and basic availability groups, provide the -cluster cluster_name. For read-scale availability groups, provide the -ag_id availability_group_ID. You can add availability groups and availability databases to the same policy. You cannot add instance groups, instances, or standalone databases to a policy that contains availability groups or availability databases.

-add_availability_group_database -ag_name availability_group_name -database database_name [-cluster cluster_name] [-ag_id availability_group_ID]

This option applies to SQL Server intelligent policies. Adds a specific availability database to the policy.

In the policy attributes (bpplinfo), -client_list_type must be set to 3 (AVAILABILITY_GROUP). For advanced and basic availability groups, provide the -cluster cluster_name. For read-scale availability groups, provide the -ag_id availability_group_ID. You can add availability groups and availability databases to the same policy. You cannot add instance groups, instances, or standalone databases to a policy that contains availability groups or availability databases.

-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.

To back up a Nutanix Acropolis Cluster, you must add the display name of the virtual machine. The display name of a virtual machine is case-sensitive and it must not include a space.

-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.

In the policy attributes (bpplinfo), -client_list_type must be set to 1 (INSTANCE). You can add instances and databases to the same policy. You cannot add instances groups, availability groups, or availability databases to a policy that contains instances or standalone databases.

-add_instance instance_name host_name

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

In the policy attributes (bpplinfo), -client_list_type must be set to 1 (INSTANCE). You can add instances and databases to the same policy. You cannot add instances groups, availability groups, or availability databases to a policy that contains instances or standalone databases.

-add_instance_group instance_group_name

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

In the policy attributes (bpplinfo), -client_list_type must be set to 2 (INSTANCE_GROUP). You cannot add instances, standalone databases, availability groups or availability databases to a policy that contains or instances groups.

-delete_availability_group -ag_name availability_group_name [-clustercluster_name] [-ag_id availability_group_ID]

This option applies to SQL Server intelligent policies. Deletes an availability group from the policy. For advanced and basic availability groups, provide the -cluster cluster_name. For read-scale availability groups, provide the -ag_id availability_group_ID.

-delete_availability_group_database -ag_name availability_group_name -database database_name [-cluster cluster_name] [-ag_id availability_group_ID]

This option applies to SQL Server intelligent policies. Deletes an availability database from the policy. For advanced and basic availability groups, provide the -cluster cluster_name. For read-scale availability groups, provide the -ag_id availability_group_ID.

-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.

-include_discovered

This option lists the virtual machines that were discovered and selected the last time a VMware or Hyper-V intelligent policy ran. It also lists the host that performed the virtual machine discovery, such as the media server. This option is ignored if the intelligent policy has never been run.

When the option is used with -allunique, it additionally lists the virtual machines that were discovered and selected in the last run of all VMware and Hyper-V intelligent policies.

When the option is used with -allunique -pt policy_type and the policy_type is either VMware or Hyper-V, it lists the virtual machines that were discovered and selected in the last run of all VMware or all Hyper-V intelligent policies

-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):

BigData
DataStore
DataTools-SQL-BackTrack
DB2
Deployment
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

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.