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

nbstlutil — run the NetBackup storage lifecycle policies utility

SYNOPSIS

nbstlutil active [-lifecycle name] [-destination name] [-before mm/dd/yyyy hh:mm:ss | -after mm/dd/yyyy hh:mm:ss]

nbstlutil 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]

nbstlutil 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]

nbstlutil list_import_conf [-l|-U|-b|-json| -json_compact] [-lifecycle name] [-all_pending_images] [destination name] [-target_domain name]

nbstlutil cancel [-lifecycle name | -destination name] [-version number] [-before mm/dd/yyyy hh:mm:ss | -after mm/dd/yyyy hh:mm:ss] [-nowarn]

nbstlutil active | inactive | cancel -backupid id_value

nbstlutil diskspaceinfo [-stype server_type]

nbstlutil 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]

nbstlutil pendimplist

nbstlutil redo -backupid value -slpindex value

nbstlutil repllist [-l] [-U] [-sincetime timeval]

nbstlutil report [-lifecycle name [-version number]] [-client name] [-mediaid value] [-mediaserver name] [-storageserver name]

nbstlutil 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