flux-module(1)¶

SYNOPSIS¶

flux module COMMAND [OPTIONS]

flux-module(1) manages dynamically loadable flux-broker(1) modules.

load name [module-arguments …]: Load module name. When the load command completes successfully, the new module has entered the running state (see LIST OUTPUT below).
remove [--force] name: Remove module name. If -f, --force is used, then do not fail if module name is not loaded.
reload [--force] name [module-arguments …]: Reload module name. This is equivalent to running flux module remove followed by flux module load. It is a fatal error if module name is not loaded during removal unless the -f, --force option is specified.
list [service]: List loaded flux-broker(1) modules.
stats [OPTIONS] [name]: Request statistics from module name. A JSON object containing a set of counters for each type of Flux message is returned by default, however the object may be customized on a module basis.
debug [OPTIONS] [name]: Manipulate debug flags in module name. The interpretation of debug flag bits is private to the module and its test drivers.

-p, --parse=OBJNAME: OBJNAME is a period delimited list of field names that should be walked to obtain a specific value or object in the returned JSON.
-t, --type=int|double: Force the returned value to be converted to int or double.
-s, --scale=N: Multiply the returned (int or double) value by the specified floating point value.
-R, --rusage: Return a JSON object representing an rusage structure returned by getrusage(2).
-c, --clear: Send a request message to clear statistics in the target module.
-C, --clear-all: Broadcast an event message to clear statistics in the target module on all ranks.

-c, --clear: Set debug flags to zero.
-S, --set=MASK: Set debug flags to MASK. The value may be prefixed with 0x to indicate hexadecimal or 0 to indicate octal, otherwise the value is interpreted as decimal.
-c, --clearbit=MASK: Clear the debug bits specified in MASK without disturbing other bits. The value is interpreted as above.
-s, --setbit=MASK: Set the debug bits specified in MASK without disturbing other bits. The value is interpreted as above.

The list command displays one line for each unique (as determined by SHA1 hash) loaded module.

Module: The value of the mod_name symbol for this module.
Idle: Idle times are defined as the number of seconds since the module last sent a request or response message.
State: The state of the module is shown as a single character: I initializing, R running, F finalizing, E exited. A module automatically enters running state when it calls flux_reactor_run(3). It can transition earlier by calling flux_module_set_running().
Service: If the module has registered additional services, the service names are displayed in a comma-separated list.
Path: The full path to the broker module shared object file (only shown with the -l, --long option).

All Flux modules define the following global symbols: