1LAMWIPE(1)                         LAM TOOLS                        LAMWIPE(1)
2
3
4

NAME

6       lamwipe - Shutdown LAM.
7

SYNTAX

9       lamwipe   [-b]   [-d]   [-h]   [-v]   [-nn]  [-np]  [-n  <#>]  [-prefix
10              </lam/install/path>]       [-prefix        </lam/install/path/>]
11              [-sessionprefix      <value>]      [-sessionsuffix      <value>]
12              [-withlamprefixpath <value>] [-ssi <key> <value>] [<bhost>]
13

OPTIONS

15       -b          Assume local and remote shell are  the  same.   This  means
16                   that only one remote shell invocation is used to each node.
17                   If -b is not used, two remote shell invocations are used to
18                   each node.
19
20       -d          Turn on debugging mode.  This implies -v.
21
22       -h          Print the command help menu.
23
24       -n <#>      Lamwipe only the first <#> nodes.
25
26       -prefix     Use the LAM installation specified in </lam/install/path/>
27
28       -ssi <key> <value>
29                   Send  arguments to various SSI modules.  See the "SSI" sec‐
30                   tion, below.
31
32       -v          Be verbose.
33
34       -nn         Don't add "-n" to the remote agent command line
35
36       -np         Do not force the  execution  of  $HOME/.profile  on  remote
37                   hosts
38
39       -session-prefix <value>
40                   Set the session prefix, overriding LAM_MPI_SESSION_PREFIX.
41
42       -session-suffix <value>
43                   Set the session suffix, overriding LAM_MPI_SESSION_SUFFIX.
44
45       -withlamprefixpath <value>
46                   Override  the internal installation path.  For internal use
47                   only, do not use unless you know what you are doing.
48

DESCRIPTION

50       This command has been deprecated  in  favor  of  the  lamhalt  command.
51       lamwipe  should  only  be  necessary  if lamhalt fails and is unable to
52       clean up the LAM run-time environment properly.  The lamwipe tool  ter‐
53       minates  the LAM software on each of the machines specified in the boot
54       schema, <bhost>.  lamwipe is the topology tool that terminates  LAM  on
55       the  UNIX(tm)  nodes of a multicomputer system.  It invokes tkill(1) on
56       each machine.  See tkill(1) for a description of how LAM is  terminated
57       on each node.
58
59       The  <bhost> file is a LAM boot schema written in the host file syntax.
60       CPU counts in the boot schema are ignored by  lamwipe.   See  bhost(5).
61       Instead  of  the  command  line,  a boot schema can be specified in the
62       LAMBHOST environment variable.  Otherwise a default file, bhost.def, is
63       used.   LAM  searches for <bhost> first in the local directory and then
64       in the installation directory under etc/.
65
66       lamwipe does not quit if a particular remote node cannot be reached  or
67       if tkill(1) fails on any node.  A message is printed if either of these
68       failures occur, in which case the user should investigate the cause  of
69       failure and, if necessary, terminate LAM by manually executing tkill(1)
70       on the problem node(s).  In extreme cases, the user may have to  termi‐
71       nate individual LAM processes with kill(1).
72
73       lamwipe will terminate after a limited number of nodes if the -n option
74       is given.  This is mainly intended for use by lamboot(1), which invokes
75       lamwipe when a boot does not successfully complete.
76
77   SSI (System Services Interface)
78       The  -ssi  switch  allows the passing of parameters to various SSI mod‐
79       ules.  LAM's SSI modules are described in  detail  in  lamssi(7).   SSI
80       modules  have  direct impact on MPI programs because they allow tunable
81       parameters to be set at run time (such as which boot device  driver  to
82       use, what parameters to pass to that driver, etc.).
83
84       The  -ssi switch takes two arguments: <key> and <value>.  The <key> ar‐
85       gument generally specifies which SSI module  will  receive  the  value.
86       For  example,  the  <key> "boot" is used to select which RPI to be used
87       for starting processes on remote nodes.  The <value>  argument  is  the
88       value that is passed.  For example:
89
90       lamboot -ssi boot tm
91           Tells  LAM  to use the "tm" boot module for native launching in PB‐
92           SPro / OpenPBS environments (the tm boot module does not require  a
93           boot schema).
94
95       lamboot -ssi boot rsh -ssi rsh_agent "ssh -x" boot_file
96           Tells LAM to use the "rsh" boot module, and tells the rsh module to
97           use "ssh -x" as the specific agent to launch executables on  remote
98           nodes.
99
100       And so on.  LAM's boot SSI modules are described in lamssi_boot(7).
101
102       The  -ssi  switch can be used multiple times to specify different <key>
103       and/or <value> arguments.  If the same <key>  is  specified  more  than
104       once, the <value>s are concatenated with a comma (",") separating them.
105
106       Note  that the -ssi switch is simply a shortcut for setting environment
107       variables.  The same effect may be accomplished by setting  correspond‐
108       ing  environment variables before running lamwipe.  The form of the en‐
109       vironment variables that LAM sets are: LAM_MPI_SSI_<key>=<value>.
110
111       Note that the -ssi switch  overrides  any  previously  set  environment
112       variables.  Also note that unknown <key> arguments are still set as en‐
113       vironment variable -- they are not checked (by  lamwipe)  for  correct‐
114       ness.  Illegal or incorrect <value> arguments may or may not be report‐
115       ed -- it depends on the specific SSI module.
116
117   Remote Executable Invocation
118       All tweakable aspects of launching executables on remote  nodes  during
119       lamwipe  are discussed in lamssi(7) and lamssi_boot(7).  Topics include
120       (but are not limited to): discovery of remote shell, run-time overrides
121       of the agent use to launch remote executables (e.g., rsh and ssh), etc.
122

EXAMPLES

124       lamwipe -v mynodes
125           Shutdown LAM on the machines described in the boot schema, mynodes.
126           Report about important steps as they are done.
127

FILES

129       laminstalldir/etc/lam-bhost.def   default  boot  schema   file,   where
130                                         "laminstalldir"   is   the  directory
131                                         where LAM/MPI was installed.
132

SEE ALSO

134       recon(1), lamboot(1), tkill(1), bhost(5),  lam-helpfile(5),  lamssi(7),
135       lamssi_boot(7)
136
137
138
139LAM 7.1.2                         March, 2006                       LAMWIPE(1)
Impressum