uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-cancel.tex

% 
% Licensed to the Apache Software Foundation (ASF) under one
% or more contributor license agreements.  See the NOTICE file
% distributed with this work for additional information
% regarding copyright ownership.  The ASF licenses this file
% to you under the Apache License, Version 2.0 (the
% "License"); you may not use this file except in compliance
% with the License.  You may obtain a copy of the License at
% 
%   http://www.apache.org/licenses/LICENSE-2.0
% 
% Unless required by applicable law or agreed to in writing,
% software distributed under the License is distributed on an
% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
% KIND, either express or implied.  See the License for the
% specific language governing permissions and limitations
% under the License.
% 
% Create well-known link to this spot for HTML version
\ifpdf
\else
\HCode{<a name='DUCC_CLI_CANCEL'></a>}
\fi
    \section{ducc\_cancel}
    \label{sec:cli.ducc-cancel}

    \paragraph{Description:}
    The cancel CLI is used to cancel a job that has previously been submitted but which has not yet 
    completed. 

    \paragraph{Usage:}
    \begin{description}
    \item[Script wrapper] \ducchome/bin/ducc\_cancel {\em options}
    \item[Java Main]      java -cp \ducchome/lib/uima-ducc-cli.jar org.apache.uima.ducc.cli.DuccJobCancel {\em options}
    \end{description}

    \paragraph{Options:}
    \begin{description}
        \item[$--$debug ]          
          Prints internal debugging information, intended for DUCC developers or extended problem determination.                    
        \item[$--$id {[jobid]}]
          The ID is the id of the job to cancel. (Required)
        \item[$--$reason {[quoted string]}]
          Optional. This specifies the reason the job is canceled for display in the web server. Note that
          the shell requires a quoted string.  Example:
\begin{verbatim}
ducc_cancel --id 12 --reason "This is a pretty good reason."
\end{verbatim}
        \item[$--$dpid {[pid]}]
          If specified only this DUCC process will be canceled.  If not
          specified, then entire job will be canceled.  The {\em pid} is the DUCC-assigned process ID of the
          process to cancel.  This is the ID in the first column of the Web Server's job details page, under
          the column labeled ``Id''.
        \item[$--$help]
          Prints the usage text to the console. 
        \item[$--$role\_administrator] The command is being issued in the role of a DUCC administrator.
          If the user is not also a registered administrator this flag is ignored.  (This helps to
          protect administrators from accidentally canceling jobs they do not own.)
     \end{description}
        
    \paragraph{Notes:}
    None.