1condor_chirp(1) General Commands Manual condor_chirp(1)
2
6 condor_chirpAccess files or job ClassAd from an executing job
7
9 condor_chirp<Chirp-Command>
10
12 condor_chirpis 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 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 localand remoteare given from the point of view of the executing
22 job.
23 If the input file name for putor writeis a dash, condor_chirpuses stan‐
25 dard input as the source. If the output file name for fetchis a dash,
26 condor_chirpwrites to standard output instead of a local file.
27 Jobs that use condor_chirpmust have the attribute WantIOProxyset to
29 Truein the job ClassAd. To do this, place
30 +WantIOProxy = true
32 in the submit description file of the job.
34 condor_chirponly works for jobs run in the vanilla, parallel and java
36 universes.
37
39 fetch RemoteFileName LocalFileName
40 Copy the RemoteFileNamefrom the submit machine to the execute
42 machine, naming it LocalFileName.
43 put[-mode mode] [-perm UnixPerm] LocalFileNameRemoteFileName
47 Copy the LocalFileNamefrom the execute machine to the submit
49 machine, naming it RemoteFileName. The optional -perm UnixPermargu‐
50 ment describes the file access permissions in a Unix format; 660 is
51 an example Unix format.
52 The optional -mode modeargument is one or more of the following
54 characters describing the RemoteFileNamefile: w, open for writing;
55 a, force all writes to append; t, truncate before use; c, create the
56 file, if it does not exist; x, fail if cis given and the file
57 already exists.
58 remove RemoteFileName
62 Remove the RemoteFileNamefile from the submit machine.
64 get_job_attr JobAttributeName
68 Prints the named job ClassAd attribute to standard output.
70 set_job_attr JobAttributeName AttributeValue
74 Sets the named job ClassAd attribute with the given attribute value.
76 get_job_attr_delayed JobAttributeName
80 Prints the named job ClassAd attribute to standard output, poten‐
82 tially reading the cached value from a recent set_job_attr_delayed.
83 set_job_attr_delayed JobAttributeName AttributeValue
87 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 notneed ClassAd attribute WantIOProxyset. With this option,
93 job attribute names are restricted to begin with the case sensitive
94 substring Chirp.
95 ulog Message
99 Appends Messageto the job event log.
101 read[-offset offset] [-stride length skip] RemoteFileNameLength
105 Read Lengthbytes from RemoteFileName. Optionally, implement a stride
107 by starting the read at offsetand reading lengthbytes with a stride
108 of skipbytes.
109 write[-offset offset] [-stride length skip] RemoteFileNameLocalFile‐
113 Name[numbytes]
114 Write the contents of LocalFileNameto RemoteFileName. Optionally,
116 start writing to the remote file at offsetand write lengthbytes with
117 a stride of skipbytes. If the optional numbytesfollows LocalFile‐
118 Name, then the write will halt after numbytesinput bytes have been
119 written. Otherwise, the entire contents of LocalFileNamewill be
120 written.
121 rmdir[-r] RemotePath
125 Delete the directory specified by RemotePath. If the optional -ris
127 specified, recursively delete the entire directory.
128 getdir[-l] RemotePath
132 List the contents of the directory specified by RemotePath. If -lis
134 specified, list all metadata as well.
135 whoami
139 Get the user's current identity.
141 whoareyou RemoteHost
145 Get the identity of RemoteHost.
147 link[-s] OldRemotePathNewRemotePath
151 Create a hard link from OldRemotePathto NewRemotePath. If the
153 optional -sis specified, create a symbolic link instead.
154 readlink RemoteFileName
158 Read the contents of the file defined by the symbolic link Remote‐
160 FileName.
161 stat RemotePath
165 Get metadata for RemotePath. Examines the target, if it is a sym‐
167 bolic link.
168 lstat RemotePath
172 Get metadata for RemotePath. Examines the file, if it is a symbolic
174 link.
175 statfs RemotePath
179 Get file system metadata for RemotePath.
181 access RemotePath Mode
185 Check access permissions for RemotePath. Modeis one or more of the
187 characters r, w, x, or f, representing read, write, execute, and
188 existence, respectively.
189 chmod RemotePath UnixPerm
193 Change the permissions of RemotePathto UnixPerm. UnixPermdescribes
195 the file access permissions in a Unix format; 660 is an example Unix
196 format.
197 chown RemotePath UID GID
201 Change the ownership of RemotePathto UIDand GID. Changes the target
203 of RemotePath, if it is a symbolic link.
204 chown RemotePath UID GID
208 Change the ownership of RemotePathto UIDand GID. Changes the link,
210 if RemotePathis a symbolic link.
211 truncate RemoteFileName Length
215 Truncates RemoteFileNameto Lengthbytes.
217 utime RemotePath AccessTime ModifyTime
221 Change the access to AccessTimeand modification time to ModifyTimeof
223 RemotePath.
224
228 To copy a file from the submit machine to the execute machine while the
229 user job is running, run
230 condor_chirp fetch remotefile localfile
232 To print to standard output the value of the Requirementsexpression
234 from within a running job, run
235 condor_chirp get_job_attr Requirements
237 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 To append the word "foo" to a file called RemoteFileon the submit
243 machine, run
244 echo foo | condor_chirp put -mode wa - RemoteFile
246 To append the message "Hello World" to the job event log, run
248 condor_chirp ulog "Hello World"
250
252 condor_chirpwill exit with a status value of 0 (zero) upon success, and
253 it will exit with the value 1 (one) upon failure.
254
256 Center for High Throughput Computing, University of Wisconsin-Madison
257
259 Copyright (C) 1990-2019 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 date condor_chirp(1)