Rational ClearCase Commands Referenceannotate
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
DESCRIPTION
The mkstgloc command creates and registers a named server storage location for view or VOB storage directories. The command initializes a physical directory and writes information describing that directory to the ClearCase or ClearCase LT registry. For information about the registry, see the Administrator's Guide.
Other Uses for mkstgloc
You can also use mkstgloc for other purposes:
- Adopting an existing directory as a server storage location. An existing directory is adopted if stgloc-pname specifies that directory.
- (ClearCase) Registering an existing server storage location in a new region. A server storage location is registered in a new region if stgloc-pname specifies an existing server storage location. Specify new arguments for options such as –region and –host as appropriate for the region in which you are registering the server storage location.
Default Selection of Server Storage Locations During View and VOB Creation
For information about the default selection of server storage locations in view and VOB creation, see the mkview and mkvob reference pages.
ClearCase—File System Connectivity Considerations
Before creating a server storage location for a ClearCase view or VOB, determine whether there is file system connectivity between the server storage location's host and its clients in the regions that advertise the server storage location. File system connectivity determines how you can use the server storage location, as follows:
ClearCase—Derived and Explicitly Specified Client Accessibility Information
To be accessible to its clients, a ClearCase server storage location needs to be registered with the following information:
- The name of the host where the server storage location resides.
- A host-local pathname to the server storage location.
- For dynamic views or VOBs accessed through dynamic views, a global pathname to the server storage location relative to the host's network region.
- The network region in which the host resides.
In many cases, ClearCase heuristically derives appropriate accessibility information from the stgloc-pname argument. In cases where there is no file system connectivity between the server storage location and its clients, ClearCase derives the host name and host-local path, but because no meaningful global path can be derived, you must specify –ngpath to unset the global path information.
An unusual network configuration may defeat the heuristic by which accessibility information is derived, thereby preventing access to the server storage location by some or all ClearCase clients. In such cases, set the registry information explicitly, following these guidelines:
- To create a server storage location for dynamic views or for VOBs intended to be accessed through dynamic views, use the option set, –host –hpath –gpath.
- To create a server storage location for snapshot views or for VOBs intended to be accessed only through snapshot views, use these options:
To create a server storage location on a supported network attached storage (NAS) device, you must specify the option set, –host –hpath –gpath. (NAS devices must be specially configured for use with ClearCase. For more information, see the Administrator's Guide.)
ClearCase LT—File System Connectivity and Client Accessibility
For ClearCase LT, issues related to file system connectivity and client accessibility to server storage locations are not as complex as they can be for ClearCase. ClearCase LT assumes there is no file system connectivity such as that provided by NFS, so there are no command options or arguments related to the presence or absence of file system connectivity.
All server storage locations reside at the ClearCase LT server host. ClearCase LT clients learn the name of that host at client-install time. In rare cases, the host chosen to serve as the ClearCase LT server host is known by different names through different network interfaces. However, ClearCase LT requires that the ClearCase LT server host be known to all its clients by the same host name. Therefore, you must set up the host's network configuration to ensure that a single host name maps to different network addresses that are appropriate for the various client hosts of the server. For more information, see the Administrator's Guide.
OPTIONS AND ARGUMENTS
Confirmation Step
- Default
- Prompts for confirmation that the server
storage location is to be created as specified only if you are adopting an
existing directory (see “Other
Uses for mkstgloc”).
- –f·orce
- Suppresses the confirmation step.
Specifying Network Accessibility
- Default
- A host name, host-local path, and global
path are derived from the specified stgloc-pname.
- –hos·t hostname
- –hpa·th host-storage-pname
- –gpa·th global-storage -pname
- –ngp·ath
- Use these options only after you have
determined that you need to explicitly set a server storage location's registry
information (see “ClearCase—Derived and Explicitly Specified Client
Accessibility Information”).
The information is written to the registry exactly as you specify it.
You must either specify the –host, –hpath, and –gpath options as a set; or use –ngpath and optionally specify –host and –hpath.
–host hostname—The name of the host where the server storage location is to reside or, if the storage is on a NAS device, the name of the host on which the VOB or view server serving the storage location will run.
–hpath host-storage-pname—A standard full pathname to the server storage location that is valid on the specified host.
–gpath global-storage-pname—A standard full pathname to the server storage location that is valid in the target network region for all client hosts that are to access the server storage location.
–ngp·ath—Specifies that in the target region there is no global path by which the server storage location can be accessed.
Specifying a Name and Path for the Server Storage Location
- Default
- None.
- stgloc-name
- Specifies the name under which the server
storage location is to be registered. The name must be unique within the target
region.
- stgloc-pname
- Specifies the path to the server storage
location. stgloc-pname must not specify a subdirectory
of an existing server storage location.
ClearCase on UNIX. stgloc-pname must specify a location on a host where the ClearCase installation is not client-only. For storage intended for snapshot views or VOBs to be accessed only through snapshot views, stgloc-pname must be a UNC name only if there is a global path to the server storage location (that is, you did not specify –ngpath). For related information, see the description of CCASE_GPATH_HINTS in the env_ccase reference page.
ClearCase on Windows. stgloc-pname must specify a location on a host where the ClearCase installation is not client-only. For storage intended for dynamic views or VOBs they access, stgloc-pname must be a UNC name. For storage intended for snapshot views or VOBs to be accessed only through snapshot views, stgloc-pname must be a UNC name only if there is a global path to the server storage location (that is, you did not specify –ngpath). stgloc-pname must not be within a Windows special share, such as the share that is designated by drive$ and that allows administrators to access the drive over the network.
NAS devices providing storage for ClearCase on UNIX or Windows. stgloc-pname must specify a location on the NAS device that is accessible to all ClearCase hosts in the region.
ClearCase LT on UNIX. stgloc-pname must be located on the ClearCase LT server host and must be must be a UNC name. For related information, see the description of CCASE_GPATH_HINTS in the env_ccase reference page.
ClearCase LT on Windows. stgloc-pname must be located on the ClearCase LT server host and must be must be a UNC name. stgloc-pname must not be within a Windows special share, such as the share that is designated by drive$ and that allows administrators to access the drive over the network.
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.
- Create a server storage location for VOBs that dynamic views can access, allowing mkstgloc to derive client accessibility information from the specified server storage location pathname.
- Create a server storage location for dynamic views, allowing mkstgloc to derive client accessibility information from the specified server storage location pathname.
- Create a server storage location for a VOB that only snapshot views will access.
- Create
a server storage location for VOBs on a NAS device. The VOB server will run
on ClearCase host ccvobsvr1
cmd-context mkstgloc -vob -host ccvobsvr1 -gpath \\nasdevice\vobstg\nasvobstg \
-hpath \\nasdevice\vobstg\nasvobstg ccnasvobstg \\nasdevice\vobstg\nasvobstg
Created and advertised Server Storage Location.
Host-local path: ccvobsvr1:\\nasdevice\vobstg\nasvobstg
Global path: \\nasdevice\vobstg\nasvobstg