/usr/share/doc/condor/html/condor

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<!--Converted with LaTeX2HTML 2008 (1.71)
original version by:  Nikos Drakos, CBLU, University of Leeds
* revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<link rel="canonical" href="http://research.cs.wisc.edu/condor/manual/current/condor_chirp.html">

<TITLE>condor_chirp</TITLE>
<META NAME="description" CONTENT="condor_chirp">
<META NAME="keywords" CONTENT="ref">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">

<META NAME="Generator" CONTENT="LaTeX2HTML v2008">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">

<LINK REL="STYLESHEET" HREF="ref.css">

<LINK REL="next" HREF="condor_cod.html">
<LINK REL="previous" HREF="condor_checkpoint.html">
<LINK REL="up" HREF="10_Command_Reference.html">
<LINK REL="next" HREF="condor_cod.html">
</HEAD>

<BODY  BGCOLOR=#FFFFFF >

<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html3236"
  HREF="condor_cod.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
<A NAME="tex2html3230"
  HREF="10_Command_Reference.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
<A NAME="tex2html3224"
  HREF="condor_checkpoint.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
<A NAME="tex2html3232"
  HREF="Contents.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> 
<A NAME="tex2html3234"
  HREF="Index.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
<BR>
<B> Next:</B> <A NAME="tex2html3237"
  HREF="condor_cod.html">condor_cod</A>
<B> Up:</B> <A NAME="tex2html3231"
  HREF="10_Command_Reference.html">10. Command Reference Manual</A>
<B> Previous:</B> <A NAME="tex2html3225"
  HREF="condor_checkpoint.html">condor_checkpoint</A>
 &nbsp; <B>  <A NAME="tex2html3233"
  HREF="Contents.html">Contents</A></B> 
 &nbsp; <B>  <A NAME="tex2html3235"
  HREF="Index.html">Index</A></B> 
<BR>
<BR></DIV>
<!--End of Navigation Panel-->
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>

<UL CLASS="ChildLinks">
<LI><A NAME="tex2html3238"
  HREF="condor_chirp.html#SECTION001151000000000000000">Synopsis</A>
<LI><A NAME="tex2html3239"
  HREF="condor_chirp.html#SECTION001152000000000000000">Description</A>
<LI><A NAME="tex2html3240"
  HREF="condor_chirp.html#SECTION001153000000000000000">Chirp Commands</A>
<LI><A NAME="tex2html3241"
  HREF="condor_chirp.html#SECTION001154000000000000000">Examples</A>
<LI><A NAME="tex2html3242"
  HREF="condor_chirp.html#SECTION001155000000000000000">Exit Status</A>
<LI><A NAME="tex2html3243"
  HREF="condor_chirp.html#SECTION001156000000000000000">Author</A>
<LI><A NAME="tex2html3244"
  HREF="condor_chirp.html#SECTION001157000000000000000">Copyright</A>
</UL>
<!--End of Table of Child-Links-->
<HR>

<H1><A NAME="SECTION001150000000000000000"></A><A NAME="man-condor-chirp"></A>
<BR>
<SPAN  CLASS="textit">condor_chirp</SPAN>
</H1> Access files or job ClassAd from an executing job
  
<P>

<H2><A NAME="SECTION001151000000000000000">
Synopsis</A>
</H2>
<SPAN  CLASS="textbf"><SPAN  CLASS="textit">condor_chirp</SPAN></SPAN>
<SPAN  CLASS="textbf">&lt;Chirp-Command&gt;</SPAN>

<P>

<H2><A NAME="SECTION001152000000000000000"></A>
<A NAME="59305"></A>
<A NAME="59306"></A>
<BR>
Description
</H2>
<SPAN  CLASS="textit">condor_chirp</SPAN> is not a command-line tool.
<SPAN  CLASS="textit">condor_chirp</SPAN> is invoked by a Condor job, while the job is executing.
It accesses files or job ClassAd attributes on the submit machine.
Files can be read, written or removed.
Job attributes can be read, and most attributes can be updated.

<P>
When invoked by a Condor job,
the command-line arguments describe the operation to be performed. 
Each of these arguments is described below within the section
on Chirp Commands.
Descriptions using the terms <SPAN  CLASS="textit">local</SPAN> and <SPAN  CLASS="textit">remote</SPAN>
are given from the point of view of the executing job.

<P>
If the input file name for <SPAN  CLASS="textbf">put</SPAN> or <SPAN  CLASS="textbf">write</SPAN> is a dash,
<SPAN  CLASS="textit">condor_chirp</SPAN> uses standard input as the source.
If the output file name for <SPAN  CLASS="textbf">fetch</SPAN> is a dash,
<SPAN  CLASS="textit">condor_chirp</SPAN> writes to standard output instead of a local file.

<P>
Jobs that use <SPAN  CLASS="textit">condor_chirp</SPAN> must have the attribute
<TT>WantIOProxy</TT> set to <TT>True</TT> in the job ClassAd.
To do this, place
<PRE>
+WantIOProxy = true
</PRE>
in the submit description file of the job.

<P>
<SPAN  CLASS="textit">condor_chirp</SPAN> only works for jobs run in the
vanilla, parallel and java universes.

<P>

<H2><A NAME="SECTION001153000000000000000">
Chirp Commands</A>
</H2>
<DL>
<DT><STRONG><SPAN  CLASS="textbf">fetch </SPAN><SPAN  CLASS="textit">RemoteFileName LocalFileName</SPAN></STRONG></DT>
<DD>Copy the <SPAN  CLASS="textit">RemoteFileName</SPAN> from the submit machine
    to the execute machine, naming it <SPAN  CLASS="textit">LocalFileName</SPAN>.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">put</SPAN> [<SPAN  CLASS="textbf">-mode  </SPAN><SPAN  CLASS="textit">mode</SPAN>] [<SPAN  CLASS="textbf">-perm  </SPAN><SPAN  CLASS="textit">UnixPerm</SPAN>] <SPAN  CLASS="textit">LocalFileName</SPAN> <SPAN  CLASS="textit">RemoteFileName</SPAN></STRONG></DT>
<DD>Copy the <SPAN  CLASS="textit">LocalFileName</SPAN> from the execute machine
    to the submit machine, naming it <SPAN  CLASS="textit">RemoteFileName</SPAN>.
    The optional <SPAN  CLASS="textbf">-perm </SPAN><SPAN  CLASS="textit">UnixPerm</SPAN> argument describes the file access
    permissions in a Unix format; 660 is an example Unix format.

<P>
The optional <SPAN  CLASS="textbf">-mode </SPAN><SPAN  CLASS="textit">mode</SPAN> argument is one or more of 
    the following characters describing the <SPAN  CLASS="textit">RemoteFileName</SPAN> file:
      <TT>w</TT>,  open for writing;
      <TT>a</TT>,  force all writes to append;
      <TT>t</TT>,  truncate before use;
      <TT>c</TT>,  create the file, if it does not exist;
      <TT>x</TT>,  fail if <TT>c</TT> is given and the file already exists.
    
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">remove </SPAN><SPAN  CLASS="textit">RemoteFileName</SPAN></STRONG></DT>
<DD>Remove the <SPAN  CLASS="textit">RemoteFileName</SPAN> file from the submit machine.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">get_job_attr </SPAN><SPAN  CLASS="textit">JobAttributeName</SPAN></STRONG></DT>
<DD>Prints the named job ClassAd attribute to standard output.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">set_job_attr </SPAN><SPAN  CLASS="textit">JobAttributeName AttributeValue</SPAN></STRONG></DT>
<DD>Sets the named job ClassAd attribute with the given attribute value.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">ulog </SPAN><SPAN  CLASS="textit">Message</SPAN></STRONG></DT>
<DD>Appends <SPAN  CLASS="textit">Message</SPAN> to the job's user log.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">read</SPAN> [<SPAN  CLASS="textbf">-offset  </SPAN><SPAN  CLASS="textit">offset</SPAN>] [<SPAN  CLASS="textbf">-stride  </SPAN><SPAN  CLASS="textit">length skip</SPAN>] <SPAN  CLASS="textit">RemoteFileName</SPAN> <SPAN  CLASS="textit">Length</SPAN></STRONG></DT>
<DD>Read <SPAN  CLASS="textit">Length</SPAN> bytes from <SPAN  CLASS="textit">RemoteFileName</SPAN>. Optionally,
    implement a stride by
    starting the read at <SPAN  CLASS="textit">offset</SPAN> and reading <SPAN  CLASS="textit">length</SPAN> bytes
    with a stride of <SPAN  CLASS="textit">skip</SPAN> bytes.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">write</SPAN> [<SPAN  CLASS="textbf">-offset  </SPAN><SPAN  CLASS="textit">offset</SPAN>] [<SPAN  CLASS="textbf">-stride  </SPAN><SPAN  CLASS="textit">length skip</SPAN>] <SPAN  CLASS="textit">RemoteFileName</SPAN> <SPAN  CLASS="textit">LocalFileName</SPAN></STRONG></DT>
<DD>Write the contents of <SPAN  CLASS="textit">LocalFileName</SPAN> to <SPAN  CLASS="textit">RemoteFileName</SPAN>.
    Optionally, start writing to the remote file at <SPAN  CLASS="textit">offset</SPAN> and write
	<SPAN  CLASS="textit">length</SPAN> bytes with a stride of <SPAN  CLASS="textit">skip</SPAN> bytes.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">rmdir</SPAN> [<SPAN  CLASS="textbf">-r</SPAN>] <SPAN  CLASS="textit">RemotePath</SPAN></STRONG></DT>
<DD>Delete the directory specified by <SPAN  CLASS="textit">RemotePath</SPAN>. 
    If the optional <SPAN  CLASS="textbf">-r</SPAN> is specified, 
    recursively delete the entire directory.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">getdir</SPAN> [<SPAN  CLASS="textbf">-l</SPAN>] <SPAN  CLASS="textit">RemotePath</SPAN></STRONG></DT>
<DD>List the contents of the directory specified by <SPAN  CLASS="textit">RemotePath</SPAN>. 
    If <SPAN  CLASS="textit">-l</SPAN> is specified, list all metadata as well.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">whoami</SPAN></STRONG></DT>
<DD>Get the user's current identity.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">whoareyou </SPAN><SPAN  CLASS="textit">RemoteHost</SPAN></STRONG></DT>
<DD>Get the identity of <SPAN  CLASS="textit">RemoteHost</SPAN>.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">link</SPAN> [<SPAN  CLASS="textbf">-s</SPAN>] <SPAN  CLASS="textit">OldRemotePath</SPAN> <SPAN  CLASS="textit">NewRemotePath</SPAN></STRONG></DT>
<DD>Create a hard link from <SPAN  CLASS="textit">OldRemotePath</SPAN> to <SPAN  CLASS="textit">NewRemotePath</SPAN>. 
    If the optional <SPAN  CLASS="textit">-s</SPAN> is specified, create a symbolic link instead.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">readlink </SPAN><SPAN  CLASS="textit">RemoteFileName</SPAN></STRONG></DT>
<DD>Read the contents of the file defined by the symbolic link 
    <SPAN  CLASS="textit">RemoteFileName</SPAN>.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">stat </SPAN><SPAN  CLASS="textit">RemotePath</SPAN></STRONG></DT>
<DD>Get metadata for <SPAN  CLASS="textit">RemotePath</SPAN>. Examines the target, 
    if it is a symbolic link.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">lstat </SPAN><SPAN  CLASS="textit">RemotePath</SPAN></STRONG></DT>
<DD>Get metadata for <SPAN  CLASS="textit">RemotePath</SPAN>. Examines the file,
    if it is a symbolic link.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">statfs </SPAN><SPAN  CLASS="textit">RemotePath</SPAN></STRONG></DT>
<DD>Get file system metadata for <SPAN  CLASS="textit">RemotePath</SPAN>.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">access </SPAN><SPAN  CLASS="textit">RemotePath Mode</SPAN></STRONG></DT>
<DD>Check access permissions for <SPAN  CLASS="textit">RemotePath</SPAN>. 
    <SPAN  CLASS="textit">Mode</SPAN> is one or more of the characters <TT>r</TT>, <TT>w</TT>, 
    <TT>x</TT>, or <TT>f</TT>, representing read, write, execute, and 
    existence, respectively.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">chmod </SPAN><SPAN  CLASS="textit">RemotePath UnixPerm</SPAN></STRONG></DT>
<DD>Change the permissions of <SPAN  CLASS="textit">RemotePath</SPAN> to <SPAN  CLASS="textit">UnixPerm</SPAN>.
    <SPAN  CLASS="textit">UnixPerm</SPAN> describes the file access permissions in a Unix format;
    660 is an example Unix format. 
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">chown </SPAN><SPAN  CLASS="textit">RemotePath UID GID</SPAN></STRONG></DT>
<DD>Change the ownership of <SPAN  CLASS="textit">RemotePath</SPAN> to <SPAN  CLASS="textit">UID</SPAN> and <SPAN  CLASS="textit">GID</SPAN>.
    Changes the target of <SPAN  CLASS="textit">RemotePath</SPAN>, if it is a symbolic link.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">chown </SPAN><SPAN  CLASS="textit">RemotePath UID GID</SPAN></STRONG></DT>
<DD>Change the ownership of <SPAN  CLASS="textit">RemotePath</SPAN> to <SPAN  CLASS="textit">UID</SPAN> and <SPAN  CLASS="textit">GID</SPAN>.
    Changes the link, if <SPAN  CLASS="textit">RemotePath</SPAN> is a symbolic link.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">truncate </SPAN><SPAN  CLASS="textit">RemoteFileName Length</SPAN></STRONG></DT>
<DD>Truncates <SPAN  CLASS="textit">RemoteFileName</SPAN> to <SPAN  CLASS="textit">Length</SPAN> bytes.
<BR>  
</DD>
<DT><STRONG><SPAN  CLASS="textbf">utime </SPAN><SPAN  CLASS="textit">RemotePath AccessTime ModifyTime</SPAN></STRONG></DT>
<DD>Change the access to <SPAN  CLASS="textit">AccessTime</SPAN> and modification time
    to <SPAN  CLASS="textit">ModifyTime</SPAN> of <SPAN  CLASS="textit">RemotePath</SPAN>.
<BR></DD>
</DL>

<P>

<H2><A NAME="SECTION001154000000000000000">
Examples</A>
</H2>

<P>
To copy a file from the submit machine to the execute machine while the 
user job is running, run

<P>
<PRE>
  condor_chirp fetch remotefile localfile
</PRE>
<P>
To print to standard output the value of the <TT>Requirements</TT>
expression from within a running job, run

<P>
<PRE>
  condor_chirp get_job_attr Requirements
</PRE>
<P>
Note that the remote (submit-side) directory path is relative to the
submit directory, and the local (execute-side) directory is relative to the
current directory of the running program.

<P>
To append the word "foo" to a file called <TT>RemoteFile</TT> 
on the submit machine, run

<P>
<PRE>
  echo foo | condor_chirp put -mode wa - RemoteFile
</PRE>
<P>
To append the message "Hello World" to the user log, run

<P>
<PRE>
  condor_chirp ulog "Hello World"
</PRE>
<P>

<H2><A NAME="SECTION001155000000000000000">
Exit Status</A>
</H2>

<P>
<SPAN  CLASS="textit">condor_chirp</SPAN> will exit with a status value of 0 (zero) upon success,
and it will exit with the value 1 (one) upon failure.

<P>

<H2><A NAME="SECTION001156000000000000000">
Author</A>
</H2> Condor Team, University of Wisconsin-Madison
  
<H2><A NAME="SECTION001157000000000000000">
Copyright</A>
</H2> 
  Copyright &#169; 1990-2012 Condor Team, Computer Sciences Department, 
  University of Wisconsin-Madison, Madison, WI.  All Rights Reserved.  
	Licensed under the Apache License, Version 2.0.

<P>
See the <SPAN  CLASS="textit">Condor Version 7.8.2 Manual</SPAN> or
	<A NAME="tex2html365"
  HREF="http://www.condorproject.org/license">http://www.condorproject.org/license</A>
for
  additional notices. 


<DIV CLASS="navigation"><HR>
<!--Navigation Panel-->
<A NAME="tex2html3236"
  HREF="condor_cod.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
<A NAME="tex2html3230"
  HREF="10_Command_Reference.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
<A NAME="tex2html3224"
  HREF="condor_checkpoint.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
<A NAME="tex2html3232"
  HREF="Contents.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> 
<A NAME="tex2html3234"
  HREF="Index.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
<BR>
<B> Next:</B> <A NAME="tex2html3237"
  HREF="condor_cod.html">condor_cod</A>
<B> Up:</B> <A NAME="tex2html3231"
  HREF="10_Command_Reference.html">10. Command Reference Manual</A>
<B> Previous:</B> <A NAME="tex2html3225"
  HREF="condor_checkpoint.html">condor_checkpoint</A>
 &nbsp; <B>  <A NAME="tex2html3233"
  HREF="Contents.html">Contents</A></B> 
 &nbsp; <B>  <A NAME="tex2html3235"
  HREF="Index.html">Index</A></B> </DIV>
<!--End of Navigation Panel-->
<ADDRESS>
condor-admin@cs.wisc.edu
</ADDRESS>
</BODY>
</HTML>
condor-doc 7.8.2~dfsg.1-1+deb7u3 / usr / share / doc / condor / html / condor_chirp.html
