lsvob

Lists VOB registry entries

Applicability

Product

Command type

VersionVault

cleartool subcommand

VersionVault Remote Client

rcleartool subcommand

Platform

UNIX

Linux

Windows

Synopsis

  • VersionVault:
    lsvob [ -g/raphical ] [ -s/hort | -l/ong ] [ -hos/t hostname [ -quick ]]
    [ -reg/ion network-region ]

    [ vob-tag ... | -sto/rage vob-storage-dir-pname ...

    | -uui/d replica-uuid | -fam/ily vob-family-uuid ]

  • VersionVault Remote Client-list VOBs:
    lsvob [ -s/hort | -l/ong ] [ -hos/t hostname [ vob-tag ... ]
  • VersionVault Remote Client-list mounted VOBs:
    lsvob -mount/ed [ -vie/w view-tag ]

Description

The lsvob command lists one or more VOBs. To be accessible to cleartool and rcleartool subcommands, including lsvob, a VOB must be registered. That is, it must have an entry in the vob_object file on the registry server host. In addition, each VOB typically has one or more entries in the vob_tag registry file; you cannot mount, or even create, a VOB without assigning a tag to it. See the mkvob reference page. For more information about registry files, see the Help.

Default output

By default, the commands cleartool lsvob and rcleartool lsvob list all VOBs that are registered in the current network region, whether or not they are mounted (active). The default output line can include up to six fields, as shown in this example:

* /vobs/src /net/host2/usr/vobstore/src_vob public (ucmvob, replicated)

The output fields report:

  • Whether the VOB is mounted (*)
  • The VOB tag
  • The VOB storage directory path name
  • Whether the VOB is public or private (see the mkvob reference page)
  • Whether the VOB is a UCM project VOB (ucmvob)
  • Whether the VOB is replicated (replicated)

The default output of rcleartool lsvob -mounted is the same as that shown above, except that it lists only VOBs that are mounted in the current automatic view.

Restrictions

None.

Options and arguments

Listing format

Default
See the section Default output.
-l/ong
Expands the listing to include all information stored in the VOB registry regarding the listed VOBs.

VersionVault: The network accessibility information includes the global path to the view if a value is set for this property; otherwise, lists the host name and host-local path only.

-s/hort
Restricts the listing to VOB tags only.

Specifying the VOBs

Default
VersionVault: Lists all VOBs registered for the local network region, both mounted and unmounted, public and private.
VersionVault Remote Client: Lists all VOBs registered for the local network region, both mounted and unmounted, public and private, unless -mounted is specified, in which case only mounted VOBs are listed.
-hos/t hostname
Confines the listing to VOBs whose storage directories reside on host hostname. If the CLEARCASE_RGY_QUICK environment variable is set, uses the -quick option.
-quick
Provides faster lookup for the -host option by listing VOBs as currently stored in the registry.
Note: Physical storage is not examined, and aliases and IP addresses are not resolved. Therefore, changes that occurred since a VOB's creation may not be reflected in the listing. Also note that the lookup of entries is case-sensitive.

The CLEARCASE_RGY_QUICK EV causes lsvob -host to use the -quick functionality. For example, by setting this EV you can change the run-time behavior of -host in scripts without modifying the scripts.

The -host option and CLEARCASE_RGY_QUICK EV have no effect if the -region option is also used and the region is specified with a wildcard.

-reg/ion network-region
Confines the VOB listing to include only the VOBs registered for one or more network regions. (The mkvob and mktag commands have a -region option, which can be used to assign VOB tags to specific network regions.) The network-region argument can include pattern-matching characters as described in the wildcards_ccase reference page. Single-quote the network-region argument, if it includes pattern-matching characters.
vob-tag ...
Specifies one or more VOBs to be listed. A VOB must be registered, but it need not be mounted, to be listed with lsvob. The vob-tag argument can include pattern-matching characters as described in wildcards_ccase. Enclose in single quotes any vob-tag argument that includes pattern-matching characters.
-sto/rage vob-storage-dir-pname ...
One or more VOBs, identified by full path names to their storage directories.
-uui/d replica-uuid
Lists the VOB with the specified universal unique identifier (UUID).
-fam/ily vob-family-uuid
Lists the VOB with the specified VOB family UUID.
-mount/ed
Lists VOBs that are mounted in an automatic view.

Specifying the automatic view

Default
The current automatic view.
-vie/w view-tag
Lists VOBs that are mounted in the specified automatic view.

Examples

The UNIX system and Linux examples in this section are written for use in csh. If you use another shell, you might need to use different quoting and escaping conventions.

The Windows examples that include wildcards or quoting are written for use in cleartool interactive mode. If you use cleartool single-command mode, you might 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 UNIX system and Linux shells or Windows command interpreter prompt, followed by the cleartool command. In cleartool interactive mode, cmd-context represents the interactive cleartool prompt.

  • List the VOBs registered for the local network region.

    cmd-context lsvob
    * /vobs/demo    /net/host5/usr/vobstore/demo_vob public
    * /vobs/src     /net/host2/usr/vobstore/src_vob public
    * /vobs/design  /net/host2/usr/vobstore/publicdesign_vob public
      /vobs/pvob    /net/host7/usr/vobstore/p_vob private (pvob)
      /vobs/doc     /net/host2/usr/vobstore/doc_vob public
    * /vobs/stage   /net/host4/usr/vobstore/stage_vob public
    * /vobs/ucmvob  /net/host6/usr/vobstore/ucm_vob private (ucmvob)
      /vobs/bugvob   /net/host8/usr/anne/vobstore/bug_vob private

    *   \demo     \\neptune\vbstore\demo_vob public
    *   \src1     \\sunfield\users\vbstore\src1_vob public
        \ucmvob   \\pluto\users\vbstore\ucm_vob private (ucmvob)
    *   \design   \\luna\vbstore\design_vob public
        \doc      \\sunfield\users\vbstore\doc_vob public
    *   \stage    \\pluto\users\vbstore\stage_vob public
    *   \pvob     \\sunfield\users\vbstore\p_vob private (pvob)
        \bugvob    \\luna\users\anne\vbstore\bug_vob private

  • List, using the long display format, the registry information for the VOB with VOB tag \vob12. The output line Active: YES indicates that the VOB is currently mounted.

    cmd-context lsvob -long \vob12
    Tag: \vob12
    Global path: \\sol\vbstore\vob12.vbs
    Server host: sol
    Access: public
     Region: us_west
    Active: YES
    Vob tag replica uuid:cb4caf2f.f48d11cc.abfc.00:01:53:00:e8:c3
    Vob on host: sol
    Vob server access path: c:\vbstore\vob12.vbs
    Vob family uuid: aed00001.9d3e11ca.bc4c.00:01:53:00:e8:c3
    Vob replica uuid: cb4caf2f.f48d11cc.abfc.00:01:53:00:e8:c3

  • List the VOB with a particular VOB family UUID.

    cmd-context lsvob -family 12a3456b.78c901d2.e3ab.45:67:89:c0:1d:e2
    * /vobs/dev /net/minuteman/vobstg/dev.vbs public

  • For a particular host, list the VOBs whose VOB tags match a wildcard pattern.

    cmd-context lsvob -host host4 '*anne*'
    * /usr/anne/vobs/test2 /net/host4/usr/anne/vobs/test2.vbs public
    * /usr/anne/vobs/work /net/host4/usr/anne/vobs/work.vbs private