1just-man-pages/condor_chirp(1G)eneral Commands Manujaulst-man-pages/condor_chirp(1)
2
3
4

Name

6       condor_chirp Access files or job ClassAd from an executing job
7

Synopsis

9       condor_chirp <Chirp-Command>
10

Description

12       condor_chirp is not intended for use as a command-line tool. It is most
13       often invoked by an HTCondor  job,  while  the  job  is  executing.  It
14       accesses  files  or job ClassAd attributes on the submit machine. Files
15       can be read, written or removed. Job attributes can be read,  and  most
16       attributes can be updated.
17
18       When  invoked  by  an HTCondor job, the command-line arguments describe
19       the operation to be performed. Each of  these  arguments  is  described
20       below  within  the  section  on  Chirp Commands. Descriptions using the
21       terms local and remote are given from the point of view of the  execut‐
22       ing job.
23
24       If  the  input  file name for put or write is a dash, condor_chirp uses
25       standard input as the source. If the output file name for  fetch  is  a
26       dash, condor_chirp writes to standard output instead of a local file.
27
28       Jobs  that use condor_chirp must have the attribute  WantIOProxy set to
29       True in the job ClassAd. To do this, place
30
31       +WantIOProxy = true
32
33       in the submit description file of the job.
34
35       condor_chirp only works for jobs run in the vanilla, parallel and  java
36       universes.
37

Chirp Commands

39       fetch RemoteFileName LocalFileName
40
41          Copy  the  RemoteFileName  from  the  submit  machine to the execute
42          machine, naming it LocalFileName .
43
44
45
46       put [ -mode mode ] [ -perm UnixPerm ] LocalFileName RemoteFileName
47
48          Copy the LocalFileName  from  the  execute  machine  to  the  submit
49          machine,  naming  it  RemoteFileName  .  The optional -perm UnixPerm
50          argument describes the file access permissions in a Unix format; 660
51          is an example Unix format.
52
53          The  optional  -mode  mode  argument is one or more of the following
54          characters describing the RemoteFileName file:  w , open  for  writ‐
55          ing;  a , force all writes to append;  t , truncate before use;  c ,
56          create the file, if it does not exist;  x , fail if  c is given  and
57          the file already exists.
58
59
60
61       remove RemoteFileName
62
63          Remove the RemoteFileName file from the submit machine.
64
65
66
67       get_job_attr JobAttributeName
68
69          Prints the named job ClassAd attribute to standard output.
70
71
72
73       set_job_attr JobAttributeName AttributeValue
74
75          Sets the named job ClassAd attribute with the given attribute value.
76
77
78
79       get_job_attr_delayed JobAttributeName
80
81          Prints  the  named  job ClassAd attribute to standard output, poten‐
82          tially reading the cached value from a recent set_job_attr_delayed.
83
84
85
86       set_job_attr_delayed JobAttributeName AttributeValue
87
88          Sets the named job ClassAd attribute with the given attribute value,
89          but does not immediately synchronize the value with the submit side.
90          It can take 15 minutes before the synchronization occurs.  This  has
91          much  less  overhead than the non delayed version. With this option,
92          jobs do not need  ClassAd  attribute   WantIOProxy  set.  With  this
93          option,  job  attribute  names are restricted to begin with the case
94          sensitive substring  Chirp .
95
96
97
98       ulog Message
99
100          Appends Message to the job event log.
101
102
103
104       read [ -offset offset ] [ -stride length skip ] RemoteFileName Length
105
106          Read Length bytes from  RemoteFileName  .  Optionally,  implement  a
107          stride  by starting the read at offset and reading length bytes with
108          a stride of skip bytes.
109
110
111
112       write [ -offset offset ] [ -stride length skip ] RemoteFileName  Local‐
113       FileName [ numbytes ]
114
115          Write  the contents of LocalFileName to RemoteFileName . Optionally,
116          start writing to the remote file at offset and  write  length  bytes
117          with a stride of skip bytes. If the optional numbytes follows Local‐
118          FileName , then the write will halt after numbytes input bytes  have
119          been  written.  Otherwise, the entire contents of LocalFileName will
120          be written.
121
122
123
124       rmdir [ -r ] RemotePath
125
126          Delete the directory specified by RemotePath . If the optional -r is
127          specified, recursively delete the entire directory.
128
129
130
131       getdir [ -l ] RemotePath
132
133          List  the  contents of the directory specified by RemotePath . If -l
134          is specified, list all metadata as well.
135
136
137
138       whoami
139
140          Get the user's current identity.
141
142
143
144       whoareyou RemoteHost
145
146          Get the identity of RemoteHost .
147
148
149
150       link [ -s ] OldRemotePath NewRemotePath
151
152          Create a hard link from OldRemotePath  to  NewRemotePath  .  If  the
153          optional -s is specified, create a symbolic link instead.
154
155
156
157       readlink RemoteFileName
158
159          Read  the  contents of the file defined by the symbolic link Remote‐
160          FileName .
161
162
163
164       stat RemotePath
165
166          Get metadata for RemotePath . Examines the target, if it is  a  sym‐
167          bolic link.
168
169
170
171       lstat RemotePath
172
173          Get metadata for RemotePath . Examines the file, if it is a symbolic
174          link.
175
176
177
178       statfs RemotePath
179
180          Get file system metadata for RemotePath .
181
182
183
184       access RemotePath Mode
185
186          Check access permissions for RemotePath .  Mode is one  or  more  of
187          the characters  r ,  w ,  x , or  f , representing read, write, exe‐
188          cute, and existence, respectively.
189
190
191
192       chmod RemotePath UnixPerm
193
194          Change  the  permissions  of  RemotePath  to  UnixPerm  .   UnixPerm
195          describes  the  file  access permissions in a Unix format; 660 is an
196          example Unix format.
197
198
199
200       chown RemotePath UID GID
201
202          Change the ownership of RemotePath to UID and GID . Changes the tar‐
203          get of RemotePath , if it is a symbolic link.
204
205
206
207       chown RemotePath UID GID
208
209          Change  the  ownership  of  RemotePath  to UID and GID . Changes the
210          link, if RemotePath is a symbolic link.
211
212
213
214       truncate RemoteFileName Length
215
216          Truncates RemoteFileName to Length bytes.
217
218
219
220       utime RemotePath AccessTime ModifyTime
221
222          Change the access to AccessTime and modification time to  ModifyTime
223          of RemotePath .
224
225
226

Examples

228       To copy a file from the submit machine to the execute machine while the
229       user job is running, run
230
231         condor_chirp fetch remotefile localfile
232
233       To print to standard output the value of the   Requirements  expression
234       from within a running job, run
235
236         condor_chirp get_job_attr Requirements
237
238       Note  that  the  remote (submit-side) directory path is relative to the
239       submit directory, and the local (execute-side) directory is relative to
240       the current directory of the running program.
241
242       To  append  the  word  "foo" to a file called  RemoteFile on the submit
243       machine, run
244
245         echo foo | condor_chirp put -mode wa - RemoteFile
246
247       To append the message "Hello World" to the job event log, run
248
249         condor_chirp ulog "Hello World"
250

Exit Status

252       condor_chirp will exit with a status value of 0  (zero)  upon  success,
253       and it will exit with the value 1 (one) upon failure.
254

Author

256       Center for High Throughput Computing, University of Wisconsin-Madison
257

Copyright

259       Copyright  (C) 1990-2018 Center for High Throughput Computing, Computer
260       Sciences Department, University of Wisconsin-Madison, Madison, WI.  All
261       Rights Reserved. Licensed under the Apache License, Version 2.0.
262
263
264
265                                     date       just-man-pages/condor_chirp(1)