Ifdh commands » History » Version 15
Marc Mengel, 01/10/2014 03:18 PM
1 | 2 | Marc Mengel | h1. ifdh commands |
---|---|---|---|
2 | 1 | Marc Mengel | |
3 | 15 | Marc Mengel | Note that many of these commands are new in ifdh v1_3_x. |
4 | 15 | Marc Mengel | |
5 | 15 | Marc Mengel | h2. Environment variables |
6 | 15 | Marc Mengel | |
7 | 15 | Marc Mengel | * IFDH_DEBUG=1 for voluminous debug output |
8 | 15 | Marc Mengel | * EXPERIMENT set to an experiment name ("minerva", "nova", etc.) |
9 | 15 | Marc Mengel | if it can't be guessed from your group,etc. |
10 | 15 | Marc Mengel | * IFDH_BASE_URI to pick a particular samweb server. |
11 | 15 | Marc Mengel | * IFDH_GRIDFTP_EXTRA, IFDH_SRM_EXTRA, IFDH_DD_EXTRA flags to set options |
12 | 15 | Marc Mengel | flor globus-url-copy, lcg_cp, dd, etc. |
13 | 15 | Marc Mengel | * IFDH_WEB_TIMEOUT for samweb timeouts. |
14 | 15 | Marc Mengel | |
15 | 15 | Marc Mengel | h2. Commands |
16 | 9 | Marc Mengel | |
17 | 7 | Marc Mengel | * *ifdh* *cp* _src dest_ |
18 | 2 | Marc Mengel | ** general file copy using cpn or srmcp |
19 | 10 | Marc Mengel | @ifdh cp [--force=srm|gridftp|cpn|expftp] [-r] src1 dest1 [ ";" src2 ... dest2 [ ";" ... ] ]@ |
20 | 10 | Marc Mengel | @ifdh cp [--force=srm|gridftp|cpn|expftp] -f listfile@ |
21 | 10 | Marc Mengel | @ifdh cp [--force=srm|gridftp|cpn|expftp] -D [-r] src1 src2 destdir1 [ ";" src3 src4 ... destdir2 [ ";" ... ] ]@ |
22 | 10 | Marc Mengel | One can also set IFDH_FORCE= in the environment rather than using --force= |
23 | 12 | Marc Mengel | * *ifdh* *ls* _dest_ [ _depth_ [--force=srm|gridftp|cpn]] |
24 | 11 | Marc Mengel | ** list file or directory |
25 | 13 | Marc Mengel | ** also confirms existence |
26 | 11 | Marc Mengel | * *ifdh* *mkdir* _dest_ [--force=srm|gridftp|cpn] |
27 | 11 | Marc Mengel | ** make directories |
28 | 11 | Marc Mengel | * *ifdh* *rm* _dest_ [--force=srm|gridftp|cpn] |
29 | 11 | Marc Mengel | ** remove files |
30 | 11 | Marc Mengel | * *ifdh* *rmdir* _dest_ [--force=srm|gridftp|cpn] |
31 | 11 | Marc Mengel | ** remove directories |
32 | 7 | Marc Mengel | * *ifdh* *fetchInput* _src_uri_ |
33 | 2 | Marc Mengel | ** get input file to local scratch, return scratch location |
34 | 7 | Marc Mengel | * *ifdh* *addOutputFile* _filename_ |
35 | 2 | Marc Mengel | ** add output file to set |
36 | 7 | Marc Mengel | * *ifdh* *copyBackOutput* _dest_dir_ |
37 | 2 | Marc Mengel | ** copy output file set to destination with cpn or srmcp |
38 | 7 | Marc Mengel | * *ifdh* *log* _message_ |
39 | 2 | Marc Mengel | ** logging |
40 | 7 | Marc Mengel | * *ifdh* *enterState* _state_ |
41 | 2 | Marc Mengel | ** log entering/leaving states |
42 | 7 | Marc Mengel | * *ifdh* *leaveState* _state_ |
43 | 2 | Marc Mengel | ** log entering/leaving states |
44 | 7 | Marc Mengel | * *ifdh* *createDefinition* _name dims user group_ |
45 | 2 | Marc Mengel | ** make a named dataset definition from a dimension string |
46 | 7 | Marc Mengel | * *ifdh* *deleteDefinition* _name_ |
47 | 2 | Marc Mengel | ** remove data set definition |
48 | 7 | Marc Mengel | * *ifdh* *describeDefinition* _name_ |
49 | 2 | Marc Mengel | ** describe a named dataset definition |
50 | 7 | Marc Mengel | * *ifdh* *translateConstraints* _dims_ |
51 | 2 | Marc Mengel | ** give file list for dimension string |
52 | 7 | Marc Mengel | * *ifdh* *locateFile* _name_ |
53 | 2 | Marc Mengel | ** locate a file |
54 | 7 | Marc Mengel | * *ifdh* *getMetadata* _name_ |
55 | 2 | Marc Mengel | ** get a files metadata |
56 | 7 | Marc Mengel | * *ifdh* *dumpStation* _name what_ |
57 | 2 | Marc Mengel | ** give a dump of a SAM station status |
58 | 7 | Marc Mengel | * *ifdh* *startProject* _name station defname_or_id user group_ |
59 | 2 | Marc Mengel | ** start a new file delivery project |
60 | 7 | Marc Mengel | * *ifdh* *findProject* _name station_ |
61 | 2 | Marc Mengel | ** find a started project |
62 | 7 | Marc Mengel | * *ifdh* *establishProcess* _projecturi appname appversion location user appfamily description filelimit_ |
63 | 2 | Marc Mengel | ** set yourself up as a file consumer process for a project |
64 | 7 | Marc Mengel | * *ifdh* *getNextFile* _projecturi processid_ |
65 | 2 | Marc Mengel | ** get the next file location from a project |
66 | 7 | Marc Mengel | * *ifdh* *updateFileStatus* _projecturi processid filename status_ |
67 | 2 | Marc Mengel | ** update the file status (use: transferred, skipped, or consumed) |
68 | 7 | Marc Mengel | * *ifdh* *endProcess* _projecturi processid_ |
69 | 2 | Marc Mengel | ** end the process |
70 | 14 | Marc Mengel | * *ifdh* *dumpProject* _projecturi_ |
71 | 2 | Marc Mengel | ** say what the sam station knows about your process |
72 | 7 | Marc Mengel | * *ifdh* *setStatus* _projecturi processid status_ |
73 | 2 | Marc Mengel | ** set process status |
74 | 7 | Marc Mengel | * *ifdh* *endProject* _projecturi_ |
75 | 2 | Marc Mengel | ** end the project |
76 | 8 | Marc Mengel | * *ifdh* *cleanup* |
77 | 2 | Marc Mengel | ** clean up any tmp file stuff |