Home
Reference
Review reference information for the product.
HCL VersionVault command reference
HCL VersionVault and HCL VersionVault MultiSite provide a command-line interface that enables access to all product functions. The command line processor supports interactive use, and can also be driven by various scripting languages.
Administrator Commands (base VersionVault and UCM)
These commands are used by VersionVault administrators or any user who performs administrative tasks.
Managing VOBs and views
These commands are useful for creating and administering VOBs and views.
Backing up and restoring VOBs
Ensuring frequent, reliable backups of essential data is a critical task for any HCL VersionVault administrator. As with all databases, VOBs have special backup and restore requirements, which are supported by these commands.
snapshot.conf
VOB snapshot configuration file

Reference
Review reference information for the product.
- HCL VersionVault command reference
  HCL VersionVault and HCL VersionVault MultiSite provide a command-line interface that enables access to all product functions. The command line processor supports interactive use, and can also be driven by various scripting languages.
  - Commands for developing software
    These commands are used by software developers and others who work with resources that are under HCL VersionVault control. Most of the cleartool commands used by developers who use the VersionVault local client are also available as rcleartool commands for users of the VersionVault remote client.
  - Commands for building software (base VersionVault and UCM)
    These commands are useful for building software, especially in a dynamic view.
  - Administrator Commands (base VersionVault and UCM)
    These commands are used by VersionVault administrators or any user who performs administrative tasks.
    - Importing assets from other configuration management systems
      VersionVault provides a number of utilities that enable you to import files, folders, and metadata from other configuration management systems.
    - Managing VOBs and views
      These commands are useful for creating and administering VOBs and views.
      - checkvob
        Finds and fixes inconsistencies within and between VOBs
      - chflevel
        Raises the feature level of a VOB
      - chpool
        Changes the storage pool to which an element is assigned
      - dospace
        Reports on VOB disk space used for shared derived objects
      - lock
        Locks an object
      - lsvob
        Lists VOB registry entries
      - lstype
        Lists a VOB's type objects.
      - mkpool
        Creates a VOB storage pool or modifies its scrubbing parameters
      - mkstgloc
        Creates a server storage location for views or VOBs
      - mkview
        Creates and registers a view
      - mkvob
        Creates and registers a versioned object base (VOB)
      - rmview
        Removes a view or removes view-related records from a VOB
      - rmvob
        Removes a VOB storage directory
      - msdostext_mode
        Enables or disables a VOB's interop text mode support
      - recoverview
        Recovers a dynamic view database
      - reformatview
        Updates the format of a view database
      - reformatvob
        Reformats a VOB database
      - relocate
        Moves elements and directory trees from one VOB to another
      - scrubber
        Removes data containers from VOB storage pools and removes DOs from VOB database
      - space
        Reports on disk space use for views, VOBs, or file-system files or directories
      - unlock
        Unlocks an object
      - view_scrubber
        Remove derived object data containers from dynamic view storage
      - vob_scrubber
        Remove event records, oplog entries, or both from VOB database
      - Access control for VOBs and versioned objects
        These commands enable you to control access to VOBs and the objects they contain.
      - Backing up and restoring VOBs
        Ensuring frequent, reliable backups of essential data is a critical task for any HCL VersionVault administrator. As with all databases, VOBs have special backup and restore requirements, which are supported by these commands.
        vob_restore
        Restores a VOB from backup media
        snapshot.conf
        VOB snapshot configuration file
        vob_snapshot
        Copies the VOB databases of all local VOBs or replicas configured for database snapshot
        vob_snapshot_setup
        Sets or displays VOB database snapshot parameters
    - Managing the HCL VersionVault registry
      The HCL VersionVault registry provides a central repository of information about VOB and view locations and also specifies default values for typical client host settings.
    - MVFS reporting
      These commands report on the HCL VersionVault Multiversion File System.
    - Miscellaneous administrator commands and information
      These commands provide administrative interfaces for tasks such as license management, deployment management, and job scheduling.
  - Commands for managing software development projects (base VersionVault and UCM)
    These commands are used by VersionVault project managers, who establish the development policies for software projects.
  - Alphabetical list of all commands
    All commands, listed alphabetically.
- HCL VersionVault MultiSite command reference
  All commands for HCL VersionVault MultiSite, listed alphabetically.

snapshot.conf

VOB snapshot configuration file

Applicability


Product	Command type
VersionVault	data structure


Platform
UNIX®
Linux®

Synopsis

/var/adm/hcl/versionvault/config/snapshot.conf

Description

The file /var/adm/hcl/versionvault/config/snapshot.conf file stores information that VersionVault uses to notify interested parties of VOB database snapshot activity on the local VOB host. Here are the parameters in snapshot.conf and their default values (which are established at installation time):

NOTIFICATION_PROGRAM=/opt/hcl/ccm/versionvault/bin/notify
NOTIFICATION_LIST=root
CONFIRMATION_ON_SUCCESS=yes

NOTIFICATION_PROGRAM=email-program-pathname

The default electronic mail program specified in the configuration file supplied with VersionVault is /opt/hcl/ccm/versionvault/bin/notify. (This program is also used if no NOTIFICATION_PROGRAM entry exists.) This is an architecture-specific script that invokes a native mail program.

NOTIFY_LIST=userid[,...]

A comma-separated list of user IDs to notify of VOB snapshot activity on the local VOB host. List default is a single user ID, root.

CONFIRMATION_ON_SUCCESS=yes | no

Specifies whether to notify the NOTIFY_LIST after successful VOB snapshot operations. Default value is yes.

See also

vob_restore, vob_snapshot

Have feedback?
Google Analytics is used to store comments and ratings. To provide a comment or rating for a topic, click Accept All Cookies or Allow All in Cookie Preferences in the footer of this page.