gx-request - Request a grid-mapfile update
gx-request -help
gx-request -interactive
gx-request -long-help
gx-request is the client program for the gx-map system.
It's used to submit a request for an update to the Globus grid-mapfile.
gx-request may be run either in interactive mode, with the
-interactive option, or with all options specified on the command
line. Use the -long-help option to display the full set of options.
The gx-request command creates a request file in the
gx-map-data/new-requests directory under the gx-map installation
directory. This directory is world-writable, so the gx-request
command requires no special privileges. The request file is later
validated and processed by the gx-check-requests command.
Option processing is done using the Perl Getopt::Long module.
Options may be specified with a single or double leading '-' character.
Option names may be abbreviated to whatever is unique. Arguments may
be separated either by a blank or by an '=' character. For example,
``-foobar 42'', ``--foobar=42'', and ``-foob 42'' would all be equivalent.
- -help
-
Display a brief usage message and exit.
- -version
-
Display the software version number and exit.
- -quick-add
-
Add a mapping for your current certificate. The DN is determined
by examining your current proxy certificate ($X509_USER_PROXY or
/tmp/x509up_uNNN, where NNN is your numeric UID), or, if you
don't have a current proxy, your user certificate ($X509_USER_CERT
or $HOME/.globus/usercert.pem). Asks for verification before
submitting the request (unless the -quiet or -force option
is specified).
- -quick-remove
-
Remove the mapping for your current certificate.
- -long-help
-
Display a complete usage message and exit. The usage message contains
descriptions of all command-line options, and is likely to be more
correct than this man page.
- -interactive
-
Run interactively. Other options will be ignored.
The most common operations can be performed with the -add-quick
and -add-remove options. For more complex operations, interactive
mode is recommended. This is done by executing gx-request
-interactive (which may be abbreviated to gx-request -int.
In this mode, the gx-request command interactively prompts the user
to enter all the required information. This information includes the
kind of request (add, remove, etc.), the DN (which may be entered
directly or extracted from a proxy or user certificate file), an
optional e-mail address, and an optional comment. If gx-request
is executed in interactive mode by an administrator, it may prompt
for additional information.
Once all the necessary information has been collected, gx-request
will ask for confirmation before submitting the request.
If you don't want to run the gx-request command in interactive
mode, you can specify all required information on the command line.
This is recommended only for administrative use, such as in a script
performing multiple updates in batch mode.
Exactly one of the following options may be specified: -interactive,
-add-quick, -remove-quick, -add, -remove, -remove-dn,
-remove-user, -help, -usage, -long-usage.
- -add
-
Request a mapping to be added to the grid-mapfile.
- -remove
-
Request a mapping to be removed from the grid-mapfile.
- -remove-dn
-
Request that all mappings for a specified distinguished name be
removed. Only a gx-map administrator may use this option.
- -remove-user
-
Request that all mappings for a specified user be removed.
- -quiet
-
Work silently. This implies the -force option.
- -force
-
Apply the request without prompting for confirmation. By default,
gx-request will ask for confirmation before proceeding.
- -no-admin
-
Assume the user is not a gx-map administrator. This is intended for
developer testing only. This has no effect for a non-administrator.
- -dn ``string''
-
Specify a distinguished name (also known as a subject name).
The DN should be enclosed in double quotes, since it's likely to
contain special characters (avoid single quotes since some people's
names include apostrophes).
- -default-dn
-
Extract the distinguished name from your current certificate.
-
If you have a current proxy certificate (either $X509_USER_PROXY or
/tmp/x509up_uNNN, where NNN is your numeric UID), it will use that.
Otherwise, if you have a user certificate (either $X509_USER_CERT
or $HOME/.globus/usercert.pem), it will use that. Otherwise,
you will need to specify the DN in some other way.
- -certificate-file file
-
Extract the distinguished name from the specified X509 certificate
file.
- -force-dn
-
Normally gx-request does some minimal syntax checks on the
distinguished name; this option overrides those checks.
- -username name
-
Unix user name to map or unmap. This option is for use by gx-map
administrators only.
- -directory dir
-
Specify an alternate data directory. This option is for use by
gx-map administrators only, and is not recommended. The default
data directory is the gx-map-data subdirectory of the gx-map
installation (which is a symbolic link to the directory specified by
the DATA_DIR option in the installation configuration file).
- -email addr
-
Your contact e-mail address (optional). This is stored in the
requests.log file. It may be used to contact you if there's a
problem with your certificate.
- -no-email
-
This option is ignored. It's provided for compatibility with gx-map
release 0.3. It may be removed in a future release.
- -comment ``string''
-
A comment to be added to the requests.log file. This is optional.
- -source string
-
Specify the source of the mapping. This option is for use by gx-map
administrators only. The argument may consist only of letters,
digits, underscore, period, and hyphen characters ([A-Za-z0-9_.-]).
It is intended to indicate where the mapping came from. See the
gx-propagate(8) man page for more information.
- -debugging
-
Enable debugging output. This is intended for developer testing only.
gx-map(7), gx-check-requests(8), gx-propagate(8), gx-gen-mapfile(8),
gx-map-security(7)
Keith Thompson, San Diego Supercomputer Center, <kst@sdsc.edu>
See the file LICENSE in the gx-map distribution, installed in
the etc/gx-map subdirectory.