21.1.6. pterm

pterm — terminate a PRRTE DVM

21.1.6.1. SYNOPSIS

pterm [options]

21.1.6.2. DESCRIPTION

pterm terminates an instance of the PMIx Reference Runtime Environment (PRRTE) distributed virtual machine (DVM) that was started by prte(1). It connects, as a PMIx tool, to the DVM daemon on the node where it runs — the DVM controller on the node where prte was started, or the prted(1) daemon on any other node of the DVM — and directs the DVM to shut down, taking with it any jobs still running in it.

The connection is local to the node, as it is for prun(1): pterm must run on a node where one of the DVM’s daemons is running, with the TMPDIR that daemon was started with, or be given the daemon’s rendezvous file with --dvm-uri file:<path>. See Using prun with a running DVM. The connection options below select which of this node’s daemons pterm connects to.

pterm accepts no arguments other than the options listed here. pterm --help <option> prints the full description of an option.

21.1.6.3. OPTIONS

General options

21.1.6.3.1. -h | --help [<option>]

Print the list of options, or the full help for the named option.

21.1.6.3.2. -v | --verbose

Enable typical debug options.

21.1.6.3.3. -V | --version

Print version and exit.

Connection options

21.1.6.3.4. --dvm-uri <uri>

Specify the URI of the DVM daemon on this node to connect to, or the name of the file (specified as file:<filename>) that contains that info. A daemon’s URI names a socket on the daemon’s own node, so it can be used only there.

21.1.6.3.5. --namespace <name>

Namespace of the DVM to connect to. The connection is made to that DVM’s daemon on this node.

21.1.6.3.6. --pid <pid>

PID of the DVM daemon on this node to connect to, given either as an integer or as file:<filename> naming a file that contains the PID.

21.1.6.3.7. --system-server-first

First look on this node for a daemon of a system-level DVM and connect to it if found; otherwise, fall back to searching this node for any other DVM daemon.

21.1.6.3.8. --system-server-only

Connect only to a daemon of a system-level DVM on this node — abort if one is not found.

21.1.6.3.9. --wait-to-connect <seconds>

Delay the specified number of seconds between attempts to connect to the DVM daemon.

21.1.6.3.10. --num-connect-retries <num>

Maximum number of times to try to connect to the DVM daemon.

Specific options

21.1.6.3.11. --pmixmca <key> <value>

Pass a PMIx MCA parameter

Syntax: --pmixmca <key> <value>, where key is the parameter name and value is the parameter value.

21.1.6.3.12. --allow-run-as-root

Accepted for symmetry with the other PRRTE tools — pterm launches nothing, so no root-execution guard applies.

21.1.6.4. EXIT STATUS

pterm exits with status 0 if it reached a daemon of the DVM and the DVM was directed to terminate, and non-zero otherwise.

21.1.6.5. EXAMPLES

On the node where prte runs, terminate the DVM whose controller wrote its URI to a file:

shell$ prte --report-uri dvm.uri --daemonize
shell$ pterm --dvm-uri file:dvm.uri

See also

prte(1), prun(1)