Data Services Command Line

Previous Next  Print this Topic

Run DataSvcsCl to execute single, interactive migrate, replicate, and purge jobs in the Information Repository.

To run single migrate, replicate, and purge jobs, ensure that the folder where Phoenix VCM is installed is in your command path, open a command prompt, and run DataSvcsCl at the command line. Depending on what you want to do, append tokens as listed below (under Token/Value Pairs) to the execution path. For more information see Data Services Policies and Command Line Arguments.

Access DataSvcsCl from your suite of application products.

Default Data Services List Log

To see a job's run results and diagnostic information, look at the Phoenix VCM list log for any given job. Unless you change the settings and path, Phoenix VCM employs the following: %R/Logs/%P.log. You can change this value when running DataSvcsCl or in the Data Services configuration file.

Default Data Services Error Log

To see if a job had any errors, look at the Phoenix VCM error log. Unless you change the settings and path, Phoenix VCM employs the following: %R/Logs/%P.err. This value can be changed when running DataSvcsCl or in the Data Services configuration file.

Pathname Variables for Logs

Pathname variables are expressions to define what information is included in your logs.

Variable

Description

%P or %Pn

%H or %Hn

%D

%Dy

%Dm

%Dd

%T

%Th

%Tm

%Ts

%R or %Rn

Policy Name

Host Name

Date (yyyy:mm:dd)

Year

Month

Day

Time (hh:mm)

Hour

Minute

Second

Root Pathname. Valid only at the beginning of a string.

Command Line Options

When you run DataSvcsCl, the command line can contain a command line option or token/value pairs. As needed, append tokens as listed below (under Job Token/Value Pairs) to the execution path. The command line is formed as follows:

DataSvcsCl <option>

To retrieve usage and version information, use the appropriate option below:

-usage - List all valid parameters.
-version - Display the current version information.

Job Token/Value Pairs

Use the following token/value pairs to specify policy information for the job that is going to be run.

Token/Value

Description

absolute_start = <yyyy>/<mm>
/<dd>-<hh>:<mm>:<ss>

Used only in the policy file. The exact start time and date that the job is to run. Multiple absolute start tokens may be entered.1

active = <boolean>

Used only in policy file. Define whether the policy is active or inactive.

Valid values = true | false

Default = true

complete = <boolean>

Print all summary information plus the path names of the files migrated to the file indicated by the list_pn option.

Valid values = true | false

Default = false

content_filter = "<character string>"

A word or phrase in the file to be processed.

Default = ""

data_paths = <number>

The maximum number of concurrent files permitted to be sent during a job.

Default = 1

deleted_files = <boolean>

Include files tagged for deletion.

Valid values = true | false

Default = false

diag = <boolean>

Print diagnostic information to the path indicated in the list_pn option.

Valid values = true | false

Default = false

dir_spec = "<pathname>"

Specify which directories to include. Multiple dir_spec options can be specified. The dir_spec check is made for every directory found. This includes the directories contained in the path name list that the job will traverse.

Default = "*" (any)

display_only = <boolean>

The job searches for target files without processing them. Lists the files that would have been processed.

Valid values = true | false

Default = false

dst_media_name = "<character string>"

Specify the destination media name. If you don't specify a value in this option, The first available unit of media is used.

Default = "*" (any)

dst_media_speed = <character string>

Specify the destination media to be used according to media speed.

Valid values =

S0 - S10
Unspecified

Default = Unspecified

dst_media_type = <character string>

Specify the destination media type to be used.

Valid Values =

Hdisk - Hard disk
8mm - Eight-millimeter tape
Dds - Digital data storage
Dlt - Digital linear tape
Ait - Advanced intelligent tape
SuperAit - Super advanced intelligent tape
Vxa - Exabyte VXA tape
Travan - Travan tape
Lto - Linear tape open
MagOptical - Read/write optical
Unspecified

Default = Unspecified

dst_storage_pool = "<character string>"

Specify the name of the destination storage pool to be used. Use ''" for no storage pool name.

Default = "*" (any)

dst_Vault_name = "<character string>"

Specify the destination Vault to be used.

Default = "*" (any)

dst_volume_format

Currently not supported.

dst_volume_name

Currently not supported.

dt_access = <alpha><yyyy>/<mm>
/<dd>-<hh>:<mm>:<ss>

Process files based on the accessed date and time.

Valid values =

AO (Absolute Old) - Selects files with a dtu (date_time_use) equal to or before the specified date. Enter the year as a 4-digit number.
AN (Absolute New) - Selects files with a dtu equal to or after the specified date. Enter the year as a 4-digit number.
RO (Relative Old) - Selects files with a dtu equal to or before the relative specified date.
RN (Relative New) - Selects files with a dtu equal to or after the relative specified date.
I (Inactive) - Do not use date.

Default = I

dt_stored = <alpha><yyyy>/<mm>
/<dd>-<hh>:<mm>:<ss>

Process files based on the date and time stored on the Vault.

Valid values =

AO (Absolute Old) - Selects files with a dtu (date_time_use) equal to or before the specified date. Enter the year as a 4-digit number.
AN (Absolute New) - Selects files with a dtu equal to or after the specified date. Enter the year as a 4-digit number.
RO (Relative Old) - Selects files with a dtu equal to or before the relative specified date.
RN (Relative New) - Selects files with a dtu equal to or after the relative specified date.
I (Inactive) - Do not use date.

Default = I

error_log = "<pathname>"

Specify the path for the error log file. If you specify "/dev/tty", error messages display on the default output device. Supports token substitution.

Default path for the configuration file = "%R/Logs/%P.err"

Default path for the command line = "/dev/tty"

exclude_dir_spec = "<pathname>"

Omit directories. Accept multiple instances.

Default = "" (no directories excluded)

exclude_file_spec = "<pathname>"

Omit files. Accept multiple instances.

Default = "" (no files excluded)

file_spec = "<pattern>"

Set the criteria for files that are to be processed. This token/value pair can be specified multiple times to include multiple file filters.

Default = "*" (any)

hostname = "<host name>"

Select the files that are to be processed based on the original host name for the file.

Default = ""

include_offline = <boolean>

Process files from offline media.

Valid values = true | false

Default = false

job_type = <alpha>

Specify the job type.

Valid values =

replicate
migrate
purge

Default = migrate

keep = <boolean>

Keep a copy of the source files after they have been processed.

Valid values = true | false

You would use "false" to create a move policy; use "true" to create a replicate policy.

Default = false

list_pn = "<pathname>"

Specify the file where all report information is written. Supports token substitution.

Default path for the policy file = "%R/Logs/%P.log"

Default path for the command line = "/dev/tty"

max_file_size = <number>

Specify the maximum size in bytes of a source file. The min_file_size and max_file_size options are mutually exclusive.

Default = 18446744073709551615

min_file_size = <number>

Specify the minimum size in bytes of a source file. The max_file_size and min_file_size options are mutually exclusive.

Default = 0 (none)

out_of_band = <boolean>

Enable the application to constantly monitor its processes and select the network transmission protocol that best suits the files being processed.

Valid values = true | false

Default = true

post_proc_cmd = "<command>"

Specify a command that runs immediately after the job is finished. Supports token substitution.

Default = ””

pre_proc_cmd = "<command>"

Specify a pre-process command that runs immediately before a job starts. Supports token substitution.

Default = ””

remove_only = <boolean>

Purge the targeted file from the source Vault instead of migrating or replicating it.

Valid values = true | false

Default = false

repeat_interval = <hh:ss:mm>

Used only in the policy file. The amount of time that elapses before a job is repeated.1

Default = 24:00:00

src_high_water_mark = <number>

Specify the maximum percent (%) of media that will be used. If the % used is greater than the entered value, the file is processed.

Valid values = 1 - 100

Default = 0

src_low_water_mark = <number>

Specify the minimum percent (%) of media used after the high watermark has been reached. If the % of media used is greater than this value and the high watermark has been reached, the file is processed.

Valid values = 1 - 100

Default = 0

src_media_name = "<character string>"

Specify the source media name.

Default = "*" (any)

src_media_speed = <character string>

Specify the source media speed.

Valid values =

S0 - S10
Unspecified

Default = Unspecified

src_media_type = <character string>

Specify the source media type from the file.

Hdisk - Hard disk.
8mm - Eight-millimeter tape.
Dds - Digital data storage.
Dlt - Digital linear tape.
Ait - Advanced intelligent tape.
SuperAit - Super advanced intelligent tape.
Lto - Linear tape open.
Vxa - Exabyte Vxa tape.
Travan - Travan tape.
MagOptical - Read/write optical.
NullDevice
Unspecified

Default = Unspecified

src_storage_pool = "<character string>"

Specify the source storage pool.

Default = "*" (any)

src_Vault_name = "<character string>"

Specify the source Vault.

Default = "*" (any)

src_volume_format

Currently not supported.

src_volume_name

Currently not supported.

start_days = <mtwtfss>

Used only in the policy file. Specify the days the job is to run. Use - to indicate days that job does not run.

For example, if the job is to run on Thursday, type ---t---.1

Default = mtwtfss

start_time = <hh:mm:ss>

Used only in the policy file. Specify the time the job should start for each defined start day in start_days.1

Default = 0:0:0 (midnight)

stop_time = R<yyyy>/<mm>
/<dd>-<hh>:<mm>:<ss>

Used only in the policy file. Specify the date and time the job is to stop. The date and time entered is relative to the start of the job.

Default = 0/0/0-0:0:0 (no stop time)

summary = <boolean>

Print the start and stop times and final statistics of the job to the file indicated by the list_pn option (above).

Valid values = true | false

Default = true

throttle = <number>

The throttle controls the amount of bandwidth used by jobs (and the speed that files are sent to Vaults). Throttle values are relative to Information Repository capacity and range from 1% to 100%. A lower setting reduces the amount of available bandwidth.

Valid values = 1 - 100

Default = 100

type = "<alpha>"

The policy type of the policy file. Only "ds" is valid for Data Service policies.

vcs = <alpha><number>

 

Specify the number of files (F) or number of bytes (S) to store per single Vault connection.

Valid values =

F - files
S - bytes
1 -

Default = F500

version = "<number>"

The version number of the currently installed command line application. Only the current version number is valid. This number changes with new releases.

volume_use

Currently not supported.

1Note: Timing tokens are mutually exclusive. Only one timing token may be set. Set either absolute_start, or repeat_interval, or start_days and start_time.