Rational ClearCase Commands Referenceannotate
apropos
catcr
catcs
cc.icon
cc.magic
cd
chactivity
chbl
checkin
checkout
checkvob
chevent
chflevel
chfolder
chmaster
chpool
chproject
chstream
chtype
chview
clearaudit
clearbug
cleardescribe
cleardiffbl
cleardiff
clearexport_ccase
clearexport_cvs
clearexport_pvcs
clearexport_rcs
clearexport_sccs
clearexport_ssafe
clearfsimport
cleargetlog
clearhistory
clearimport
clearjoinproj
clearlicense
clearmake
clearmake.options
clearmrgman
clearprojexp
clearprompt
cleartool
clearviewupdate
clearvobadmin
comments
config_ccase
config_spec
cptype
credmap
creds
deliver
describe
diffbl
diffcr
diff
dospace
edcs
endview
env_ccase
events_ccase
export_mvfs
exports_ccase
file
find
findmerge
fmt_ccase
getcache
get
getlog
help
hostinfo
init_ccase
ln
lock
lsactivity
lsbl
lscheckout
lsclients
lscomp
lsdo
lsfolder
lshistory
ls
lslock
lsmaster
lspool
lsprivate
lsproject
lsregion
lsreplica
lssite
lsstgloc
lsstream
lstype
lsview
lsvob
lsvtree
makefile_aix
makefile_ccase
makefile_gnu
makefile_pmake
makefile_smake
makefile_sun
man
merge
mkactivity
mkattr
mkattype
mkbl
mkbranch
mkbrtype
mkcomp
mkdir
mkelem
mkeltype
mkfolder
mkhlink
mkhltype
mklabel
mklbtype
mkpool
mkproject
mkregion
mkstgloc
mkstream
mktag
mktrigger
mktrtype
mkview
mkvob
mount_ccase
mount
msdostext_mode
mvfslog
mvfsstorage
mvfstime
mvfsversion
mv
omake
pathnames_ccase
permissions
profile_ccase
promote_server
protect
protectvob
pwd
pwv
query_language
quit
rebase
recoverview
reformatview
reformatvob
register
relocate
rename
reqmaster
reserve
rgy_backup
rgy_check
rgy_passwd
rgy_switchover
rmactivity
rmattr
rmbl
rmbranch
rmcomp
rmdo
rmelem
rmfolder
rmhlink
rmlabel
rmmerge
rmname
rmpool
rmproject
rmregion
rmstgloc
rmstream
rmtag
rmtrigger
rmtype
rmver
rmview
rmvob
schedule
schemes
scrubber
setactivity
setcache
setcs
setplevel
setsite
setview
shell
snapshot.conf
softbench_ccase
space
startview
type_manager
umount
uncheckout
unlock
unregister
unreserve
update
version_selector
view_scrubber
vob_restore
vob_scrubber
vob_sidwalk
vob_snapshot
vob_snapshot_setup
wildcards_ccase
winkin
xclearcase
xcleardiff
xmldiffmrg
SYNOPSIS
DESCRIPTION
Use vob_snapshot_setup to control VOB database snapshot activity on each VOB host. By default, the scheduler runs vob_snapshot periodically. When vob_snapshot runs on a VOB host, it checks each locally stored VOB for the existence of a multipart string attribute that specifies snapshot parameters. A VOB's database is copied by vob_snapshot only if this attribute has been applied to the VOB with vob_snapshot_setup. Use vob_snapshot_setup lsvob to list the local VOBs currently processed by vob_snapshot and, with –long, to display the snapshot parameters for each VOB in the list.
Use vob_snapshot_setup modparam to add a VOB to the database snapshot list, or to change snapshot parameters for a VOB already on the list. (You cannot modify individual parameters with modparam, but must replace them all.)
Use vob_snapshot_setup rmparam to remove a VOB from the snapshot list.
See also vob_snapshot and vob_restore.
Warning: Do not run vob_snapshot_setup on a V2.x VOB, until you have reformatted the VOB for V3 with reformatvob, and you are certain that checkvob –setup has completed successfully. checkvob –setup updates storage container names and verifies the presence of V3 type managers. If either operation fails, checkvob cannot synchronize a database snapshot at vob_restore time. If you are using a homegrown or third-party type manager, code that implements the get_cont_info method must be added to the type manager so that elements managed by the type manager can be processed by checkvob at vob_restore time.
Setting VOB Snapshot Parameters
An administrator uses vob_snapshot_setup modparam to apply the following snapshot parameters to each VOB or replica for which database snapshots are to be taken:
| Parameter | Valid Values | Default Value |
|---|---|---|
| –snap_to | Existing, writable directory pathname | No default |
| –dbcheck | yes | no | No |
| –notify (UNIX only) | Comma-separated list | Empty list |
These parameters are combined to form a single string attribute of type vob_snapshot_parameters, which vob_snapshot_setup attaches to the VOB.
Here is how these parameters may appear in a vob_snapshot_setup lsvob –long listing:
VobTag: /vobs/src
...
Dbcheck Enabled: yes
Notification List: root user,clearadm,anne
Snap To: /net/saturn/usr1/snapshots
...
For more information, see the –snap_to, –dbcheck, and –notify options.
Disk Space Used
The VOB snapshot backup/restore scenario requires additional disk space, both at restore time and during daily operation:
- At restore time, checkvob may require substantial disk space. See the checkvob reference page.
- Enabling VOB snapshots for a VOB also enables a deferred source container deletion mechanism, which typically increases source pool size. For a description of deferred deletion, see the Administrator's Guide.
RESTRICTIONS
OPTIONS AND ARGUMENTS
VOB Listing Report Format
- Default
- vob_snapshot_setup lsvob lists
the VOB tag of each local VOB currently configured for database snapshot.
- –short
- Same as default.
- –long
- In addition to the VOB tag, vob_snapshot_setup
lsvob lists each VOB's snapshot parameters and additional VOB identity
details. If multiple VOBs use the same parent –snap_to directory,
use the replica UUID returned by –long to find a particular
snapshot in the parent directory.
- vob-tag ...
- Space-separated list of VOBs; restricts
listing to one or more local VOBs.
Specifying the VOB
Setting Snapshot Parameters
- Default
- With modparam,
you must specify a VOB tag; if you specify no other options or arguments, modparam prompts
for all necessary input and displays explanatory text. If you specify both
a VOB tag and a snapshot target directory, modparam does
not prompt for additional parameters: vob_snapshot does
not run the db_check operation, and the notify list is
empty.
- –snap_to snap-dir-pname
- A disk location to store the snapshot. vob_snapshot appends the VOB's replica UUID to the –snap_to directory
to create a subdirectory, then copies the VOB database to the subdirectory
(after checking for sufficient disk space).
The replica UUID subdirectory that stores a VOB's database snapshot is overwritten the next time vob_snapshot processes that VOB.
Typically, the –snap_to directory gets backed up as part of normal backup operations some time after the snapshots are taken.
- –dbcheck yes, –dbcheck no
- Specifies whether to run the db_check utility
on each snapshot.
vob_snapshot runs db_check to perform fundamental database consistency and integrity checks. (Later, at restore time, checkvob may examine the VOB database looking for ClearCase and ClearCase LT anomalies.) The db_check pass occurs after all snapshots are completed on the local host. Because this check can be time-consuming, it is disabled by default.
If vob_snapshot cannot lock the database and db_check is disabled, db_check runs on the snapshot at vob_restore time. Running db_check earlier, at snapshot time, may expose problems that you would prefer not to encounter at recover time.
- –notify login-name[,...]
- A list of user IDs to be notified
when vob_snapshot processes this VOB or replica. This VOB-specific
list supplements the per host notification list maintained in /var/adm/rational/clearcase/config/snapshot.conf.
The snapshot.conf file also specifies the notification
program to be used. If you do not want to supply a list of user IDs to be
notified, specify –notify "''" on the command line.
EXAMPLES
Note: In the UNIX examples that follow, arguments and output that show multicomponent VOB tags are not applicable to ClearCase LT, which recognizes only single-component VOB tags. In this manual, a multicomponent VOB tag is by convention a two-component VOB tag of the form /vobs/vob-tag-leaf—for example, /vobs/src. A single-component VOB tag consists of a leaf only—for example, /src. In all other respects, the examples are valid for ClearCase LT.
- List all VOBs on the local host that are currently configured for processing by vob_snapshot.
- Same
as previous example, but expand the output to include each VOB's replica UUID
and snapshot parameters.
cd c:\Program Files\Rational\ClearCase\etc
vob_snapshot_setup lsvob –long
VobTag: \vob_src
Replica Name: original
Replica Uuid: 4a6bbe5d88d511cfa9b400018073db6f
Family Uuid: 4a6bbe5988d511cfa9b400018073db6f
Dbcheck Enabled: yes
Snap To: \\saturn\bigdisk\snapshot
Deferred Deletes: EnabledVobTag: \vob_lib
Replica Name: original
Replica Uuid: 5fec90f48db911cfab9800018073db6f
Family Uuid: 5fec90f08db911cfab9800018073db6f
Dbcheck Enabled: no
Snap To: \\saturn\bigdisk\snapshot
Deferred Deletes: Enabled - Add VOB \vob_src to the local host's snapshot list.
- Add /vobs/src to
the local host's snapshot list, as in the previous example, but this time
run vob_snapshot_setup modparam in interactive mode.
vob_snapshot_setup modparam /vob/src
Supply a directory to contain the snapshot data for this vob.
The directory must exist and be writable.
(Full pathname: there is no default) /net/saturn/usr1/snaps/src
Supply a comma separated list of those users to be notified of
events during the snapshot of this vob.
(Comma separated user id list: default no one): root,clearadm,anne
Do you want a data base check to be performed on this vob after
all snapshot operations on this host are completed?
Valid responses are (yes,no)
The default is no: yes - Remove VOB \vob_src from the local host's snapshot list.