Veritas NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- add_media_server_on_clients
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpclient
- bpclimagelist
- bpclntcmd
- bpclusterutil
- bpcompatd
- bpconfig
- bpdbjobs
- bpdbm
- bpdgclone
- bpdown
- bpduplicate
- bperror
- bpexpdate
- bpfis
- bpflist
- bpgetconfig
- bpgetdebuglog
- bpimage
- bpimagelist
- bpimmedia
- bpimport
- bpinst
- bpkeyfile
- bpkeyutil
- bplabel
- bplist
- bpmedia
- bpmedialist
- bpminlicense
- bpnbat
- bpnbaz
- bppficorr
- bpplcatdrinfo
- bpplclients
- bppldelete
- bpplinclude
- bpplinfo
- bppllist
- bpplsched
- bpplschedrep
- bpplschedwin
- bppolicynew
- bpps
- bprd
- bprecover
- bprestore
- bpretlevel
- bpschedule
- bpschedulerep
- bpsetconfig
- bpstsinfo
- bpstuadd
- bpstudel
- bpstulist
- bpsturep
- bptestbpcd
- bptestnetconn
- bptpcinfo
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCerts
- configureCertsForPlugins
- configureMQ
- configurePorts
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- manageClientCerts
- mklogdir
- nbauditreport
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcloudrestore
- nbcomponentupdate
- nbcplogs
- nbcredkeyutil
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdb2adutl
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbfindfile
- nbfirescan
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbmlb
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbregopsc
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbsetconfig
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- resilient_clients
- restoretrace
- stopltid
- tldd
- tldcd
- tpautoconf
- tpclean
- tpconfig
- tpext
- tpreq
- tpunmount
- verifytrace
- vltadm
- vltcontainers
- vlteject
- vltinject
- vltoffsitemedia
- vltopmenu
- vltrun
- vmadd
- vmchange
- vmcheckxxx
- vmd
- vmdelete
- vmoprcmd
- vmphyinv
- vmpool
- vmquery
- vmrule
- vmupdate
- vnetd
- vssat
- vwcp_manage
- vxlogcfg
- vxlogmgr
- vxlogview
- W2KOption
- Index
Name
bpsturep — replace selected NetBackup storage unit attributes
SYNOPSIS
-label storage_unit_label [-verbose] [-host host_name | -nodevhost] [-path path_name | -dp disk_pool | -density density [-rt robot_type -rn robot_number] [-nh NDMP_attach_host] [-cj max_jobs] [-odo on_demand_only_flag] [-mfs max_fragment_size] [-maxmpx mpx_factor] [-cf clearfiles] [-flags flags] [-tt transfer_throttle] [-hwm high_water_mark] [-lwm low_water_mark] [-okrt ok_on_root] [[-addhost | -delhost] host_name [host_name]] [-hostlist host_name [host_name]] [-M master_server [,...] [-uw 1|0]
-group storage_unit_group [-addstu | -delstu] storage_unit_label [-M master_server [,...]] [-sm selection_method]
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 bpsturep command modifies an existing NetBackup storage unit by replacing selected storage-unit or storage-unit-group attributes in the NetBackup catalog. The command line must include a label for the storage unit or a group name for the storage unit group. The label or the group name is the only storage-unit attribute that bpsturep cannot modify.
Note:
This command does not enable you to change a disk storage unit (DSU) or a tape storage unit to a disk staging storage unit (DSSU). In addition, you cannot change a DSSU to a DSU or a tape storage unit.
Use the bpsturep command with care. The changes to the storage unit or storage unit group must be compatible with existing attributes. Make sure that resulting attribute combinations are valid, especially for the following attributes:
robot_type robot_number density_type max_fragment_size path_type NDMP_attach_host
The safest way to modify these attributes is to run bpsturep one time for each attribute to be replaced.
bpsturep makes the changes by modifying the storage unit with the specified attribute changes. Run bpstulist after bpsturep to determine whether the intended changes were applied.
Errors go to stderr. A log of the command's activity goes to the NetBackup administrative log file for the current day.
For more about storage units, see the NetBackup Administrator's Guide, Volume I.
Any authorized user can run this command.
For more about NetBackup authorization, see the NetBackup Security and Encryption Guide.
OPTIONS
- -cf clearfiles
Enables the NBU media to perform data translation operations on backup data. Typically, OpenStorage plugins use metadata to perform the block-level deduplication operations that reduce the total amount of disk space that is used. This value is valid only for disk storage units that are configured with OST disk pools.
The clearfiles variable can be one of the following values:
0 - Disables all data translation operations.
1 - Enables detailed translation operation. The metadata describes all of the attributes of the files that are backed up. These files are called clear files.
2 - Enables simple translation operation. The metadata identifies only the name, size, and byte offset location of the files that are backed up. They are called opaque files.
- -cj max_jobs
The maximum number of concurrent jobs that are permitted for this storage unit. max_jobs is a non-negative integer. The appropriate value depends on your server's ability to run multiple backup processes comfortably and the available space on the storage media.
For more about maximum jobs per policy, see the NetBackup Administrator's Guide, Volume I.
Zero (0) means that this storage unit is never selected when a job is scheduled. The default is 1.
- -density density_type
If this option is present, the storage unit type is Media Manager. This option does not have a default. If the command line includes a robot type, the value for density should be consistent with the robot type. The -density, -path, and -dp options can only be used independently.
Valid density types are:
dlt - DLT cartridge
dlt2 - DLT cartridge alternate
8mm - 8mm cartridge
4mm - 4mm cartridge
qscsi - 1/4-inch cartridge
Note:
The following densities apply only to NetBackup Enterprise Servers.
hcart - 1/2 Inch Cartridge
hcart2 - 1/2 Inch Cartridge alternate
dtf - DTF Cartridge
- -dp disk_pool
Specifies the name of the disk pool, which is the data storage area for this storage unit. This option can be used only when the disk type is 6 (DiskPool). The disk pool must already exist.
- -dt disk_type
Enables the user to specify a disk type. The following are the valid values for disk_type:
1 - BasicDisk
3 - SnapVault
6 - DiskPool
- -flags flags
Specifies the storage unit to be a staging storage unit, which allows for a quick restore. Valid values for flags are: NONE and STAGE_DATA. Currently valid for only disk storage units.
- -group storage_unit_group
The name of a storage unit group. This group is the storage unit whose members bpsturep adds or deletes. Use -addstu storage_unit to add storage units to the group. Use -delstu storage_unit to remove storage units from the group.
- -host host_name
Note:
NetBackup Server does not support remote media servers.
The NetBackup host to which the destination media is attached. The default is the host name of the local system.
The host you select must be either your NetBackup master server or a media server (if you configure media servers). The host name must be the network name for the server as known by all NetBackup servers and clients.
If host_name is a valid network name and is not yet configured, the value host_name is added to NetBackup's configuration as a media server. On UNIX, this value shows up in bp.conf; on Windows, this value shows up in the Configuration window for Servers. If host_name is not a valid network name, you must configure it manually.
- -hwm high_water_mark
This option is a user-configurable threshold. The default setting for the high water mark is 98%. When the high water mark is reached, NetBackup becomes proactive, under two different circumstances:
- When it initiates a job and the total capacity is used, the DSU is considered to be Full. If it selects from multiple storage units in a storage unit group, the following occurs: The media and the device selection (MDS) do not assign new jobs to units that are at or over the high water mark. It looks for another storage unit in the group, to assign to the job.
- During a job, if the Staging attribute is set and the total capacity is used, staging expires images to free space on the DSU. This action occurs to accommodate more backup data.
- -label storage_unit_label
The name of a storage unit. This unit is the storage unit whose attributes bpsturep replaces. This option is required. The maximum length of a storage-unit label is 128 characters.
- -lwm low_water_mark
This option is a user-configurable threshold, which disk storage units that do disk staging use. The default setting for the Low Water Mark is 80%.
When the High Water Mark is reached, you should do one of the following:
- Migrate images to other storage units, until the "Low Water Mark' is reached.
- Free disk space by expiring disk images for the oldest staged images, until the "Low Water Mark" is reached.
Note:
If you want to save most of your available data, configure the Low Water Mark setting near the High Water Mark. In addition, the Low Water Mark must be less than High Water Mark. They cannot be equal settings.
- -mfs max_fragment_size
The maximum fragment size in megabytes that is specified (how large a fragment for a NetBackup image can be). NetBackup supports a maximum fragment size of 1,000,000 megabytes (one terabyte).
For a Media Manager storage unit, this value is either zero. Or it is any integer greater than or equal to 50 megabytes (MB) and less than or equal to 1,048,576 megabytes (MB) or (1024 GB). The default value is 0, which is equivalent to the largest value that is allowed, 1024 GB.
For a Disk storage unit, this value ranges from 20 megabytes to 2000 megabytes (2 gigabytes). The default value is 524288 (512 GB).
- -maxmpx mpx_factor
The maximum multiplexing factor. Multiplexing sends concurrent, multiple backups from one or several clients to a single drive.
For more about multiplexing (MPX), see the NetBackup Administrator's Guide, Volume I.
The multiplexing factor can range from 1 to 32, where one (1) means no multiplexing. A value greater than one (1) means that NetBackup can create multiplexed images on the destination medium. Because of how the local NetBackup installation may be licensed, you may not be able to assign multiplexing factors in the entire range 1-32. The default is 1.
- -M master_server [,...]
Specifies 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 issued 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.
- -nh NDMP_attach_host
Specifies the host name of the NDMP server. If this option is present, the storage unit type is set to NDMP. The default is no NDMP server.
- -nodevhost
Indicates that no media server is to be associated with this storage unit.
- -odo on_demand_only_flag
The on-demand-only flag controls whether the storage unit is used only for the backups that explicitly request (demand) the storage unit:
To make the storage unit available only to the policies or the schedules that request it, set the flag to 1 (enabled).
To make the storage unit available to any policy or schedule, set the flag to 0 (disabled).
If the storage unit's type is Disk, the default is 1; NetBackup uses the storage unit only when explicitly requested. Otherwise, the default is 0.
- -okrt ok_on_root
If this flag is not set, neither backups nor directory creation occurs on the root file system. If the ok_on_root flag is set, then backups and directory creations happen normally.
The default value for this flag is 0. Backups and directory creations to a disk storage unit (BasicDisk) do not occur if the path is on the root file system.
On UNIX systems, root is "/".
On Windows, root is the Volume where the windows\system directory resides.
- -path path_name
The path to a disk file system, expressed as an absolute pathname, the data storage area for this storage unit. When this option is present, the storage unit type is Disk. This option does not have a default. The -density, -path, and -dp options can only be used independently.
In general when this option is used, enable the on-demand-only flag (see -odo). Otherwise, if you have any NetBackup policies that do not require a specific storage unit, they can fill the disk file system path_name. This action can cause serious system problems. For instance, if the system swap area happens to be on the same file system, new processes may fail.
If the path name is defined as a disk staging storage unit (DSSU), use this option to change the path name a different DSSU. It cannot be used to change a DSSU to a different type of storage unit.
- -rn robot_number
The robot number for this storage unit. The robot number must be greater than or equal to 0. The robot number can be obtained from the Media and Device Management of the Administration Console. This option is ignored unless the -rt option is present. This option does not have a default.
For more about rules regarding the use of the robot number, see the NetBackup Administrator's Guide, Volume II.
- -rt robot_type
The robot type for this storage unit. For non-robotic (stand-alone) devices select NONE or omit this option. The default value is NONE (Not Robotic). The value for density should be consistent with the robot type
If this option is set to any value other than NONE, the -rn option is required.
Available robot type codes are:
NONE - Not Robotic
TLD - Tape Library DLT
ACS - Automated Cartridge System
- -sm selection_method
Selects the method in which a storage unit group is chosen. This option is valid only for storage unit groups. The following are its possible values:
Prioritized = 1 (DEFAULT) Least Recently Selected = 2 Failover = 3
Load Balance = 4 (appears if the capacity management license is installed)
Option 1: Prioritized is the default condition. It selects the first storage unit in the list until either the unit is down or full, or its max-concurrent-jobs setting is reached. Then the next storage unit in the list is examined and so on until an available one is found.
Option 2: Least Recently Selected selects the least-recently selected storage unit.
Option 3: Failover is the same as Prioritized except MDS queues a job to wait for the first storage unit if the max-concurrent-jobs is reached. MDS moves to the next storage unit in the list only if the first unit is down or full.
Option 4: Load Balance. For this option to appear, make sure that you have installed the capacity management license. If the user selects this option, Media Device Selection (MDS) balances the job load by considering if a media server meets these conditions:
Enough disk volume free space available to accommodate the estimated job size.
Enough CPU and memory resources available to accommodate another job.
Least amount of estimated job size data being processed compared to other media servers of the same class or rank.
If the license expires, then Load Balance reverts to Option 2 behavior. It selects the least-recently selected storage unit.
- -tt transfer_throttle
The Transfer Throttle setting appears for SnapVault storage units only.
The setting indicates the maximum SnapVault data transfer bandwidth. A setting of zero (default) indicates an unlimited bandwidth and data transfer would occur at the full network bandwidth. (Range: 0 (default) to 9999999.)
- -uw 1|0
This option is used to define a storage unit as write once, read many (WORM). If this option is set, the images that are written to the storage until are WORM locked. The default value for this option is 0. Once -uw is set to 1, defining the storage unit for WORM, it cannot be reverted. You must delete the storage unit and create it again with -uw 0.
- -verbose
Select verbose mode for logging. This mode is meaningful only when it runs with the debug log function on (when the following directory is defined):
UNIX systems:
/usr/openv/netbackup/logs/admin
Windows systems:
install_path\NetBackup\logs\admin
EXAMPLE
UNIX systems:
Change the path of disk storage unit mkbunit. The path is changed from /tmp/mkbunit to /tmp/mkbunit2:
# bpstulist mkbunit 0 beaver 0 -1 -1 1 0 /tmp/mkbunit 1 1 2000 *NULL* # bpsturep -label mkbunit -path /tmp/mkbunit2 # bpstulist mkbunit 0 beaver 0 -1 -1 1 0 /tmp/mkbunit2 1 1 2000 *NULL*
Windows systems:
Change the path of disk storage unit mkbunit. The path is changed from C:\tmp\mkbunit to C:\tmp\mkbunit2:
# bpstulist mkbunit 0 beaver 0 -1 -1 1 0 C:\tmp\mkbunit 1 1 2000 *NULL* # bpsturep -label mkbunit -path C:\tmp\mkbunit2 # bpstulist mkbunit 0 beaver 0 -1 -1 1 0 C:\tmp\mkbunit2/ 1 1 2000 *NULL*
FILES
UNIX systems:
/usr/openv/netbackup/logs/admin/*
Windows systems:
install_path\NetBackup\logs\admin\*
EMM database