checkvob

Finds and fixes inconsistencies between VOB database and storage pools, problems with hyperlinks, and problems with global types

APPLICABILITY

ClearCase (cleartool subcommand [administrative])

SYNOPSIS

• Check/fix storage pools

  checkvob [ -vie·w view-tag ] [ -log log-dir-pname ] [ -fix [ -f·orce ] [ -ign·ore ] ]

  
  

  [ -dat·a ] [ -pro·tections ] [ -deb·ris ] [ -set·up ]
  { -poo·l [ -sou·rce ] [ -der·ived ] [ -cle·artext ] { vob-stg-pname | pname-in-vob }
  | [ -loc·k ] file-pname ...
  }

• Check/fix hyperlinks

  checkvob -hli·nks [ -to | -fro·m ] [ -hlt·ype hltype-selector ]

  
  

  [ -f·orce ] [ -pna·me ] object-selector ...

• Check/fix global types

  checkvob -glo·bal [ -log log-pname ] [ -fix [ -f·orce ] ]

  
  

  [ -acq·uire ] [ -pro·tections ] [ -loc·k | -unl·ock ]
  { vob-selector | global-type-selector }

DESCRIPTION

checkvob can find and fix problems with storage pools, with hyperlinks, and with global types in an admin VOB hierarchy. For more information, see Administering ClearCase.

PERMISSIONS AND LOCKS

Permissions Checking: To use -fix, you must be the VOB owner or a member of the ClearCase group. To use -hlink, you must be object group member, object owner, VOB owner, or a member of the ClearCase group. See the permissions reference page.

Locks: Without -fix (check-only mode), checkvob processing is not affected by locks, and it does not lock any objects. With -fix, checkvob processing is affected as follows:

• The VOB must be unlocked (or locked with lock -nusers user-running-checkvob).
• Problems cannot be fixed if the affected element or pool is locked. Use -ignore to modify this behavior.
• It may be difficult to fix ownership and naming problems with global types if local copies or eclipsing ordinary types are locked.

OPTIONS AND ARGUMENTS

The following sections describe the options and arguments for storage pool mode, hyperlink mode, and global types mode. For more details on fix-mode processing, see Administering ClearCase.

Storage Pool Mode

SPECIFYING A VIEW.   Default: Uses the current view context. If you attempt to run checkvob without a view context, you are prompted to continue. Without a view context, checkvob cannot generate VOB pathnames in problem object reports, so it reports OIDs instead of pathnames. In general, run checkvob from a view.

-vie·w view-tag

Uses view view-tag to resolve any file-pname arguments, and to construct VOB object pathnames in output. This option exists primarily to permit checkvob to run on VOB servers where the MVFS is not installed (hosts where you cannot establish a working view context).

LOG FILE DIRECTORY.   Default: checkvob creates in the current directory a log file directory named checkvob.date-time. With -pool, several log files are created, including a summary file and one file per pool analyzed. Otherwise, a single transcript file stores a report on each individual file examined.

-log log-dir-pname

Specifies an alternative directory for the log file directory. If log-dir-pname already exists, checkvob returns an error.

FIX MODE.   Default: Reports any problems, but does not try to fix them.

WARNING: Fixing problems detected with -data can update the VOB irreversibly. If source or DO data containers are missing from the storage pools when checkvob runs, it updates the VOB database, dereferencing these containers with the equivalents of rmver -data (for missing source containers) and rmdo (for missing DO containers).

-fix

Directs checkvob to try to correct any problems it finds. Without -force, -fix prompts you before fixing any problem object. You must run checkvob from the VOB server host to use -fix.

For details on how checkvob tries to fix the various problems it detects, see Administering ClearCase.

-f·orce

Minimizes interactive prompts when checkvob runs with -fix.

-ign·ore

Ignores element and pool locks during fix processing. Use of -ignore requires that the VOB be locked for all users except the user running checkvob (lock -nusers). This option is not recommended for general use. It exists primarily to support automatic checkvob invocations when vob_restore is run.

DATABASE/POOL INCONSISTENCIES.   Default: Scans pools or individual file containers looking for all detectable problems.

-dat·a

Identifies missing data containers. checkvob scans the VOB database and source pools to confirm the existence of each data container known to the database.

NOTE: During check processing, a "healthy" element is one whose containers have the right names, in the right locations, with the right permissions. checkvob does not detect container data corruption.

-pro·tections

Identifies access control problems on data containers.

-deb·ris

Scans storage pools for data containers not referenced by the VOB database. -debris is meaningful only when used with -pool. In general, checkvob -fix -debris moves debris to the applicable pool's lost_found directory. See Administering ClearCase for details.

SETUP MODE.   Default: None. Specify -setup to run checkvob in setup mode.

-set·up

Prepares newly reformatted VOB for checkvob processing.
Prepares a VOB for vob_snapshot/vob_restore/checkvob processing. See Administering ClearCase.

POOL MODE.   Default: None. Specify -pool and a vob-stg-pname argument in order to process one or more storage pools. If you do not use -pool, see the Individual File Mode options .

-poo·l

Runs checkvob in pool mode. See Administering ClearCase.

-sou·rce

-der·ived

-cle·artext

Processes the VOB's source, derived object (DO), and/or cleartext pools. If you omit all of these options, checkvob processes all pool kinds.

vob-stg-pname

pname-in-vob

Identifies the VOB; required with -pool.

INDIVIDUAL FILE MODE.  Default: None. If you do not use the -pool option, you must specify one or more file-pname arguments.

-loc·k

Locks each element during check processing. checkvob always locks an element during fix processing.

file-pname ...

Specifies one or more VOB objects having associated data containers-file elements, versions, or DOs. checkvob compares each data container's location and permissions against what is expected by the VOB database.

Hyperlink Mode

HYPERLINK MODE.   Default: None. Use -hlinks to run checkvob in hyperlink mode. checkvob prompts for confirmation before deleting each partially unavailable hyperlink it detects.

-hli·nks

Runs checkvob in hyperlink mode.

-to

-fro·m

Checks only hyperlinks to or from the specified objects.

-hlt·ype hyperlink-type-selector

Checks only hyperlinks of type hyperlink-type-selector. Specify hyperlink-type-selector in the form hltype:type-name[@vob-selector]

-f·orce

Deletes broken hyperlinks without prompting for confirmation.

-pna·me

Interprets each object-selector argument as a pathname.

object-selector ...

Specifies the objects whose broken hyperlinks are to be found and deleted. Note that if you specify a VOB, checkvob does not check all hyperlinks in that VOB; it checks only the hyperlinks attached to the VOB object itself. Specify object-selector in one of the following forms:

Global Types Mode

GLOBAL TYPES MODE. Default: None. You must specify -global.

-global

Runs checkvob in global types mode.

LOG FILE.   Default: checkvob creates in the current directory a file named checkvob.date.time.

-log log-pname

Specifies an alternative pathname for the log file. If log-pname already exists, checkvob returns an error.

FIX MODE.   Default: Reports any problems, but does not try to fix them.

-fix

Directs checkvob to try to correct any problems it finds. Without -force, -fix prompts you before fixing any problem object.

For details on how checkvob tries to fix the various problems it detects, see Administering ClearCase.

-f·orce

Minimizes interactive prompts when checkvob runs with -fix.

-acquire

Lists/fixes eclipsing local copies and eclipsing ordinary types

-protections

Lists/fixes mismatched protections between global types and their local copies.

-lock

-unlock

Lists/fixes eclipsing local locks. In fix mode, -lock locks the global type and -unlock removes the lock entirely.

vob-selector

Specifies a VOB in an admin VOB hierarchy. checkvob checks/fixes all global types found in the hierarchy. Specify vob-selector in the form vob:pname-in-vob

pname-in-vob can be the pathname of the VOB-tag (whether or not the VOB is mounted) or of any filesystem object within the VOB (if the VOB is mounted). It cannot be the pathname of the VOB storage directory.

global-type-selector

Specifies a global type to be checked for problems. Specify global-type-selector in one of the following forms:

EXAMPLES

Examples including wildcards or quoting are written for use in cleartool interactive mode. If you use cleartool single-command mode, you may need to change the wildcards and quoting to make your command interpreter process the command appropriately.

In cleartool single-command mode, cmd-context represents the command interpreter prompt. In cleartool interactive mode, cmd-context represents the interactive cleartool prompt. In Attache, cmd-context represents the workspace prompt.

• Check a single element's data container.

cmd-context checkvob \vob_lib\gui.c

The session's log directory is 'checkvob.11-Apr-98.05.21.17'.

=================================================================
Processing element "\vob_lib\gui.c@@".
Checking status of 1 referenced containers in pool "s\sdft"...
Initial container status: 0 missing, 0 misprotected.
=================================================================

• Perform a routine check on a small, healthy VOB's source pools.

cmd-context lsvob \vob_lib2

* \vob_lib2    \\saturn\vobstore\vob_lib2.vbs

cmd-context checkvob -pool -source \\saturn\vobstore\vob_lib2.vbs

=================================================================
Starting "source pool" processing at 10-Apr-98.06:35:11

Running from host: saturn
VOB hostname: saturn
VOB host storage pathname: C:\vobstore\lib2.vbs
VOB global storage pathname: \\saturn\vobstore\lib2.vbs
VOB replica oid: 0cdc7b37.f48611cc.b3d5.00:01:80:02:bc:53
VOB host reference time: 10-Apr-98.06:29:59
Processing pools: sdft
Processing of misprotected containers is: ENABLED
Processing of ndata containers is: ENABLED
Processing of unreferenced containers is: ENABLED
Fix processing mode: DISABLED

Poolkind transcript log: checkvob.20-Apr-98.12.10.40\poolkind_source\transcript
=================================================================
... progress messages ...
=================================================================
Completed "source pool" processing at 10-Apr-98.06:35:37

"source pool" Processing Summary:
Referenced Container Check Processing Time: 00:00:20
*** Referenced Container Fix Processing was not performed.
Unreferenced Container Check Processing Time: 00:00:05
*** Unreferenced Container Fix Processing was not performed.

Installed type managers are OK.

Pool root storage areas are OK.

Pool: s\sdft
Referenced container check processing:
229 containers checked
0 ndata 0 misprotected
22 objects checked
0 ndata 0 misprotected
Unreferenced container check processing:
229 containers checked (47778 kbytes)
0 unreferenced but under age (0 kbytes)
0 unreferenced but maybe needed (0 kbytes)
0 unreferenced containers (0 kbytes, 0 empty)


The VOBs source pools are healthy.

Poolkind transcript log: checkvob.20-Apr-98.12.10.40\poolkind_source\transcript
=================================================================

• Check all global types in the admin VOB hierarchy containing the VOB \dev.

cmd-context checkvob -global vob:\dev

The session's log file is "checkvob.30-Jul-99.17:28:55".
Starting analysis of Admin VOB hierarchy.


Analysis of Admin VOB hierarchy complete.
5 VOBs analyzed, no hierarchy errors found.

Starting "global type" processing.

Detection of eclipsing local copies is: ENABLED
Detection of protection mis-matches is: ENABLED
Detection of eclipsing local locks is: ENABLED
Correction of detected errors is: DISABLED

Completed "global type" processing.
Processed 8 global types in 5 VOBs.

FILES

current-dir\checkvob.date-time  (default log-pname for -global)
current-dir\checkvob.date-time\  (default log-dir)
log-dir\.summary
log-dir\poolkind_cleartext\transcript
log-dir\poolkind_derived\transcript
log-dir\poolkind_source\transcript
log-dir\summary
vob-storage-dir\vob_server.conf
vob-storage-dir\s\sdft\pool_id
vob-storage-dir\c\cdft\pool_id
vob-storage-dir\d\ddft\pool_id

SEE ALSO

reformatvob, rmdo, rmver, type_manager, vob, vob_restore, vob_snapshot