1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
|
'\" t
.\" Title: globus-personal-gatekeeper
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 07/09/2010
.\" Manual: GRAM5 Commands
.\" Source: University of Chicago
.\" Language: English
.\"
.TH "GLOBUS\-PERSONAL\-GA" "1" "07/09/2010" "University of Chicago" "GRAM5 Commands"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
globus-personal-gatekeeper \- Manage a user\'s personal gatekeeper daemon
.SH "SYNOPSIS"
.HP \w'\fBglobus\-personal\-gatekeeper\fR\ 'u
\fBglobus\-personal\-gatekeeper\fR [\-help] [\-usage] [\-version] [\-versions] [\-list] [\-directory\ \fICONTACT\fR]
.HP \w'\fBglobus\-personal\-gatekeeper\fR\ 'u
\fBglobus\-personal\-gatekeeper\fR [\-debug] {\-start} [\-jmtype\ \fILRM\fR] [\-auditdir\ \fIAUDIT_DIRECTORY\fR] [\-port\ \fIPORT\fR] [\-log\ [=\fIDIRECTORY\fR]] [\-seg] [\-acctfile\ \fIACCOUNTING_FILE\fR]
.HP \w'\fBglobus\-personal\-gatekeeper\fR\ 'u
\fBglobus\-personal\-gatekeeper\fR [\-killall] [\-kill]
.SH "DESCRIPTION"
.PP
The
\fBglobus\-personal\-gatekeeper\fR
command is a utility which manages a gatekeeper and job manager service for a single user\&. Depending on the command\-line arguments it will operate in one of several modes\&. In the first set of arguments indicated in the synopsis, the program provides information about the
\fBglobus\-personal\-gatekeeper\fR
command or about instances of the
\fBglobus\-personal\-gatekeeper\fR
that are running currently\&. The second set of arguments indicated in the synopsis provide control over starting a new
\fBglobus\-personal\-gatekeeper\fR
instance\&. The final set of arguments provide control for terminating one or more
\fBglobus\-personal\-gatekeeper\fR
instances\&.
.PP
The
\fB\-start\fR
mode will create a new subdirectory of
\fB$HOME\fR/\&.globus
and write the configuration files needed to start a
\fBglobus\-gatekeeper\fR
daemon which will invoke the
\fBglobus\-job\-manager\fR
service when new authenticated connections are made to its service port\&. The
\fBglobus\-personal\-gatekeeper\fR
then exits, printing the contact string for the new gatekeeper prefixed by
GRAM contact:
to standard output\&. In addition to the arguments described above, any arguments described in
\fBglobus\-job\-manager(8)\fR
can be appended to the command\-line and will be added to the job manager configuration for the service started by the
\fBglobus\-gatekeeper\fR\&.
.PP
The new
\fBglobus\-gatekeeper\fR
will continue to run in the background until killed by invoking
\fBglobus\-personal\-gatekeeper\fR
with the
\fB\-kill\fR
or
\fB\-killall\fR
argument\&. When killed, it will kill the
\fBglobus\-gatekeeper\fR
and
\fBglobus\-job\-manager\fR
processes, remove state files and configuration data, and then exit\&. Jobs which are running when the personal gatekeeper is killed will continue to run, but their job directory will be destroyed so they may fail in the LRM\&.
.PP
The full set of command\-line options to
\fBglobus\-personal\-gatekeeper\fR
consists of:
.PP
\fB\-help\fR, \fB\-usage\fR
.RS 4
Print command\-line option summary and exit
.RE
.PP
\fB\-version\fR
.RS 4
Print software version
.RE
.PP
\fB\-versions\fR
.RS 4
Print software version including DiRT information
.RE
.PP
\fB\-list\fR
.RS 4
Print a list of all currently running personal gatekeepers\&. These entries will be printed one per line\&.
.RE
.PP
\fB\-directory \fR\fB\fICONTACT\fR\fR
.RS 4
Print the configuration directory for the personal gatekeeper with the contact string
\fICONTACT\fR\&.
.RE
.PP
\fB\-debug\fR
.RS 4
Print additional debugging information when starting a personal gatekeeper\&. This option is ignored in other modes\&.
.RE
.PP
\fB\-start\fR
.RS 4
Start a new personal gatekeeper process\&.
.RE
.PP
\fB\-jmtype \fR\fB\fILRM\fR\fR
.RS 4
Use
\fILRM\fR
as the local resource manager interface\&. If not provided when starting a personal gatekeeper, the job manager will use the default
fork
LRM\&.
.RE
.PP
\fB\-auditdir \fR\fB\fIAUDIT_DIRECTORY\fR\fR
.RS 4
Write audit report files to
\fIAUDIT_DIRECTORY\fR\&. If not provided, the job manager will not write any audit files\&.
.RE
.PP
\fB\-port \fR\fB\fIPORT\fR\fR
.RS 4
Listen for gatekeeper TCP/IP connections on the port
\fIPORT\fR\&. If not provided, the gatekeeper will let the operating system choose\&.
.RE
.PP
\fB\-log\fR\fB[=\fIDIRECTORY\fR]\fR
.RS 4
Write job manager log files to
\fIDIRECTORY\fR\&. If
\fIDIRECTORY\fR
is omitted, the default of
\fB$HOME\fR
will be used\&. If this option is not present, the job manager will not write any log files\&.
.RE
.PP
\fB\-seg\fR
.RS 4
Try to use the SEG mechanism to receive job state change information, instead of polling for these\&. These require either the system administrator or the user to run an instance of the
\fBglobus\-job\-manager\-event\-generator\fR
program for the LRM specified by the
\fB\-jmtype\fR
option\&.
.RE
.PP
\fB\-acctfile \fR\fB\fIACCOUNTING_FILE\fR\fR
.RS 4
Write gatekeeper accounting entries to
\fIACCOUNTING_FILE\fR\&. If not provided, no accounting records are written\&.
.RE
.SH "EXAMPLES"
.PP
This example shows the output when starting a new personal gatekeeper which will schedule jobs via the
lsf
LRM, with debugging enabled\&.
.sp
.if n \{\
.RS 4
.\}
.nf
% \fBglobus\-personal\-gatekeeper \-start \-jmtype lsf\fR
verifying setup\&.\&.\&.
done\&.
GRAM contact: personal\-grid\&.example\&.org:57846:/DC=org/DC=example/CN=Joe User
.fi
.if n \{\
.RE
.\}
.PP
This example shows the output when listing the current active personal gatekeepers\&.
.sp
.if n \{\
.RS 4
.\}
.nf
% \fBglobus\-personal\-gatekeeper \-list\fR
personal\-grid\&.example\&.org:57846:/DC=org/DC=example/CN=Joe User
.fi
.if n \{\
.RE
.\}
.PP
This example shows the output when querying the configuration directory for th eabove personal gatekeeper\&. gatekeepers\&.
.sp
.if n \{\
.RS 4
.\}
.nf
% \fBglobus\-personal\-gatekeeper \-directory "personal\-grid\&.example\&.org:57846:/DC=org/DC=example/CN=Joe User"\fR
/home/juser/\&.globus/\&.personal\-gatekeeper\&.personal\-grid\&.example\&.org\&.1337
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
% \fBglobus\-personal\-gatekeeper \-kill "personal\-grid\&.example\&.org:57846:/DC=org/DC=example/CN=Joe User"\fR
killing gatekeeper: "personal\-grid\&.example\&.org:57846:/DC=org/DC=example/CN=Joe User"
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBglobusrun\fR(1),
\fBglobus-job-manager\fR(8),
\fBglobus-gatekeeper\fR(8)
|