.TH "sge_submit_workers" 1 "" "CCTools 7.0.9 FINAL" "Cooperative Computing Tools"
.SH NAME
.LP
\fBsge_submit_workers\fP - submit work_queue_worker to a SUN Grid Engine (SGE).

.SH SYNOPSIS
.LP
.fam C
.nf
.nh
.IP "" 8
\FC\fBsge_submit_workers [options] <servername> <port> <num-workers>\fP\FT
.fi
.hy
.fam
.P

when auto mode is not enabled for the worker, or

.fam C
.nf
.nh
.IP "" 8
\FC\fBsge_submit_workers [options] <num-workers>\fP\FT
.fi
.hy
.fam
.P

when auto mode is enabled for the worker.

.SH DESCRIPTION
.LP
\FCsge_submit_workers\FT schedules the execution of \fBwork_queue_worker(1)\fP
on the SUN Grid Engine (SGE) through its job submission interface, qsub.
The number of \fBwork_queue_worker\fP scheduled and run is given by the \fBnum-workers\fP
argument.

The \fBservername\fP and \fBport\fP arguments specify the hostname and port number of the
master for the work_queue_worker to connect. These two arguments become optional when the
auto mode option is specified for work_queue_worker.

.SH OPTIONS
.LP
.LP
.TP
\fB-M\fP, \fB-\-master-name\fP=\fI<name>\fP
.
Name of the preferred master for worker. (auto mode enabled)
.TP
\fB-N\fP, \fB-\-name\fP=\fI<name>\fP
.
Preferred project name for work_queue_worker to connect. (auto mode enabled)
.TP
\fB-C\fP, \fB-\-catalog\fP=\fI<catalog>\fP
.
Set catalog server for work_queue_worker to <catalog>. <catalog> format: HOSTNAME:PORT.
.TP
\fB-t\fP, \fB-\-timeout\fP=\fI<seconds>\fP
.
Abort work_queue_worker after this amount of idle time (default=900s).
.TP
\fB-d\fP, \fB-\-debug\fP=\fI<subsystem>\fP
.
Enable debugging on worker for this subsystem (try -d all to start).
.TP
\fB-w\fP, \fB-\-tcp-window-size\fP=\fI<size>\fP
.
Set TCP window size
.TP
\fB-i\fP, \fB-\-min-backoff\fP=\fI<time>\fP
.
Set initial value for backoff interval when worker fails to connect to a master. (default=1s)
.TP
\fB-b\fP, \fB-\-max-backoff\fP=\fI<time>\fP
.
Set maxmimum value for backoff interval when worker fails to connect to a master. (default=60s)
.TP
\fB-z\fP, \fB-\-disk-threshold\fP=\fI<size>\fP
.
Set available disk space threshold (in MB). When exceeded worker will clean up and reconnect. (default=100MB)
.TP
\fB-A\fP, \fB-\-arch\fP=\fI<arch>\fP
.
Set architecture string for the worker to report to master instead of the value in uname.
.TP
\fB-O\fP, \fB-\-os\fP=\fI<os>\fP
.
Set operating system string for the worker to report to master instead of the value in uname.
.TP
\fB-s\fP, \fB-\-workdir\fP=\fI<path>\fP
.
Set the location for creating the working directory of the worker.
.TP
\fB-P\fP, \fB-\---password\fP=\fI<file>\fP
.
Password file to authenticate workers to master.
.TP
.BI \ --cores \ <cores>
.
Set the number of cores each worker should use (0=auto). (default=1)
.TP
.BI \ --memory \ <size>
.
Manually set the amonut of memory (in MB) reported by this worker.
.TP
.BI \ --disk \ <size>
.
Manually set the amount of disk (in MB) reported by this worker.
.TP
.B \ -j
.
Use job array to submit workers.
.TP
.BI \ -p \ <parameters>
.
SGE qsub parameters.
.TP
.B \ -h,--help
.
Show help message.


.SH EXIT STATUS
.LP
On success, returns zero. On failure, returns non-zero.

.SH EXAMPLES
.LP

Submit 10 worker instances to run on SGE and connect to a specific master:

.fam C
.nf
.nh
.IP "" 8
sge_submit_workers master.somewhere.edu 9123 10
.fi
.hy
.fam
.P

Submit 10 work_queue_worker instances to run on SGE in auto mode with their
preferred project name set to Project_A and abort timeout set to 3600 seconds:

.fam C
.nf
.nh
.IP "" 8
sge_submit_workers -a -t 3600 -M Project_A 10
.fi
.hy
.fam
.P

.SH COPYRIGHT
.LP
The Cooperative Computing Tools are Copyright (C) 2003-2004 Douglas Thain and Copyright (C) 2005-2015 The University of Notre Dame.  This software is distributed under the GNU General Public License.  See the file COPYING for details.

.SH SEE ALSO
.LP

.IP \(bu 4
\fBCooperative Computing Tools Documentation\fP
.IP \(bu 4
\fBWork Queue User Manual\fP
.IP \(bu 4
\fBwork_queue_worker(1)\fP \fBwork_queue_status(1)\fP \fBwork_queue_factory(1)\fP \fBcondor_submit_workers(1)\fP \fBsge_submit_workers(1)\fP \fBtorque_submit_workers(1)\fP