Project

General

Profile

Ifdh commands » History » Version 10

Marc Mengel, 01/17/2013 10:19 AM

1 2 Marc Mengel
h1. ifdh commands
2 1 Marc Mengel
3 9 Marc Mengel
Note that many of these commands rely on the environment variable
4 9 Marc Mengel
IFDH_BASE_URI being set, i.e. 
5 9 Marc Mengel
 export IFDH_BASE_URI="http://samweb-minerva.fnal.gov:20004/sam/minerva/api"
6 9 Marc Mengel
7 7 Marc Mengel
* *ifdh* *cp* _src  dest_
8 2 Marc Mengel
** general file copy using cpn or srmcp
9 10 Marc Mengel
@ifdh cp [--force=srm|gridftp|cpn|expftp] [-r]  src1 dest1 [ ";" src2 ...  dest2 [ ";" ... ]  ]@
10 10 Marc Mengel
@ifdh cp [--force=srm|gridftp|cpn|expftp] -f listfile@
11 10 Marc Mengel
@ifdh cp [--force=srm|gridftp|cpn|expftp] -D [-r]  src1 src2 destdir1 [ ";" src3 src4 ...  destdir2 [ ";" ... ]  ]@
12 10 Marc Mengel
One can also set IFDH_FORCE= in the environment rather than using --force=
13 7 Marc Mengel
* *ifdh* *fetchInput* _src_uri_
14 2 Marc Mengel
** get input file to local scratch, return scratch location
15 7 Marc Mengel
* *ifdh* *addOutputFile* _filename_
16 2 Marc Mengel
** add output file to set
17 7 Marc Mengel
* *ifdh* *copyBackOutput* _dest_dir_
18 2 Marc Mengel
** copy output file set to destination with cpn or srmcp
19 7 Marc Mengel
* *ifdh* *log* _message_
20 2 Marc Mengel
** logging 
21 7 Marc Mengel
* *ifdh* *enterState* _state_
22 2 Marc Mengel
** log entering/leaving states
23 7 Marc Mengel
* *ifdh* *leaveState* _state_
24 2 Marc Mengel
** log entering/leaving states
25 7 Marc Mengel
* *ifdh* *createDefinition* _name  dims  user  group_
26 2 Marc Mengel
** make a named dataset definition from a dimension string
27 7 Marc Mengel
* *ifdh* *deleteDefinition* _name_
28 2 Marc Mengel
** remove data set definition
29 7 Marc Mengel
* *ifdh* *describeDefinition* _name_
30 2 Marc Mengel
** describe a named dataset definition
31 7 Marc Mengel
* *ifdh* *translateConstraints* _dims_
32 2 Marc Mengel
** give file list for dimension string
33 7 Marc Mengel
* *ifdh* *locateFile* _name_
34 2 Marc Mengel
** locate a file
35 7 Marc Mengel
* *ifdh* *getMetadata* _name_
36 2 Marc Mengel
** get a files metadata
37 7 Marc Mengel
* *ifdh* *dumpStation* _name  what_
38 2 Marc Mengel
** give a dump of a SAM station status
39 7 Marc Mengel
* *ifdh* *startProject* _name  station  defname_or_id  user  group_
40 2 Marc Mengel
** start a new file delivery project
41 7 Marc Mengel
* *ifdh* *findProject* _name  station_
42 2 Marc Mengel
** find a started project
43 7 Marc Mengel
* *ifdh* *establishProcess* _projecturi  appname  appversion  location  user  appfamily   description   filelimit_
44 2 Marc Mengel
** set yourself up as a file consumer process for a project
45 7 Marc Mengel
* *ifdh* *getNextFile* _projecturi  processid_
46 2 Marc Mengel
** get the next file location from a project
47 7 Marc Mengel
* *ifdh* *updateFileStatus* _projecturi  processid  filename  status_
48 2 Marc Mengel
** update the file status (use: transferred, skipped, or consumed)
49 7 Marc Mengel
* *ifdh* *endProcess* _projecturi  processid_
50 2 Marc Mengel
** end the process
51 7 Marc Mengel
* *ifdh* *dumpProcess* _projecturi  processid_
52 2 Marc Mengel
** say what the sam station knows about your process
53 7 Marc Mengel
* *ifdh* *setStatus* _projecturi  processid  status_
54 2 Marc Mengel
** set process status
55 7 Marc Mengel
* *ifdh* *endProject* _projecturi_
56 2 Marc Mengel
** end the project
57 8 Marc Mengel
* *ifdh* *cleanup*
58 2 Marc Mengel
** clean up any tmp file stuff