Veritas NetBackup™ Commands Reference Guide

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

Name

tpclean — manage the cleaning of the tape drive

SYNOPSIS

tpclean -L | -C drive_name [-priority number] | -M drive_name | -F drive_name cleaning_frequency

On UNIX systems, the directory path to this command is /usr/openv/volmgr/bin/

On Windows systems, the directory path to this command is install_path\Volmgr\bin\

DESCRIPTION

tpclean enables you to monitor Media Manager tape drive usage and optionally configure tape drives to be cleaned automatically. (This function does not apply to drives in ACS or TLH robots, or QIC drives.)

Media Manager tracks the total amount of time that volumes have been mounted in the drives. You can use tpclean to specify a cleaning frequency (in hours) for a drive.

The drive is cleaned if the following conditions are true:

  • The mount time exceeds the cleaning frequency.

  • A TapeAlert "CLEAN NOW" or "CLEAN PERIODIC" flag has been raised.

  • The drive is in a robot.

  • The Media Manager volume configuration shows a cleaning tape in the robot.

The Comment field in the tpclean -L output contains the message, NEEDS CLEANING, if the following are true:

  • The mount time exceeds the cleaning frequency.

  • The drive is a standalone drive or does not have a defined cleaning tape.

Manually clean the drive and reset the mount time by using the -M option.

For the -C, -M, and -F options to operate, the following must occur: ltid must be running on UNIX systems, or the NetBackup Device Manager service must be running on Windows systems.

For more about TapeAlert and other drive-cleaning topics, see the NetBackup Administrator's Guide, Volume II.

In a NetBackup Enterprise Server, a frequency-based cleaning is not supported for shared drives.

You must have administrator privileges to run this command.

OPTIONS

-C drive_name

Initiates the cleaning of a drive in a robot. The drive must be defined in a robot and a defined cleaning tape in the Media Manager volume configuration. The mount time is reset to zero. The drive name is the name that was assigned to the drive when it was added to the configuration.

-L

Prints the cleaning statistics. (On UNIX systems, it prints to stdout.)

-priority number

Specifies a new priority for the job at which tpclean gets a media-drive pair of resources. The new priority overrides the default job priority.

-M drive_name

Indicates that the drive was manually cleaned. The mount time is reset to zero. The drive name is the name that was assigned to the drive when it was added to the device configuration.

-F drive_name cleaning_frequency

Sets the cleaning frequency for the specified drive to cleaning_frequency hours. The drive name is the name that was assigned to the drive when it was added. The value of cleaning_frequency must be between zero (0) hours and 10,000 hours.

NOTES

tpconfig -d, tpconfig -l, and vmoprcmd may truncate long drive names. Use tpconfig -dl to obtain the full drive name.

tpclean truncates drive names to 22 characters.

EXAMPLES

Example 1 - Display cleaning statistics. An asterisk next to the drive type indicates that the device is defined as robotic.

# tpclean -L
Drive Name   Type   Mount Time  Frequency   Last Cleaned   Comment
**********   ****   **********  **********  ************   *******
rob_A_drv1   8mm*      11.4        30       14:33 05/29/92
4mm_drv5     4mm        5.6        10       13:01 06/02/92
dlt_drv6     dlt        3.0         0           N/A

Example 2 - Set the cleaning frequency for the drive named dlt_drv6 to 25 hours. The drive is flagged as having a need to be cleaned after 25 hours of mount time has occurred.

# tpclean -F dlt_drv6 25

Example 3 - Reset the mount time for the drive named rob_A_drv1 to zero. You normally use this command after you manually clean the drive.

# tpclean -M rob_A_drv1

Example 4 - Initiate the cleaning of drive rob_A_drv1. This example assumes that the drive is a robotic drive with a cleaning tape defined. The mount time is reset to zero.

You can use the -C option to force the cleaning of a drive before you reach cleaning_frequency. Normally, robotic drives are cleaned automatically when their mount time exceeds the cleaning frequency.

# tpclean -C rob_A_drv1

Note:

To use a cleaning tape, the Cleanings Remaining for that tape must be greater than zero. (This value appears in the volume list of the Media node in the NetBackup Administration Console or from the vmquery command.) This cleaning count refers to how many more times the cleaning tape can be used. You can change this count by using the Media node or the vmchange command.

SEE ALSO

See ltid.

See tpconfig.