lsvob

Lists VOB registry entries

APPLICABILITY

ProductCommand type
ClearCasecleartool subcommand
ClearCase LTcleartool subcommand

Platform
UNIX
Windows

SYNOPSIS

  • ClearCase—List VOBs:
    lsvob [ –s·hort | –l·ong ] [ –hos·t hostname ]
    [ –reg·ion network-region ]
    [ vob-tag ... | –sto·rage vob-storage-dir-pname ...
    | –uui·d replica-uuid | –fam·ily vob-family-uuid ]

  • ClearCase LT—List VOBs:
    lsvob [ –s·hort | –l·ong ]
    [ vob-tag ... | –sto·rage vob-storage-dir-pname ...
    | –uui·d replica-uuid ]

  • ClearCase—List VOBs using the graphical VOB browser:
    lsvob –g·raphical [ –reg·ion network-region ]

  • ClearCase LT on Windows—List VOBs using the graphical VOB browser:
    lsvob –g·raphical

DESCRIPTION

The lsvob command lists one or more VOBs. To be accessible to cleartool 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 (ClearCase), or on the ClearCase LT 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 Administrator's Guide.

ClearCase—Default Output

In ClearCase, lsvob lists all VOBs registered for the current network region by default, whether or not they are mounted (active). The default output line for each listed VOB looks like this:

* /vobs/src /net/host2/usr/vobstore/src_vob public

The five output fields report:

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

RESTRICTIONS

None.

OPTIONS AND ARGUMENTS

Listing Format

Default
ClearCase: See the “ClearCase—Default Output” section.

ClearCase LT: One-line summary.

–l·ong
Expands the listing to include all information stored in the VOB registry regarding the listed VOBs.

ClearCase—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.

ClearCase LT—The network accessibility information lists the host name and the host-local path.

–s·hort
Restricts the listing to VOB tags only.

Listing the VOBs Graphically.

Default
Lists the VOBs in the command window.

–g·raphical
Starts the VOB Browser to list the VOBs.

Specifying the VOBs

Default
ClearCase: Lists all VOBs registered for the local network region, both mounted and unmounted, public and private.

ClearCase LT: Lists all VOBs on the ClearCase LT server.

–hos·t hostname
Confines the listing to VOBs whose storage directories reside on host hostname.

–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.) Unless you use the –graphical option, 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 pathnames 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.

EXAMPLES

The UNIX examples in this section are written for use in csh. If you use another shell, you may 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 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 UNIX shell or Windows command interpreter prompt, followed by the cleartool command. In cleartool interactive mode, cmd-context represents the interactive cleartool prompt.

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 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

  • Use a VOB browser to list all VOBs in the rd_east region.

    cmd-context lsvob –graphical –region rd_east 

SEE ALSO

mktag, mkvob, mount, register, umount, unregister, Administrator's Guide



Copyright© 2003 Rational Software. All Rights Reserved.