Scroll to navigation

PTERM(1) PMIx Reference Run Time Environment PTERM(1)

pterm — terminate a PRRTE DVM

SYNOPSIS

pterm [options]


DESCRIPTION

pterm terminates an instance of the PMIx Reference Runtime Environment (PRRTE) distributed virtual machine (DVM) that was started by prte(1) <#man1-prte>. It connects to the DVM controller as a PMIx tool and directs it to shut the DVM down, taking with it any jobs still running in it. The connection options below select which DVM controller pterm connects to.

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

OPTIONS

General options

-h | --help [<option>]

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

-v | --verbose

Enable typical debug options.

-V | --version

Print version and exit.

Connection options

--dvm-uri <uri>

Specify the URI of the DVM controller to connect to, or the name of the file (specified as file:<filename>) that contains that info.

--namespace <name>

Namespace of the DVM controller to connect to.

--pid <pid>

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

--system-server-first

First look for a system-level DVM controller and connect to it if found; otherwise, fall back to searching for any other DVM controller.

--system-server-only

Connect only to a system-level DVM controller — abort if one is not found.

--wait-to-connect <seconds>

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

--num-connect-retries <num>

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

Specific options

--pmixmca <key> <value>

Pass a PMIx MCA parameter

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

--allow-run-as-root

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

EXIT STATUS

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

EXAMPLES

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) <#man1-prte>, prun(1) <#man1-prun>


Copyright

2003-2026, The PRRTE Community

September 28, 2026