Vault Admin Command Line

Previous Next  Print this Topic

Use VaultAdminCl to manage media and Vaults in your Information Repository.

To execute Vault Admin tasks, ensure that the folder where Phoenix VCM is installed is in your command path, open a command prompt, and run VaultAdminCl at the command line. As needed, use the commands listed below. For more information see Vault Admin and Command Line Arguments.

Access VaultAdminCl from your suite of application products.

Command Line Options

As needed, append the following options to the execution path. When you run VaultAdminCl, the command line is formed as follows:

VaultAdminCl <option>

-input_pathname <pathname> - Contains the input list of commands.
-output_pathname <pathname> - Define the path to the file containing the output results.
-usage - List all valid parameters.
-version - Display the current version information.

Interactive Commands and their Arguments

After starting the application, type the following arguments to the command line prompt one at a time. When entering arguments, you can simultaneously enter required variables or enter just a given argument and wait for the system to prompt you for its required variables.

Argument

Description

clist

List all current clients for the selected Vault.

close

Close the connection to the selected Vault.

diag

Set the diagnostic mode for the selected Vault.

drives

List drives for selected Vault.

dstat <drive name>

Display information about a selected drive. If the name is not listed on the command line, it asks to provide the name.

errorlog <pathname>

Set the Vault's error log path.

Valid values:

pathname - New error log path.

format <notation type>

Set the current client address format.

Valid notations:

dot - Client computer network address is displayed.
host - Client computer name is displayed along with domain and subnet names.
full - Client's host name and port number are displayed.

help | ?

Show valid usages for commands. Use only one command at a time.

license <pathname>

Set the path for Information Repository license.

Valid values:

pathname - New path name to the license file.

load <argument>

Load the media for the selected Vault.

Arguments for a tape Vault with a mailslot:

load from mailslot? <yes | no>
if loading from mailslot, mailslot loc
if not loading from mailslot, storage loc
force reindex of media? <yes | no>

Arguments for a tape Vault with no mailslot:

storage loc
force reindex of media? <yes | no>

Arguments for a hard disk Vault:

media name
media in default location? <yes | no>
if not in a default location, pathname
force reindex of media? <yes | no>

media

List the media for the selected Vault.

mstat <name>

Display media status.

name - Name of the media to display.

name <name>

Set the name for the selected Vault.

Valid values:

name – New name for the Vault.

prepare <arguments>

Prepare media for the selected Vault.

Arguments for a tape Vault with a mailslot:

media name
Barcode/ID
description
storage pool
content searching <yes | no>
file de-duplication <yes | no>
load from mailslot? <yes | no>
if loading from mailslot, mailslot loc
if not loading from mailslot, storage loc
prepare media now? <yes | no>

Arguments for a tape Vault with no mailslot:

media name
Barcode/ID
description
storage pool
content searching
file de-duplication
storage loc
prepare media now? <yes | no>

Arguments for a hard disk Vault:

media name
description
storage pool
media size
content searching
file de-duplication
store media in default location? <yes | no>
if not in default location, pathname
prepare media now? <yes | no>

quit

Exit the application.

reload <arguments>

Reload media for the selected Vault.

Valid arguments:

media name
force reindex of media? <yes | no>

secure <boolean>

Secure/unsecure the selected Vault from any media eject or load commands. You must have administrator rights to execute this command.

Valid values:

on
off

select <Vault name>

Select the Vault for operation.

shut <type of shutdown>

Close the selected Vault. You must have administrator access to execute this command.

Valid values:

extended - Close the Vault after all clients and callbacks have been serviced. Close all open databases.
normal - Close the Vault and all current connections.
restart - Execute a normal shutdown and then restart the Vault.
emergency - Close the Vault immediately.

stat

Display status information of selected Vault.

timeout <number>

Set the communication timeout value.

Valid values:

0 - 10 (where "0" is the shortest, "9" is the longest, and "10" is never.)

unload <arguments>

Unload media for the selected Vault.

Valid arguments:

media name
media tracking? <yes | no>
if keeping track, enter storage location
update the media if needed? <yes | no>

vaults

Display a list of registered Vaults.

vexer <arguments>

Run the canned Vault exercises.

Valid arguments:

storage pool
scale factor
minimum file size
maximum file size
maximum sleep time
check file? <yes | no>
stop test on error? <yes | no>
time to run <hh:mm:ss>