Vault Service

Previous Next  Print this Topic

The Vault Service (VaultSvc) manages the Vault(s) on the network, and runs as a background service. As Vault Service runs, its behavior can be modified with the command line options listed below. You can enter a single argument, a single argument and -usage or -version, or a combination of several arguments and -usage or -version.

The command line is formed as follows:

VaultSvc <option> <option> . . .



-instance <number>

Define the instance number of the Vault service to be started.

-service_install <number>


-service_remove <number>

Windows only. Install is for manually installing the service. Remove is for manually removing the service. You can use only one argument at a time.

Valid value = service instance number


List all valid command line arguments for the service.


Display the current version information.


Cause the VaultSvc to scan the local computer for SCSI devices and display them in the current window. The VaultSvc then terminates.

Configuration File Structure

The Vault configuration file provides the Vault Service with its run time operation parameters. The configuration file is read by the Vault Service at each start. The file is normally created by the Add or Remove Vault Wizard when a new Vault is added. This file is located at <install-dir>/Config/VaultSvc<service instance number>.cfg, where <service instance number> is determined from the invocation line with the -instance command line argument (above).

Vault configuration files are formatted as follows:

policy_name="<Vault name>"
 . . .

Token/Value Pairs

A token is a configuration file attribute that gives a value to determines how the service is run.



act_log_enable = <boolean>

Enable activity logging. When enabled, all jobs, retrievals, loads, ejections, startups, and shutdowns are written to the activity log.

Valid values = true | false

Default = false

act_log_max_size_mb = <number>

The maximum size in bytes of the activity log.

Default = 50 (bytes)

act_log_pn = "<pathname>"

The location of the activity log.

Default = </usr/local/Phoenix>/Logs/VaultSvcActivity1.log

act_log_recycle = <boolean>

Write new events at the beginning of the activity log file when the maximum size is reached.

Valid values = true | false

Default = false

active = <boolean>

Specify if the Vault should be started.

Valid values = true | false

Default = true

admin_req_cmd = "<command string>"

If not blank, this command is executed any time offline media needs to be mounted. It may be used to execute a shell script or executable that performs an activity any time a Vault requires manual intervention.

The command is executed with arguments as follows:

<command string> <host_name> <media_name> <media_storage_location>

host_name = the name of the client machine needing access to the media
media_name = the name of the media
media_storage_location = the location specified when the media was originally taken offline.

Default = "" (empty)

background = <boolean>

For diagnostic purposes, to debug the process.

Valid values = true | false

Default = true

block_size_b = <number>

The block size in bytes used when writing to tapes. A value of 0 (zero) indicates that a default value supplied by the host operating system is used.

Default = 0

cache_size_mb = <number>

The amount of memory in megabytes allocated for the temporary storage of incoming data.

Default = 10

cgr_id_string = "<SCSI device ID string>"

The SCSI library device or stand alone drive to be managed by the Vault. This option is only valid for data tape library Vaults and stand alone tape drive Vaults. The SCSI device ID string is composed as follows: "<Manufacturer><Product ID><Serial Number>".


coc_log_enabled = <boolean>

Specify if Chain of Custody logging is enabled.

Valid values = true | false

Default = false

console_pn = "<pathname>"

The path to the file where all console activity is written.

Default = "/dev/console"

db_max_files_open = <number>

The number of database files that can open simultaneously. There is one database file per volume. As database files stay open, the service accesses the database files faster without extensive file opening.

Default = 100

db_max_mem_mb = <number>

Limit how much virtual memory in megabytes the database uses. For best Information Repository performance, select a value that does not exceed 75% of physical memory on the computer.

Default = 1024 (1 GB)

db_opt_tod = <mm:hh>

The time the database is optimized daily.

Default = 00:00 (midnight)

db_pn = "<pathname>"

The path to the folder where database files are stored. Ensure files are stored on a local hard disk.

Default = "</usr/local/Phoenix>/Database"

diag = <boolean>

Run the service in diagnostic mode. All internal activity displays on the local terminal.

diag displays the minimum amount of diagnostic information.
diag_high displays all diagnostic information.

Valid values = true | false

Default = false

diag_high = <boolean>

diag_pn = "<pathname>"

Redirect any diagnostic output to any file or device at service startup.

Default = "/dev/tty"

drive_id_string = "<SCSI device ID string>"

The SCSI tape drive(s) to be managed within a tape library. This option is intended to be used where the SCSI changer/library is unable to provide the correct IDs for its internal tape drives. This option may be specified multiple times for libraries with multiple drives. The first occurrence must be for the first drive with each successive occurrence for each additional drive. The SCSI device ID string is composed as follows: "<Manufacturer><Product ID><Serial Number>".


email_enable = <boolean>

E-mail notification of certain Vault events, such as startup, shutdown, and media load requests.

Valid values = true | false

Default = false

email_recipient = "<character string>"

The e-mail address to where e-mail notifications are sent.

Default = "" (empty)

email_server = "<character string> "

The name or IP address of the mail server.

Default = "" (empty)

error_log = "<pathname>"

The path to the error log file.

Default = '</usr/local/Phoenix>/Logs/VaultSvc1.log"

fast_index = <boolean>

For diagnostic use only. Enable Vault to use on-media database partitions to increase the speed that unknown media is loaded.

When "false", every load of an unknown media results in a sequential re-indexing of the entire media.

Valid values = true | false

Default = true

fs_default_media_dir_pn =

The default location for a hard disk Vault to store media.

Default =</usr/local/Phoenix>/Media

fs_max_dir_ent = <number>

The maximum number of files stored in a single directory contained on a unit of hard disk media. This option is valid only for hard disk Vaults.

Default = 100

fs_num_virt_drives = <number>

The number of concurrent data connections to use at one time. This option is valid only for hard disk Vaults.

Default = 10

license_string = "<character string>"

The 80 character ASCII text string that is contained within a license file. An empty license string causes the service to run in evaluation mode.

Default = "" (empty)


The type of configuration file.

Only valid value = "vaultsvc"

vault_instance = <number>

Define the instance number of the Vault service to start.

Default = 1

vault_name = "<character string>"

The name of the Vault service that runs.

%HOSTNAME% and %TYPE% variables can be used instead of a hard coded name. %HOSTNAME% is replaced by the computer name; %TYPE% is replaced by the Vault's type.

Default = "%HOSTNAME%_%TYPE%"

vault_type = <alpha>

The type of Vault service that runs.

Valid values =


Default = HardDisk

version = "<number>"

The version of the configuration file.

Valid value = "1.0"

working_cache_pn = "<pathname>"

Define the Vault's working cache directory. The working cache directory is the place where the Vault can store temporary items during its normal activities. This working cache is especially important when clipping video files.

Default = "</usr/local/Phoenix>/WorkingCache"

working_cache_size_gb = "<number>"

The amount of disk space the Vault's working cache may use to store temporary files. On tape Vaults, the working cache should be large enough to hold multiple large video files.

Default = 100GB

write_with_verify = <boolean>

For diagnostic use only. When set to true, enables the read-after-write check of most tape drives. Setting this to "false" is unadvisable as doing so can cause unreported data corruption.

Valid values = true | false

Default = true

Sample Vault Configuration File

policy_name = "VaultSvc1"


 type                     = "vaultsvc"

 version                  = "1.0"

 active                   = true

 vault_name               = "test_HardDisk1"

 vault_instance           = 1

 vault_type               = HardDisk

 db_opt_tod               = 00:00

 db_max_mem_mb            = 1024

 db_max_files_open        = 100

 db_pn                    = "/usr/local/Phoenix/Database"

   fs_default_media_dir_pn  = "/usr/local/Phoenix/Media"

 fs_num_virt_drives       = 10

 fs_max_dir_ent           = 100

 cgr_id_string            = ""

 diag                     = false

 diag_high                = false

 diag_pn                  = "/dev/tty"

 act_log_enable           = false

 act_log_recycle          = false

 act_log_max_size_mb      = 50

 act_log_pn               = ""

 email_enable             = false

 email_recipient          = "vault_admin"

 email_server             = "email_server"

 cache_size_mb            = 10

 block_size_b             = 0

 write_with_verify        = true

 background               = true

 fast_index               = true

 console_pn               = "/dev/console"

 error_log                = "/usr/local/Phoenix/Logs/VaultSvc.log"

 admin_req_cmd            = ""

 license_string           = ""

 working_cache_pn         = "/usr/local/Phoenix/WorkingCache"

 working_cache_size_gb    = "100"


Windows Diagnostics

This section pertains to the Windows operating system only.

To open a diagnostics window for Vault Services, you first need to configure Windows Services to allow the Vault Service to interact with the desktop client.

When enabling this feature, a window appears to display Vault activity. If you close this window, it stops the Vault, and Phoenix VCM does not operate without running Vaults.

To configure Vault Services to open a window for diagnostic messages, do the following:

1.Access SoleraTec Vault Service in the Windows Services window. See Start Vaults Manually for directions.
2.Stop the Vault that you want to modify. Right-click SoleraTec Storage Vault, and then click Stop. The Service Control dialog box appears briefly to display progress.
3.Right-click the SoleraTec Storage Vault again, and then select Properties. The SoleraTec Storage Vault#x Properties window (#x is the Vault ID number) appears.
4. Click the Log On tab.
5. Select the Allow services to interact with desktop checkbox.
6. Click OK.
7. Start the Vault. Right-click SoleraTec Storage Vault, and then click Start Job.
8. Close the Windows Services window.