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
- configureCertsForPlugins
- configureMQ
- configurePorts
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig throttle
- csconfig reinitialize
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- manageClientCerts
- mklogdir
- nbauditreport
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcloudrestore
- nbcomponentupdate
- nbcplogs
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- 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
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbregopsc
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbsetconfig
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- resilient_clients
- restoretrace
- stopltid
- tl4d
- tl8d
- tl8cd
- tldd
- tldcd
- tlhd
- tlhcd
- tlmd
- 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
Name
nbstlutil — run the NetBackup storage lifecycle policies utility
SYNOPSIS
active [-lifecycle name] [-destination name] [-before mm/dd/yyyy hh:mm:ss | -after mm/dd/yyyy hh:mm:ss]
inactive -lifecycle name | -destination name [-reactivation_time mm/dd/yyyy hh:mm:ss | -duration hours] [-before mm/dd/yyyy hh:mm:ss | -after mm/dd/yyyy hh:mm:ss]
inactive -lifecycle name -destination name [-reactivation_time mm/dd/yyyy hh:mm:ss | -duration hours] [-before mm/dd/yyyy hh:mm:ss | -after mm/dd/yyyy hh:mm:ss]
list_import_conf [-l|-U|-b|-json| -json_compact] [-lifecycle name] [-all_pending_images] [destination name] [-target_domain name]
cancel [-lifecycle name | -destination name] [-version number] [-before mm/dd/yyyy hh:mm:ss | -after mm/dd/yyyy hh:mm:ss] [-nowarn]
active | inactive | cancel -backupid id_value
diskspaceinfo [-stype server_type]
list [-l | -U | -b] [-rt I | IC | ICF | ICFS] [-lifecycle name [-version number] [-destination name] | -lifecycle_only | -backupid value | -jobid value] [-client name] [-mediaid value] [-mediaserver name] [-storageserver name] [-image_state value] | -copy_state value | -frag_state value | -image_incomplete | -image_inactive | -copy_incomplete | -copy_inactive] [-copy_type value] [-policy name] [-before mm/dd/yyyy hh:mm:ss | -after mm/dd/yyyy hh:mm:ss]
pendimplist
redo -backupid value -slpindex value
repllist [-l] [-U] [-sincetime timeval]
report [-lifecycle name [-version number]] [-client name] [-mediaid value] [-mediaserver name] [-storageserver name]
stlilist [-l] [-U] [[[-lifecycle name] [-destination name]] | -backupid value] [-client name] [-mediaid value] [-mediaserver name] [-image_state value | -image_incomplete | -image_inactive] [-copy_type value]
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 nbstlutil command provides a way for users to intervene in storage lifecycle policy (SLP) operations. The following are the utility functions:
Note:
Veritas recommends that users do not modify or delete automanaged storage lifecycle policies.
If the user modifies the SLP, they must make sure that the SLP continues to meet the service level objective as defined by the protection plan.
If the user deletes the SLP, they must make sure that the asset is added to another protection plan that meets the service level objective.
Note:
Activating and suspending an SLP using the nbstlutil command are not audited. These operations are audited only when they are initiated from a NetBackup graphical user interface or API.
- active
Activates processing of the secondary operations that have been suspended within a storage lifecycle policy. Operations that qualify as secondary are duplication, replication, and import from snapshot. Existing images and newly created images are activated. The -lifecycle, -version, -destination, -before, -after, and -backupid options identify the secondary operations.
If neither the -lifecycle option nor the -destination is specified, nbstlutil resumes the processing of all secondary operations for all storage lifecycle policies.
If only a storage lifecycle policy (-lifecycle) is specified, nbstlutil resumes the processing of all secondary operations for that storage lifecycle policy only.
If only a destination is specified, nbstlutil resumes the processing of all secondary operations that use the specified destination for all storage lifecycle policies.
You suspend secondary operations when you run the nbstlutil inactive command.
- cancel
Permanently cancels storage lifecycle policy processing according to how the -lifecycle, -before, -after, and -destination options are used:
If the -lifecycle option and the -destination option are both used, nbstlutil permanently cancels processing for the existing images that the options identify.
If neither of the options is used, nbstlutil permanently cancels all pending copies for all existing images that the storage lifecycle policies manage.
If only a storage lifecycle policy (-lifecycle) is specified, nbstlutil permanently cancels all pending copies of the existing images that it manages.
If only a destination is specified, nbstlutil permanently cancels all pending copies that are bound for that destination, for all storage lifecycle policies.
Any new images that are created after this command are processed normally. If all pending copies of an image are canceled, that image is marked as complete. The destination name is the name of a storage unit or a storage unit group that is used in a storage lifecycle policy.
- diskspaceinfo
Reports on the space that is used by all disk volumes or only the disk volumes that the specified type uses.
- inactive
Suspends processing of secondary operations within a storage lifecycle policy, but retains the image information so that processing can resume later. Secondary operations are duplication, replication, and import from snapshot. Existing images and newly created images are suspended. The -lifecycle, -before, -after, and -destination options identify the secondary operations.
If the -lifecycle option and the -destination option are both used, nbstlutil suspends processing for the existing images that the storage lifecycle policy and destination options identify.
If only a storage lifecycle policy (-lifecycle) is specified, nbstlutil suspends all secondary operations for that storage lifecycle policy.
If only a destination is specified, nbstlutil suspends all secondary operations that use the specified destination for all storage lifecycle policies.
The inactive option uses an accompanying reactivation option that lets you select when the inactive secondary operations can resume processing.
- list
Shows the contents of an image list. It lists images that reference an SLP. You can specify the SLP name to filter the image list. This option is primarily a debugging tool, but support may use the information to troubleshoot problems.
- list_import_conf
Lists the images that have been replicated to a target domain but the corresponding import confirmation message has not been received. By default, only those images waiting for confirmation longer than the configured threshold are listed. If the -all_pending_images option is selected, all waiting images are listed regardless of waiting time.
- pendimplist
Lists all images in the pending import state. These are replication events that are received but not yet imported successfully. Because the image import function does not import images with a backup time in the future, these images remain pending until the backup time has passed.
- redo
Repeats an SLP operation on an image. If a non-NetBackup action loses, damages, or destroys an image copy, redo lets you recreate the copy. If the original source copy is no longer available, the redo fails.
- report
Shows a rollup of incomplete copies of lifecycle managed images.
- repllist
Shows the status for completed replication copies.
- stlilist
Shows the status for all copies of lifecycle managed images.
OPTIONS
- -after mm/dd/yyyy hh:mm:ss
Restricts the SLP secondary operation to only those backups started after the specified date-time.
- -all_pending_images
All waiting images are listed regardless of waiting time.
- -b
Lists only the backup IDs.
- -backupid value
Specifies the backup ID whose images are to be processed.
- -before mm/dd/yyyy hh:mm:ss
Restricts the SLP secondary operation to only those backups started before the specified date-time.
- -client name
Restricts the listing of images for storage lifecycle operations to only those on the client that is specified by name.
- -copy_inactive value
Selects the images for which one or more copies are marked as inactive in the NetBackup database. This option is used primarily for debugging.
- -copy_incomplete value
Selects the images for which one or more copies are not marked as duplication complete in the NetBackup database. This option is used for debugging.
- -copy_state value
Selects the images with the specified copy state in the NetBackup database. This option is used primarily for debugging. Valid values for copy state are as follows:
1 - NOT_STARTED
2 - IN_PROCESS
3 - COMPLETE
9 - NOT_STARTED | INACTIVE
10 - IN_PROCESS | INACTIVE
- -copy_type value
Selects a copy type filter for the list commands (list and stlilist). Valid values are the following:
0 - Backup
1 - Duplication
2 - Snapshot
3 - Duplication to remote master (replica)
4 - Import
- -destination name
Selects the images that are scheduled to be duplicated to the storage unit or storage unit group that is specified by name.
- -duration hours
Sets the amount of time in hours after the lifecycle images are inactivated before reactivation begins. The number of hours must be in whole integers (1,2,...). This option is used only with the inactive option.
- -frag_state value
Selects the images with the specified fragment state in the NetBackup database. This option is used for debugging. Valid values for frag state are as follows:
1 - ACTIVE
2 - TO_BE_DELETED
3 - ELIGIBLE_FOR_EXPIRATION
- -image_inactive value
Selects the images that are marked as inactive in the NetBackup database. This option is used for debugging.
- -image_incomplete value
Selects the images that are not marked as lifecycle complete in the NetBackup database. This option is used for debugging.
- -image_state value
Selects the images with the specified image state in the NetBackup database. This option is used primarily for debugging. The valid values for image state are as follows:
1 - NOT_STARTED
2 - IN_PROCESS
3 - COMPLETE
9 - NOT_STARTED | INACTIVE
10 - IN_PROCESS | INACTIVE
- -jobid value
Restricts the output listing of images for storage lifecycle operations to only those that the specified job ID value has created. -jobid can be used only with the list option.
- -json
Produces output in expanded readable json format.
- -json_compact
Produces output in compressed json format.
- -l
Produces a condensed parsable output of the listing.
- -lifecycle name
Selects only lifecycle managed image list.
- -mediaid value
Restricts the listing of images for storage lifecycle operations to only those on the media ID that value specifies.
- -mediaserver name
Restricts the listing of images for storage lifecycle operations to only those on the media that name specifies.
- -nowarn
Skips the interactive warning message.
- -policy name
Restricts the processing of images to those that the specified backup policy (name) has created. -policy can be used only with the list option.
- -reactivation_time mm/dd/yyyy hh:mm:ss
Sets the time in mm/dd/yyyy hh:mm:ss format when you want the copies or SLPs that you are inactivating to be reactivated. The inactive option can use this option or the -duration option to reactivate inactivated copies or SLPs.
- -rt I | IC | ICF | ICFS
Selects the record types to be listed. The possible values are:
I - list only image records.
IC - list image and copy records.
ICF - list image, copy, and fragment records.
ICFS - list image, copy, fragment, and snapshot records.
- -sincetime timeval
Shows the status of completed replication copies from the specified timeval to the present. This option is used with the repllist function.
- -slpindex value
Specifies the SLP operation to be repeated. -slpindex can be used only with the redo operation.
- -storageserver name
Restricts the listing of images for storage lifecycle operations to only those on the storage server that name specifies.
- -stype server_type
Specifies a string that identifies the storage server type. The server_type value can originate from one of the following sources:
Veritas provided storage. Possible values are AdvancedDisk and PureDisk.
Third-party disk appliances. The vendor supplies the server_type string.
Cloud storage. Use the csconfig cldprovider -l command to determine the possible stype values. The cloud stype values reflect the cloud storage provider. Cloud storage stype values can also incorporate a suffix (for example,
amazon_crypt). Possible suffixes are:_raw: The NetBackup backup image is sent to the cloud in raw format. Use this option if you do not want to compress or encrypt data before sending to cloud storage.
_rawc: Compresses the data before it is written to the cloud storage.
_crypt: Encrypt the data using AES-256 encryption before writing the data to cloud storage. You must have KMS configured in NetBackup to use this option._cryptc: Compress and encrypt the data before writing to cloud storage.
The storage server type is case sensitive.
- -target_domain name
Selects for output only those records that pertain to the named target domain.
- -U
Produces user-readable output of the listing.
- -version number
Restricts the list output to only images that are controlled by the specified SLP version. It must be used with the -lifecycle option.
EXAMPLES
Example 1 - Displays the information about a lifecycle in-process image.
# nbstlutil -list -backupid dollhouse_1287744229 -U
Image:
Master Server : dollhouse
Backup ID : dollhouse_1287744229
Client : dollhouse
Backup Time : 1287744229 (Fri Aug 24 16:13:49 2012)
Policy : pol-slp-2bkup-70-level
Client Type : 13
Schedule Type : 0
Storage Lifecycle Policy : slp-pol-2backup-70-level
Storage Lifecycle State : 2 (IN-PROCESS)
Time In Process : 1287744327 (Fri Aug 24 16:15:27 2012)
Data Classification ID : 85AA96DF9781453289A41745DD240A48 (Platinum)
Version Number : 0
OriginMasterServer : (none specified)
OriginMasterServerID : 00000000-0000-0000-0000-000000000000
Import From Replica Time : 0 (Thu Jan 01 05:30:00 1970)
Required Expiration Date : 0 (Thu Jan 01 05:30:00 1970)
Created Date Time : 1287744297 (Fri Aug 24 16:14:57 2012)
Copy:
Master Server : dollhouse
Backup ID : dollhouse_1287744229
Copy Number : 1
Copy Type : 0
Expire Time : 1288953829 (Fri Nov 02 16:13:49 2012)
Expire LC Time : 1288953829 (Fri Nov 02 16:13:49 2012)
Try To Keep Time : 1288953829 (Fri Nov 02 16:13:49 2012)
Residence : PDDE-Stu
Copy State : 2 (IN-PROCESS)
Job ID : 0
Retention Type : 0 (FIXED)
MPX State : 0 (FALSE)
Source : 0
Destination ID : *NONE*
Last Retry Time : 0
Fragment:
Master Server : dollhouse
Backup ID : dollhouse_1287744229
Copy Number : 1
Fragment Number : 1
Resume Count : 0
Media ID : @aaaad
Media Server : dollhouse
Storage Server : (none specified)
Media Type : 0 (DISK)
Media Sub-Type : 6 (STSDYNAMIC)
Fragment State : 1 (ACTIVE)
Fragment Size : 5120
Delete Header : 1
Fragment ID : @aaaad
The output displays "(none specified)" for blank fields.
Example 2 - Display the contents of an image list in condensed parsable format.
# nbstlutil list -l V7.0 I abc.example.com abc_1225727 abc 1225727 Pol_SLPTest1 0 0 SLP_Test1 2 \ 1225727 *NULL* V7.0 C abc.example.com abc_1225727 1 2147483 1225735 AdvDisk1 3 0 0 0 0 V7.0 F abc.example.com abc_1225727 1 1 0 @ab abc.example.com *NULL* 0 6 1 \ 32768 1 @ab V7.0 C abc.example.com abc_1225727 2 2147483 1225735 AdvDisk2 3 0 0 0 0
Example 3 - Display the information for an incomplete lifecycle image in user-readable output.
# nbstlutil stlilist -U Image abc_1225727928 for Lifecycle SLP_Test1 is IN_PROCESS Copy to abc-tape1 is IN_PROCESS Copy to AdvDisk3 is NOT_STARTED