Last updated on Mar 14, 2022



hvr5usagesnapshot.pl – Collect user data.


perl hvr5usagesnapshot.pl [-optionshubdb hubrole hubdescrip

perl hvr5usagesnapshot.pl [-h class] [-u user[/pwd]] hubdb hubrole hubdescrip


Command hvr5usagesnapshot.pl compiles a set of files containing the data on the HVR features used and configured in the current HVR installation.

hvr5usagesnapshot.pl arguments:

  • The argument hubdb specifies the connection to the hub database. For more information about supported hub databases and the syntax for using this argument, see Calling HVR on the Command Line.
  • The argument hubrole indicates whether the hub is used for testing or production. Can be TEST or PROD.
  • The argument hubdescrip contains the user-defined description of the hub.

The resulting files are packed into an archive named usagesnapshot-hubhost-hubname-YYYYMMDD.zip and stored in the directory from which the command is executed (unless another directory is specified). The archive contains the following files:

File NameDescription

hvr_config/log/hubnorm/hvr.outhvr.outGB) of data

Passwords and secrets are removed for security reasons.


Output of Hvrcatalogexport of the hub.

Passwords and secrets are removed for security reasons.


Collected items:

  • Hub_Host_Name - name of the hub host.
  • Hub_Name - hub name.
  • Usage_Snapshot_Date - date the snapshot was made.

  • Hub_OS_Fingerprint -  fingerprint of the current host HVR is running on.

  • Snapshot_Version - snapshot version.

  • Hub_Db_Class - class of the hub database.

  • Hub_Db_Flavor - flavor of the hub database.

  • Hub_Db_Version - version of the hub database.

  • Hub_Description - hub description.

  • License_Hash - license identification hash.

  • Hub_Role - script. Can be TEST or PROD.

  • Hub_Hvr_Platform - platform on which current HVR installation runs.

  • Hub_Hvr_Version - current HVR version.

  • Switch_Table_Events - number of switch table events.

  • Hub_Hvr_Config - HVR_CONFIG location.

  • Hub_Hvr_Home - HVR_HOME location.

  • Cap_State_Files - number of capture state files.

  • Cap_State_Files_Updated_This_Month - number of capture state files updated this month.

  • Capture_Checkpoints_On_Hub - number of checkpoints on the hub.

  • Job_Count - number of jobs.

  • Hvr_Wallet_Type - type of the hub encryption wallet.

  • Hvr_Wallet_Opening - method for supplying a wallet password. Can be AUTO, PLUGIN, or MANUAL.


Data collected per profile (location). Only contains profiles for locations in channels. Each profile generates a line in profiles.csv, with the following columns:

  • chn_name – channel name.

  • loc_namelocation name.

  • nls_langlanguage, territory and character set properties.

  • agent_hvr_version – version of the HVR agent.

  • tz – timezone of the machine running the location.

  • dbms_version – version of the database management system.

  • dbms_flavorflavor of the database management system.

  • loc_class – location class.

  • agent_endianess – agent endianness.

  • agent_fingerprintunique identifier (fingerprint) of the server on which the HVR agent is installed.

  • agent_hvr_home – directory path of HVR_HOME for HVR agent.

  • agent_hvr_configdirectory path of HVR_CONFIG for HVR agent.

  • default_schema – default database schema.

Values can be null (empty string).


Join all hvr_config/files/hvrlogrelease*.opt.

Passwords and secrets are removed for security reasons.


Join all hvr_config/files/hvrmaint*.opt.

Passwords and secrets are removed for security reasons.


-h class

Location class of the hub database. Valid values for class are db2db2iingresmysqloraclepostgresqlsqlserver, or teradata. For more information, see Calling HVR on the Command Line.

-u user[/pwd]

Connect to hub database using DBMS account user. For some databases (e.g. SQL Server) a password must also be supplied.