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
- bpcleanrestore
- 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
- configureMQ
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- mklogdir
- msdpcldutil
- nbauditreport
- nbcallhomeproxyconfig
- 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
- nbfp
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbmlb
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- netbackup_deployment_insights
- 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
Name
tpclean — manage the cleaning of the tape drive
SYNOPSIS
-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 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.