Rational ClearCase Commands Reference: rgy

Commands Index:

  * intro
  annotate
  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

rgy_check

Check registry files for inconsistencies

APPLICABILITY

Product	Command type
ClearCase	command
ClearCase LT	command

Platform
UNIX
Windows

SYNOPSIS

ClearCase:
rgy_check { –vie·ws | –vob·s } ... [ –reg·ion region ] [ –sto·rage ]
ClearCase LT:
rgy_check { –vie·ws | –vob·s } ... [ –hst·orage ]

DESCRIPTION

The rgy_check command examines the contents of ClearCase or ClearCase LT VOB and/or view registries, and reports any errors or inconsistencies.

Registry problems have various causes:

Editing registry entries with editors such as emacs or Notepad.
Improper administration procedures; for example, removing a VOB with an operating system command rather than with rmvob
Faulty upgrade procedures; for example, migrating a VOB to a new release that introduces a database schema change without reformatting the VOB (using reformatvob)
Defects in older releases of ClearCase or ClearCase LT

If rgy_check finds errors or inconsistencies, it displays a line like the following at the end of its output:

Error: 21 total registry errors/inconsistencies detected.

For each problematic registry entry, rgy_check displays the registry entry and a warning or error message.

General Problems

rgy_check reports the following general problems:

Duplicate entries in the registry
Malformed entries in the registry

Registration Anomalies

rgy_check reports the following VOB or view registration anomalies:

Objects with no UUID
Two objects with same UUID
Objects with no host name
Objects with no local (server) pathname
Two objects pointing to same host-local-path
Tags with no UUIDs
Tags with UUIDs that do not match any object (stranded tag)
Tag registry entries with no tag

Region-Related Problems

Region-related problems are more likely to occur ClearCase than in ClearCase LT because ClearCase installations are not restricted to a single region. However, in either case, rgy_check may report these problems:

Objects with no associated tags in any region (stranded object)
Tags in regions that are not in the region registry
Tags with no global pathname
Two tags in one region pointing to same object UUID
Duplicate tags in the same region
Tags in one region with duplicate global pathnames

Storage-Related Problems

In ClearCase, if you specify the –storage option, rgy_check also reports these problems:

View tags that point to global paths with missing or incorrect .view files:
- Missing .view file (usually a missing view)
- .view file with invalid contents
- .view file that contains an incorrect view UUID (that is, the UUID points to wrong view)
VOB tags that point to global paths with missing or incorrect replica_uuid files:
- Missing replica_uuid file (usually a missing VOB)
- replica_uuid file with invalid contents
- replica_uuid file with an incorrect UUID (that is, the UUID points to wrong VOB)

In ClearCase LT, if you specify the –storage option, rgy_check reports the same kinds of problems that ClearCase reports when you use –storage, except that view and VOB objects (rather than tags) are checked.

RESTRICTIONS

None.

OPTIONS AND ARGUMENTS

Specifying the Kind of Registry Entries to Display

Default: None.
–vie·ws: Checks the contents of the view tag and/or view object registries.
–vob·s: Checks the contents of the VOB tag and/or VOB object registries.

Specifying the Region

Default: All regions.
–reg·ion region: Specifies the network region for which registry entries are to be checked.

Checking Storage

Default: None.
–sto·rage: Checks for the existence of registered VOB and/or view storage directories. Given a storage directory's existence, rgy_check looks for basic storage configuration problems as well. Typically, registered storage pathnames for multiple network regions are not accessible from a single host. It is common practice to use –region to confine storage checks to the current host's network region.
–hst·orage: Checks for the existence of registered VOB and/or view storage directories on the ClearCase LT server host. Given a storage directory's existence, rgy_check looks for basic storage configuration problems as well. You must run rgy_check at the ClearCase LT server host when you use this option.

EXAMPLES

Check the VOB registry for errors and anomalies.
rgy_check -vobs
No registry errors/inconsistencies detected.
Check VOB and view registries in the devel region (which includes the local host). Include storage directory checks. In this example, rgy_check finds a tutorial VOB from which the user has removed the VOB's replica_uuid information.
rgy_check -vobs -views -region devel -storage
rgy_check: Error: The VOB storage at \\io\alh\ccasetut\tut.vbs has no replica_uuid file. This tag: -tag = "\alh_IO_hw" -global_path = "\\io\alh\ccasetut\tut.vbs" -hostname = "io" -mount_access = "private" -mount_options = "" -region = "devel" -vob_replica = "7d7031db.6dfb11cf.a398.00:80:c8:81:fa:e0" rgy_check: Error: 1 total registry errors/inconsistencies detected.

Rational ClearCase Commands Reference