Command Reference, Release 2002.05.00, All Platforms

space

Reports on disk space use for views, VOBs, or file-system files or directories

APPLICABILITY


Product	Command Type
ClearCase	cleartool subcommand
ClearCase LT	cleartool subcommand
Attache	command


Platform
UNIX
Windows

SYNOPSIS

ClearCase and Attache-Report disk space used by a view or VOB:

space { -vie·w | -vob } [ -a·ll ] [ -upd·ate ] [ -reg·ion network-region ]: { -host hostname | tag ... }

ClearCase LT-Report disk space used by a view or VOB:

space { -vie·w | -vob } [ -a·ll ] [ -upd·ate ]

Report disk space used by file-system files or directories:

space -dir·ectory pname ...

Generate and cache data on disk space use for local views or VOBs:

space { -vie·w | -vob } -gen·erate [ -scr·ub days ] [ tag ... ]

DESCRIPTION

The space command displays data on disk space use for views, VOBs, or file-system files or directories. Reports are organized by disk partition, with disk-use statistics listed both in absolute units (megabytes) and as a percentage of the capacity of the disk partition containing the storage directory.

The report for a view includes view-private storage and administration data, as well as the space occupied by the view database. For a snapshot view, the report does not include the space occupied by the snapshot view directory tree. To display that information, use the -directory option and specify the root directory of the snapshot view. The information reported varies according to the availability of information on the view, as follows:

If the view resides in the default region of the host on which space is run, the view-tag is listed.

If the view does not reside in the default region of the host on which space is run, the view tag and its region are listed.

If the view is not found in the registry, but the VOB database has a record of its location, the view's UUID, host, and host path are listed. Views in this state are likely candidates for the rmview -uuid command.

If the view is not found in the registry and the VOB database has no record of it, the view's UUID is listed. Views in this state are also likely candidates for the rmview -uuid command.

The report for a VOB includes disk use information for the VOB database and for each storage pool. Among other statistics, it includes information on backup VOB databases left behind when reformatvob was used.

With the -view or -vob option, space uses by default previously generated, cached data for a view or VOB. The -update option generates fresh data and updates the cache before displaying the report. With the -directory option, space does not use cached data.

The -generate option is intended for use by scheduled jobs. By default, the scheduler periodically runs space with the -generate option to generate and cache data on disk space use for all local views and VOBs. See the schedule reference page for information on describing and changing scheduled jobs.

NOTE TO WINDOWS USERS: On Windows 95 and Windows 98 machines, output from the space command is incorrect for disk volumes larger than 2 GB. The total file-system size is limited to 2048 MB, and the in-use value for the file system is wrong.

RESTRICTIONS

Identities: For the -update option, you must have Change or Full access in the scheduler ACL on the host where each VOB storage directory resides (ClearCase and Attache), or the same access in the scheduler ACL on the ClearCase LT server host (ClearCase LT). See the schedule reference page.

For -vob -generate, you must have one of the following identities:

VOB owner

root (UNIX)
Member of the ClearCase group (ClearCase on Windows)
Local administrator of the ClearCase LT server host (ClearCase LT on Windows)

For -view -generate, you must have one of the following identities:

View owner

root (UNIX)
Member of the ClearCase group (ClearCase on Windows)
Local administrator of the ClearCase LT server host (ClearCase LT on Windows)

Locks: No locks apply.

Mastership: (Replicated VOBs) No mastership restrictions.

OPTIONS AND ARGUMENTS

SPECIFYING THE DATA STRUCTURES. Default: If no -view, -vob, or -directory option is specified, the default is -vob. For the -generate option with no specified view or VOB tag, the default for is all local views or VOBs (ClearCase and Attache), or all views or VOBs (ClearCase LT).

-vie·w: ClearCase and Attache-Reports on one or more views, identified either as those whose storage directories reside on the host specified by -host or as those indicated by the specified tags.
: ClearCase LT-Reports on all views.

-vob: ClearCase and Attache-Reports on one or more VOBs, identified either as those whose storage directories reside on the host specified by -host or as those indicated by the specified tags.
: ClearCase LT-Reports on all VOBs.

-host hostname: Reports on all views or VOBs whose storage directories reside on the specified host.
tag ...: One or more tags, interpreted as view tags if you specify -view or as VOB-tags if you specify -vob. Each tag must be valid in the region specified by -region.
-reg·ion network-region: Specifies the network region in which each tag resides. The default is the region of the local host.
-dir·ectory pname ...: One or more pathnames, specifying files or directories in a file system. On Windows 9.X systems, space my be incorrectly reported as a negative value if the disk size is greater than 2GB.

REPORT FORMAT. Default: In a report on a view or VOB storage directory, storage items that are known to be small are not listed. (The contribution of these files is still included in the disk-use total.)

-a·ll: In addition to the default report, lists storage items known to be small, such as .identity (UNIX) and .pid.

DISPLAYING AND CACHING UP-TO-DATE DATA. Default: Use cached data.

-upd·ate: Computes and caches data on disk-space use at the time the command is issued, instead of using cached data, and then displays a report. The computation can take a few minutes.

GENERATING, CACHING, AND SCRUBBING DATA. Default: None.

-gen·erate: Computes and caches data on disk space use at the time the command is issued but does not display a report. The computation can take a few minutes. This option is intended to be used by periodic jobs run by the scheduler.
: ClearCase and Attache-The VOB or view storage directories for all specified VOBs or views must reside on the local host. If no tag argument is specified, the command generates data for all VOBs or views on the local host.

-scr·ub days: Deletes cached records of data on disk space use that are older than the specified number of days. A value of -1 deletes cached records other than the one generated by the current invocation of the command, if any. Although most records are deleted, one data set per month is retained for historical purposes. This option is intended to be used in conjunction with the -generate option by periodic jobs run by the scheduler. The default scheduled job specifies a value of 30 for the -scrub option.

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. In Attache, cmd-context represents the workspace 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.

Report disk space use for a VOB, using cached data.

cmd-context space -vob /projects/bigapp

Use(Mb) %Use Directory 190.1 2% source pool storage /usr1/vobs/bigapp_vob/s 366.7 4% derived object pool storage /usr1/vobs/bigapp_vob/d 48.3 1% cleartext pool storage /usr1/vobs/bigapp_vob/c 1452.2 17% VOB database /usr1/vobs/bigapp_vob/db 0.0 0% unknown item /usr1/vobs/bigapp_vob/vob_scrubber_params~ 0.1 0% administration data /usr1/vobs/bigapp_vob/admin 48.3 1% cleartext pool /usr1/vobs/bigapp_vob/c/cdft 366.7 4% derived object pool /usr1/vobs/bigapp_vob/d/ddft 190.1 2% source pool /usr1/vobs/bigapp_vob/s/sdft -------- ---- --------------------------------------------------------- 2662.5 31% Subtotal 6466.2 76% Filesystem srv1:/usr1 (capacity 8501.5 Mb) Total usage 28-Jul-99.05:03:02 for vob "/projects/bigapp" is 2662.5 Mb

Report disk space use for all views on a host, using cached data.

cmd-context space -view -host machine1

Use(Mb) %Use Directory 0.1 0% View private storage C:\Storage\kim_mainline.vws\.s 0.1 0% View database C:\Storage\kim_mainline.vws\db 0.0 0% View administration data C:\Storage\kim_mainline.vws\admin 1.4 0% View private storage C:\Storage\kim_v3.2.vws\.s 0.1 0% View database C:\Storage\kim_v3.2.vws\db 0.0 0% View administration data C:\Storage\kim_v3.2.vws\admin 103.8 5% View private storage C:\Storage\kim_win32_nt.vws\.s 0.3 0% Database dump file C:\Storage\kim_win32_nt.vws\db.dumped 0.4 0% View database C:\Storage\kim_win32_nt.vws\db 0.0 0% View administration data C:\Storage\kim_win32_nt.vws\admin 0.6 0% View private storage C:\Storage\kim_win32_nt2.vws\.s 0.0 0% View database C:\Storage\kim_win32_nt2.vws\db 0.0 0% View administration data C:\Storage\kim_win32_nt2.vws\admin 0.0 0% View private storage C:\Storage\kim_mainline_snap\.s 0.3 0% View database C:\Storage\kim_mainline_snap\db 0.0 0% View administration data C:\Storage\kim_mainline_snap\admin -------- ---- --------------------------------------------------------- 107.2 5% Subtotal 2000.9 98% Filesystem machine1:c:\ (capacity 2047.0 Mb) Total usage 07-Jul-99.04:40:00 for view "kim_mainline" is 0.2 Mb Total usage 07-Jul-99.04:40:00 for view "kim_v3.2" is 1.5 Mb Total usage 07-Jul-99.04:40:01 for view "kim_win32_nt" is 104.6 Mb Total usage 07-Jul-99.04:40:03 for view "kim_win32_nt2" is 0.6 Mb Total usage 07-Jul-99.04:40:03 for view "kim_mainline_snap" is 0.3 Mb

Generate and cache disk space use data for a view and then display a report.

cmd-context space -view -update fred_1

Updating space information for "fred_1" on host "machine1" Job is running on host ("machine1"), waiting for it to finish. ...... Job completed successfully on host ("machine1"). Use(Mb) %Use Directory 17.1 7% View private storage /export/home/fred/ccstore/fred_1/.s 0.3 0% View database /export/home/fred/ccstore/fred_1/db 0.0 0% View administration data /export/home/fred/ccstore/fred_1/admin -------- ---- --------------------------------------------------------- 17.4 7% Subtotal 220.6 92% Filesystem machine1:/export/home (capacity 240.7 Mb) Total usage 05-Aug-99.10:14:03 for view "fred_1" is 17.4 Mb

Report disk space use for a file-system directory.

cmd-context space -directory D:\users\sue

Use(Mb) %Use Directory 38.8 1% D:\users\sue -------- ---- --------------------------------------------------------- 38.8 1% Subtotal 2546.7 62% Filesystem machine1:d:\ (capacity 4086.8 Mb)