Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Cmd Line

Top level config

Item level config

Example Values

Default Value

Description

-help



bool

false

Give basic usage information.

-test

X


bool

false

Commands are constructed but not actually run.

-debug

X


bool

true

Outputs commands before they are run, as well as basic debug info.

-verbose

X


bool

false

Outputs more debug info than debug.

-projectNum

X


48500052

n/a

The project # to charge

-dateString

X

X

'yesterday', '-48 hours', '20070102'

yesterday

The date/time that is used to generate year/month/day values for substituting in paths, filenames, and comments.

-config



myconfig.xml

n/a

The config file that is to be used. This is the only required command line argument.

-printParams



bool

false

If this is true, Archiver.pl prints out a sample config file and exits.

-verificationEmail

X


you@ucar.edu

n/a

If this is defined an email will be sent to this address if their are any warnings or errors. Multiple email addresses can be specified by separating them with commas.

-verify

X


quiet,full

full

When verify is set to 'quiet' verificationEmail will only receive emails if there are warnings or errors. When set to full, you will always get an email to let you know that everything ran ok.

-doTar

X

X

bool

true

Should the files be TAR'd up before being sent to the MSS?

-doZip

X

X

bool

true

Should the files be compressed before being sent to the MSS? NOTE: Files are zipped in place, unless doStaging is also true.

-doArchive

X

X

bool

true

Should the files be sent to the Archive?

-doClean

X


bool

true

Should temporary files be deleted? note: tmp files are not deleted when an error occurs unless forceClean is also true

-forceClean

X


bool

false

Should temporary files be deleted even in the case of an error?

-doSQL

X

X

bool

true

Should meta-data be saved in the SQL database?

-tmpDir

X


string

/tmp

Where should temporary files be placed. Archiver.pl creates temporary subdirectories in the directory given.

-doTarList

X

X

bool

true

If doTarList is true a table of contents file is created from the .tar file and put on the MSS with the .tar file. If the data file is filename.tar, the TOC file will be TOC.filename.tar.txt.

-doStaging

X

X

bool

true

If this is true, files are copied to a temporary directory before being zipped, TAR'd, etc.

-mode

X

X

777

none

If a mode is given, a chmod command will change the mode on files after they are sent to the server.

-numCopies

X

X

1 or 2

1

The number of copies of the data that are stored on the HPSS

-warningLevel

X

X

float

.95

Where expectedNumFiles or expectedFileSize are defined, this gives the minimum ratio below which warnings will be given. For example with the default warningLevel an expectedNumFiles of 100, will generate a warning if there are less than 95 files. warningLevel is used strictly for determining whether warnings are generted/emailed by the PERL script, it is not used to generate the colored indicators on the website.

-comment

X

X

string

none

This is a comment for the entire run if given at the top level config, or a comment for an individual archive item if given in a archiveItem block

-skipUnderscoreFiles

X

X

bool

false

If this is true, files beginning with an underscore are not archived. NOTE: This ONLY works if you are staging or TARing your files

-forceOverwrite

X

X

bool

false

If this is true, hsi put is used instead of hsi cput.

-posixGroup

X


ralicing

""

If this is defined, files put on the HPSS will be owned by the given group.

Configuration File Options

This table specifies the options that can be included in the configuration file that control the characteristics of the archival.
Most of these options can also be specified on the command line.

...

XML Key Word

...

Example Values

...

Description

...

debug

...

true, false

...

Outputs commands before they are run, as well as basic debug info.

...

test

...

true, false

...

Commands are constructed but not actually run.

...

verbose

...

true, false

...

Outputs more debug info than debug.

...

verify

...

quiet, full

...

When verify is set to 'quiet' verificationEmail will only receive emails if there are warnings or errors. When set to full, you will always get an email to let you know that everything ran ok.

...

verificationEmail

...

you@ucar.edu

...

If this is defined an email will be sent to this address if their are any warnings or errors. Multiple email addresses can be specified by separating them with commas.

...

projectNum

...

48500052

...

The project # to charge

...

doTar

...

true, false

...

Should the files be TAR'd up before being sent to the MSS?

...

doZip

...

true, false

...

Should the files be compressed before being sent to the MSS? NOTE: Files are zipped in place, unless doStaging is also true.


...

doArchive

...

true, false

...

Archive

...

doClean

...

true, false

...

Should temporary files be deleted? _note: tmp files are not deleted when an error occurs unless forceClean is also true.

...

forceClean

...

true, false

...

Should temporary files be deleted even in the case of an error?

...

doStaging

...

true, false

...

If this is true, files are copied to a temporary directory before being zipped, TAR'd, etc.

...

doSQL

...

true, false

...

-

...

doTarList

...

true, false

...

If doTarList is true a table of contents file is created from the .tar file and put on the MSS with the .tar file. If the data file is filename.tar, the TOC file will be TOC.filename.tar.txt.

...

dateString

...

'yesterday', '-48 hours', '20070102'

...

The date/time that is used to generate year/month/day values for substituting in paths, filenames, and comments.

...

tmpDir

...

/tmp

...

Where should temporary files be placed. Archiver.pl creates temporary subdirectories in the directory given.

...

numCopies

...

1, 2

...

The number of copies of the data that are stored on the HPSS.

...

archiveRunComment

...

My comment

...

This is a comment for the entire run.

...

warningLevel

...

.95

...

Where expectedNumFiles or expectedFileSize are defined, this gives the minimum ratio below which warnings will be given. For example with the default warningLevel an expectedNumFiles of 100, will generate a warning if there are less than 95 files. warningLevel is used strictly for determining whether warnings are generted/emailed by the PERL script, it is not used to generate the colored indicators on the website.

...

skipUnderscoreFiles

...

true, false

...

If this is true, files beginning with an underscore are not archived. NOTE: This ONLY works if you are staging or TARing your files.

...

mode

...

777

...

If a mode is given, a chmod command will change the mode on files after they are sent to the server.

...

forceOverwrite

...

false

...

If this is true, hsi put is used instead of hsi cput.

Archive-Item Options

Archive Item options can only be defined in the config within <archiveItem></archiveItem> tags. These options can not be defined on the command line, or outside of
<archiveItem> tags in the config file. Within each <archiveItem></archiveItem> group, a source and destination are required. A tarFileName is required if this
archiveItem is to be TAR'd. In addition to the archiveItem only options listed below, any options from the archiveRun options above which has an X in it's archiveItem column can be overridden within the archiveItem tags. None of the options below have default values.

...