3. Using Debugpanel

Debugpanel is invoked at the command line as:

debugpanel

or as a Python module:

python -m lockss.debugpanel

Help messages and this document use debugpanel throughout, but the two invocation styles are interchangeable.

3.1. Debugpanel Commands

Debugpanel commands are in the subcommand style of programs like git, dnf/yum, apt/apt-get, and the like.

The available commands are:

Operation	Command	Abbreviation
Cause nodes to check the substance of AUs	debugpanel check-substance	debugpanel cs
Print the copyright and exit	debugpanel copyright
Cause nodes to crawl AUs	debugpanel crawl	debugpanel cr
Cause nodes to crawl plugins	debugpanel crawl-plugins	debugpanel cp
Cause nodes to deeply crawl AUs	debugpanel deep-crawl	debugpanel dc
Cause nodes to disable metadata indexing for AUs	debugpanel disable-indexing	debugpanel di
Print the software license and exit	debugpanel license
Cause nodes to poll AUs	debugpanel poll	debugpanel po
Cause nodes to reindex the metadata of AUs	debugpanel reindex-metadata	debugpanel ri
cause nodes to reload their configuration	debugpanel reload-config	debugpanel rc
Display the subcommand tree and exit	debugpanel tree
cause nodes to validate the files of AUs	debugpanel validate-files	debugpanel vf
Print the version number and exit	debugpanel version

You can see the synopsis by invoking debugpanel --help:

$ debugpanel --help
Usage: debugpanel [OPTIONS] COMMAND [ARGS]...

  Command line tool to interact with the LOCKSS 1.x DebugPanel servlet.

Options:
  --color, --ansi / --no-color, --no-ansi
                 Strip out all colors and all ANSI codes from output.  [default:
                 color]
  --show-params  Show all CLI parameters, their provenance, defaults and value,
                 then exit.
  -h, --help     Show this message and exit.

AUID commands:
  check-substance (cs)   Cause nodes to check the substance of AUs.
  crawl (cr)             Cause nodes to crawl AUs.
  deep-crawl (dc)        Cause nodes to deep-crawl AUs.
  disable-indexing (di)  Cause nodes to disable metadata indexing for AUs.
  poll (po)              Cause nodes to poll AUs.
  reindex-metadata (ri)  Cause nodes to reindex the metadata of AUs.
  validate-files (vf)    Cause nodes to validate the files of AUs.

Node commands:
  crawl-plugins (cp)     Cause nodes to crawl plugins.
  reload-config (rc)     Cause nodes to reload their configuration.

Other commands:
  copyright              Show the copyright and exit.
  license                Show the software license and exit.
  tree                   show the command tree of your CLI
  version                Show the version number and exit.

3.1.1. debugpanel Command

The top-level debugpanel``command, alone, defaults to ``debugpanel --help`.

Note

The --color/--ansi//--no-color/--no-ansi and --show-params options attach to the top-level debugpanel command only, not to a subcommand that may also be specified. For example, this is not valid:

$ debugpanel reload-config --help --no-color
Usage: debugpanel reload-config [OPTIONS]
Try 'debugpanel reload-config --help' for help.

Error: No such option: --no-color

Instead, you should invoke debugpanel --no-color reload-config --help.

3.1.2. debugpanel check-substance

The debugpanel check-substance (or alternatively debugpanel cs) command is one of the Debugpanel AU Operations, used to cause nodes to check the substance of AUs. It has its own --help/-h option:

$ debugpanel check-substance --help
Usage: debugpanel check-substance [OPTIONS]
Aliases: cs

  Cause nodes to check the substance of AUs.

Node options:
  -n, --node NODE      Add NODE to the list of nodes to process.
  -N, --nodes FILE     Add the nodes in FILE to the list of nodes to process.
  -U, --username USER  Set the UI username to USER.  [default: (interactive
                       prompt)]
  -u USER              (DEPRECATED: Use -U instead.)
  -P, --password PASS  Set the UI password to PASS.  [default: (interactive
                       prompt)]
  -p PASS              (DEPRECATED: Use -P instead.)

AUID options:
  -a, --auid AUID   Add AUID to the list of AUIDs to process.
  -A, --auids FILE  Add the AUIDs in FILE to the list of AUIDs to process.

Job pool options:
  --pool-size SIZE  Set the job pool size to SIZE.  [default: (CPU-dependent)]
  --pool-type [thread-pool|process-pool]
                    Set the job pool type to the given type.
  --process-pool    (DEPRECATED: Use --pool-type=process-pool instead.)
  --thread-pool     (DEPRECATED: Use --pool-type=thread-pool instead.)

Output options:
  --headings / --no-headings  Set whether to include column headings in tabular
                              output.  [default: headings]
  --progress / --no-progress  Set whether to display a progress bar during
                              processing.  [default: progress]
  -T, --table-format [asciidoc|csv|csv-excel|csv-excel-tab|csv-unix|double-grid|double-outline|fancy-grid|fancy-outline|github|grid|heavy-grid|heavy-outline|html|jira|latex|latex-booktabs|latex-longtable|latex-raw|mediawiki|mixed-grid|mixed-outline|moinmoin|orgtbl|outline|pipe|plain|presto|pretty|psql|rounded-grid|rounded-outline|rst|simple|simple-grid|simple-outline|textile|tsv|unsafehtml|vertical|youtrack]
                              Set the rendering of tables to the given style.
                              [default: simple]

Other options:
  -h, --help  Show this message and exit.

Constraints:
  {--username, -u}  mutually exclusive
  {--password, -p}  mutually exclusive
  {--pool-type, --process-pool, --thread-pool}
                    mutually exclusive

The command requires:

• One or more nodes, from the Debugpanel Node Options (--node/-n, --nodes/-N).

• One or more AUIDs, from the Debugpanel AUID Options (--auid/-a, --auids/-A).

It also accepts Debugpanel Output Format Options (--table-format/-T, --headings//--no-headings, --progress//--no-progress) and Debugpanel Job Pool Options (--pool-size, --pool-size).

3.1.3. debugpanel copyright

The debugpanel copyright command displays the copyright notice for Debugpanel and exits:

$ debugpanel copyright
Copyright (c) 2000-2026, Board of Trustees of Leland Stanford Jr. University

3.1.4. debugpanel crawl

The debugpanel crawl (or alternatively debugpanel cr) command is one of the Debugpanel AU Operations, used to cause nodes to crawl AUs. It has its own --help/-h option:

$ debugpanel crawl --help
Usage: debugpanel crawl [OPTIONS]
Aliases: cr

  Cause nodes to crawl AUs.

Node options:
  -n, --node NODE      Add NODE to the list of nodes to process.
  -N, --nodes FILE     Add the nodes in FILE to the list of nodes to process.
  -U, --username USER  Set the UI username to USER.  [default: (interactive
                       prompt)]
  -u USER              (DEPRECATED: Use -U instead.)
  -P, --password PASS  Set the UI password to PASS.  [default: (interactive
                       prompt)]
  -p PASS              (DEPRECATED: Use -P instead.)

AUID options:
  -a, --auid AUID   Add AUID to the list of AUIDs to process.
  -A, --auids FILE  Add the AUIDs in FILE to the list of AUIDs to process.

Job pool options:
  --pool-size SIZE  Set the job pool size to SIZE.  [default: (CPU-dependent)]
  --pool-type [thread-pool|process-pool]
                    Set the job pool type to the given type.
  --process-pool    (DEPRECATED: Use --pool-type=process-pool instead.)
  --thread-pool     (DEPRECATED: Use --pool-type=thread-pool instead.)

Output options:
  --headings / --no-headings  Set whether to include column headings in tabular
                              output.  [default: headings]
  --progress / --no-progress  Set whether to display a progress bar during
                              processing.  [default: progress]
  -T, --table-format [asciidoc|csv|csv-excel|csv-excel-tab|csv-unix|double-grid|double-outline|fancy-grid|fancy-outline|github|grid|heavy-grid|heavy-outline|html|jira|latex|latex-booktabs|latex-longtable|latex-raw|mediawiki|mixed-grid|mixed-outline|moinmoin|orgtbl|outline|pipe|plain|presto|pretty|psql|rounded-grid|rounded-outline|rst|simple|simple-grid|simple-outline|textile|tsv|unsafehtml|vertical|youtrack]
                              Set the rendering of tables to the given style.
                              [default: simple]

Other options:
  -h, --help  Show this message and exit.

Constraints:
  {--username, -u}  mutually exclusive
  {--password, -p}  mutually exclusive
  {--pool-type, --process-pool, --thread-pool}
                    mutually exclusive

The command requires:

• One or more nodes, from the Debugpanel Node Options (--node/-n, --nodes/-N).

• One or more AUIDs, from the Debugpanel AUID Options (--auid/-a, --auids/-A).

It also accepts Debugpanel Output Format Options (--table-format/-T, --headings//--no-headings, --progress//--no-progress) and Debugpanel Job Pool Options (--pool-size, --pool-size).

3.1.5. debugpanel crawl-plugins

The debugpanel crawl-plugins (or alternatively debugpanel cp) command is one of the Debugpanel Node Operations, used to cause nodes to crawl their plugins. It has its own --help/-h option:

$ debugpanel crawl-plugins --help
Usage: debugpanel crawl-plugins [OPTIONS]
Aliases: cp

  Cause nodes to crawl plugins.

Node options:
  -n, --node NODE      Add NODE to the list of nodes to process.
  -N, --nodes FILE     Add the nodes in FILE to the list of nodes to process.
  -U, --username USER  Set the UI username to USER.  [default: (interactive
                       prompt)]
  -u USER              (DEPRECATED: Use -U instead.)
  -P, --password PASS  Set the UI password to PASS.  [default: (interactive
                       prompt)]
  -p PASS              (DEPRECATED: Use -P instead.)

Job pool options:
  --pool-size SIZE  Set the job pool size to SIZE.  [default: (CPU-dependent)]
  --pool-type [thread-pool|process-pool]
                    Set the job pool type to the given type.
  --process-pool    (DEPRECATED: Use --pool-type=process-pool instead.)
  --thread-pool     (DEPRECATED: Use --pool-type=thread-pool instead.)

Output options:
  --headings / --no-headings  Set whether to include column headings in tabular
                              output.  [default: headings]
  --progress / --no-progress  Set whether to display a progress bar during
                              processing.  [default: progress]
  -T, --table-format [asciidoc|csv|csv-excel|csv-excel-tab|csv-unix|double-grid|double-outline|fancy-grid|fancy-outline|github|grid|heavy-grid|heavy-outline|html|jira|latex|latex-booktabs|latex-longtable|latex-raw|mediawiki|mixed-grid|mixed-outline|moinmoin|orgtbl|outline|pipe|plain|presto|pretty|psql|rounded-grid|rounded-outline|rst|simple|simple-grid|simple-outline|textile|tsv|unsafehtml|vertical|youtrack]
                              Set the rendering of tables to the given style.
                              [default: simple]

Other options:
  -h, --help  Show this message and exit.

Constraints:
  {--username, -u}  mutually exclusive
  {--password, -p}  mutually exclusive
  {--pool-type, --process-pool, --thread-pool}
                    mutually exclusive

The command requires:

• One or more nodes, from the Debugpanel Node Options (--node/-n, --nodes/-N).

It also accepts Debugpanel Output Format Options (--table-format/-T, --headings//--no-headings, --progress//--no-progress) and Debugpanel Job Pool Options (--pool-size, --pool-size).

3.1.6. debugpanel deep-crawl

The debugpanel deep-crawl (or alternatively debugpanel dc) command is one of the Debugpanel AU Operations, used to cause nodes to crawl AUs with depth. It has its own --help/-h option:

$ debugpanel deep-crawl --help
Usage: debugpanel deep-crawl [OPTIONS]
Aliases: dc

  Cause nodes to deep-crawl AUs.

Node options:
  -n, --node NODE      Add NODE to the list of nodes to process.
  -N, --nodes FILE     Add the nodes in FILE to the list of nodes to process.
  -U, --username USER  Set the UI username to USER.  [default: (interactive
                       prompt)]
  -u USER              (DEPRECATED: Use -U instead.)
  -P, --password PASS  Set the UI password to PASS.  [default: (interactive
                       prompt)]
  -p PASS              (DEPRECATED: Use -P instead.)

AUID options:
  -a, --auid AUID   Add AUID to the list of AUIDs to process.
  -A, --auids FILE  Add the AUIDs in FILE to the list of AUIDs to process.

Depth options:
  -d, --depth DEPTH  Set the crawl depth to DEPTH.  [default: 123; x>=0]

Job pool options:
  --pool-size SIZE  Set the job pool size to SIZE.  [default: (CPU-dependent)]
  --pool-type [thread-pool|process-pool]
                    Set the job pool type to the given type.
  --process-pool    (DEPRECATED: Use --pool-type=process-pool instead.)
  --thread-pool     (DEPRECATED: Use --pool-type=thread-pool instead.)

Output options:
  --headings / --no-headings  Set whether to include column headings in tabular
                              output.  [default: headings]
  --progress / --no-progress  Set whether to display a progress bar during
                              processing.  [default: progress]
  -T, --table-format [asciidoc|csv|csv-excel|csv-excel-tab|csv-unix|double-grid|double-outline|fancy-grid|fancy-outline|github|grid|heavy-grid|heavy-outline|html|jira|latex|latex-booktabs|latex-longtable|latex-raw|mediawiki|mixed-grid|mixed-outline|moinmoin|orgtbl|outline|pipe|plain|presto|pretty|psql|rounded-grid|rounded-outline|rst|simple|simple-grid|simple-outline|textile|tsv|unsafehtml|vertical|youtrack]
                              Set the rendering of tables to the given style.
                              [default: simple]

Other options:
  -h, --help  Show this message and exit.

Constraints:
  {--username, -u}  mutually exclusive
  {--password, -p}  mutually exclusive
  {--pool-type, --process-pool, --thread-pool}
                    mutually exclusive

The command requires:

• One or more nodes, from the Debugpanel Node Options (--node/-n, --nodes/-N).

• One or more AUIDs, from the Debugpanel AUID Options (--auid/-a, --auids/-A).

It has a unique option, --depth/-d, which is an strictly positive integer specifying the desired crawl depth.

It also accepts Debugpanel Output Format Options (--table-format/-T, --headings//--no-headings, --progress//--no-progress) and Debugpanel Job Pool Options (--pool-size, --pool-size).

3.1.7. debugpanel disable-indexing

The debugpanel disable-indexing (or alternatively debugpanel di) command is one of the Debugpanel AU Operations, used to cause nodes to disable metadata indexing of AUs. It has its own --help/-h option:

$ debugpanel disable-indexing --help
Usage: debugpanel disable-indexing [OPTIONS]
Aliases: di

  Cause nodes to disable metadata indexing for AUs.

Node options:
  -n, --node NODE      Add NODE to the list of nodes to process.
  -N, --nodes FILE     Add the nodes in FILE to the list of nodes to process.
  -U, --username USER  Set the UI username to USER.  [default: (interactive
                       prompt)]
  -u USER              (DEPRECATED: Use -U instead.)
  -P, --password PASS  Set the UI password to PASS.  [default: (interactive
                       prompt)]
  -p PASS              (DEPRECATED: Use -P instead.)

AUID options:
  -a, --auid AUID   Add AUID to the list of AUIDs to process.
  -A, --auids FILE  Add the AUIDs in FILE to the list of AUIDs to process.

Job pool options:
  --pool-size SIZE  Set the job pool size to SIZE.  [default: (CPU-dependent)]
  --pool-type [thread-pool|process-pool]
                    Set the job pool type to the given type.
  --process-pool    (DEPRECATED: Use --pool-type=process-pool instead.)
  --thread-pool     (DEPRECATED: Use --pool-type=thread-pool instead.)

Output options:
  --headings / --no-headings  Set whether to include column headings in tabular
                              output.  [default: headings]
  --progress / --no-progress  Set whether to display a progress bar during
                              processing.  [default: progress]
  -T, --table-format [asciidoc|csv|csv-excel|csv-excel-tab|csv-unix|double-grid|double-outline|fancy-grid|fancy-outline|github|grid|heavy-grid|heavy-outline|html|jira|latex|latex-booktabs|latex-longtable|latex-raw|mediawiki|mixed-grid|mixed-outline|moinmoin|orgtbl|outline|pipe|plain|presto|pretty|psql|rounded-grid|rounded-outline|rst|simple|simple-grid|simple-outline|textile|tsv|unsafehtml|vertical|youtrack]
                              Set the rendering of tables to the given style.
                              [default: simple]

Other options:
  -h, --help  Show this message and exit.

Constraints:
  {--username, -u}  mutually exclusive
  {--password, -p}  mutually exclusive
  {--pool-type, --process-pool, --thread-pool}
                    mutually exclusive

The command requires:

• One or more nodes, from the Debugpanel Node Options (--node/-n, --nodes/-N).

• One or more AUIDs, from the Debugpanel AUID Options (--auid/-a, --auids/-A).

It also accepts Debugpanel Output Format Options (--table-format/-T, --headings//--no-headings, --progress//--no-progress) and Debugpanel Job Pool Options (--pool-size, --pool-size).

3.1.8. debugpanel license

The debugpanel license command displays the license terms for Debugpanel and exits:

$ debugpanel license
Copyright (c) 2000-2026, Board of Trustees of Leland Stanford Jr. University

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

3.1.9. debugpanel poll

The debugpanel poll (or alternatively debugpanel po) command is one of the Debugpanel AU Operations, used to cause nodes to poll AUs. It has its own --help/-h option:

$ debugpanel poll --help
Usage: debugpanel poll [OPTIONS]
Aliases: po

  Cause nodes to poll AUs.

Node options:
  -n, --node NODE      Add NODE to the list of nodes to process.
  -N, --nodes FILE     Add the nodes in FILE to the list of nodes to process.
  -U, --username USER  Set the UI username to USER.  [default: (interactive
                       prompt)]
  -u USER              (DEPRECATED: Use -U instead.)
  -P, --password PASS  Set the UI password to PASS.  [default: (interactive
                       prompt)]
  -p PASS              (DEPRECATED: Use -P instead.)

AUID options:
  -a, --auid AUID   Add AUID to the list of AUIDs to process.
  -A, --auids FILE  Add the AUIDs in FILE to the list of AUIDs to process.

Job pool options:
  --pool-size SIZE  Set the job pool size to SIZE.  [default: (CPU-dependent)]
  --pool-type [thread-pool|process-pool]
                    Set the job pool type to the given type.
  --process-pool    (DEPRECATED: Use --pool-type=process-pool instead.)
  --thread-pool     (DEPRECATED: Use --pool-type=thread-pool instead.)

Output options:
  --headings / --no-headings  Set whether to include column headings in tabular
                              output.  [default: headings]
  --progress / --no-progress  Set whether to display a progress bar during
                              processing.  [default: progress]
  -T, --table-format [asciidoc|csv|csv-excel|csv-excel-tab|csv-unix|double-grid|double-outline|fancy-grid|fancy-outline|github|grid|heavy-grid|heavy-outline|html|jira|latex|latex-booktabs|latex-longtable|latex-raw|mediawiki|mixed-grid|mixed-outline|moinmoin|orgtbl|outline|pipe|plain|presto|pretty|psql|rounded-grid|rounded-outline|rst|simple|simple-grid|simple-outline|textile|tsv|unsafehtml|vertical|youtrack]
                              Set the rendering of tables to the given style.
                              [default: simple]

Other options:
  -h, --help  Show this message and exit.

Constraints:
  {--username, -u}  mutually exclusive
  {--password, -p}  mutually exclusive
  {--pool-type, --process-pool, --thread-pool}
                    mutually exclusive

The command requires:

• One or more nodes, from the Debugpanel Node Options (--node/-n, --nodes/-N).

• One or more AUIDs, from the Debugpanel AUID Options (--auid/-a, --auids/-A).

It also accepts Debugpanel Output Format Options (--table-format/-T, --headings//--no-headings, --progress//--no-progress) and Debugpanel Job Pool Options (--pool-size, --pool-size).

3.1.10. debugpanel reindex-metadata

The debugpanel reindex-metadata (or alternatively debugpanel ri) command is one of the Debugpanel AU Operations, used to cause nodes to reindex the metadata of AUs. It has its own --help/-h option:

$ debugpanel reindex-metadata --help
Usage: debugpanel reindex-metadata [OPTIONS]
Aliases: ri

  Cause nodes to reindex the metadata of AUs.

Node options:
  -n, --node NODE      Add NODE to the list of nodes to process.
  -N, --nodes FILE     Add the nodes in FILE to the list of nodes to process.
  -U, --username USER  Set the UI username to USER.  [default: (interactive
                       prompt)]
  -u USER              (DEPRECATED: Use -U instead.)
  -P, --password PASS  Set the UI password to PASS.  [default: (interactive
                       prompt)]
  -p PASS              (DEPRECATED: Use -P instead.)

AUID options:
  -a, --auid AUID   Add AUID to the list of AUIDs to process.
  -A, --auids FILE  Add the AUIDs in FILE to the list of AUIDs to process.

Job pool options:
  --pool-size SIZE  Set the job pool size to SIZE.  [default: (CPU-dependent)]
  --pool-type [thread-pool|process-pool]
                    Set the job pool type to the given type.
  --process-pool    (DEPRECATED: Use --pool-type=process-pool instead.)
  --thread-pool     (DEPRECATED: Use --pool-type=thread-pool instead.)

Output options:
  --headings / --no-headings  Set whether to include column headings in tabular
                              output.  [default: headings]
  --progress / --no-progress  Set whether to display a progress bar during
                              processing.  [default: progress]
  -T, --table-format [asciidoc|csv|csv-excel|csv-excel-tab|csv-unix|double-grid|double-outline|fancy-grid|fancy-outline|github|grid|heavy-grid|heavy-outline|html|jira|latex|latex-booktabs|latex-longtable|latex-raw|mediawiki|mixed-grid|mixed-outline|moinmoin|orgtbl|outline|pipe|plain|presto|pretty|psql|rounded-grid|rounded-outline|rst|simple|simple-grid|simple-outline|textile|tsv|unsafehtml|vertical|youtrack]
                              Set the rendering of tables to the given style.
                              [default: simple]

Other options:
  -h, --help  Show this message and exit.

Constraints:
  {--username, -u}  mutually exclusive
  {--password, -p}  mutually exclusive
  {--pool-type, --process-pool, --thread-pool}
                    mutually exclusive

The command requires:

• One or more nodes, from the Debugpanel Node Options (--node/-n, --nodes/-N).

• One or more AUIDs, from the Debugpanel AUID Options (--auid/-a, --auids/-A).

It also accepts Debugpanel Output Format Options (--table-format/-T, --headings//--no-headings, --progress//--no-progress) and Debugpanel Job Pool Options (--pool-size, --pool-size).

3.1.11. debugpanel reload-config

The debugpanel reload-config (or alternatively debugpanel rc) command is one of the Debugpanel Node Operations, used to cause nodes to reload their configuration. It has its own --help/-h option:

$ debugpanel reload-config --help
Usage: debugpanel reload-config [OPTIONS]
Aliases: rc

  Cause nodes to reload their configuration.

Node options:
  -n, --node NODE      Add NODE to the list of nodes to process.
  -N, --nodes FILE     Add the nodes in FILE to the list of nodes to process.
  -U, --username USER  Set the UI username to USER.  [default: (interactive
                       prompt)]
  -u USER              (DEPRECATED: Use -U instead.)
  -P, --password PASS  Set the UI password to PASS.  [default: (interactive
                       prompt)]
  -p PASS              (DEPRECATED: Use -P instead.)

Job pool options:
  --pool-size SIZE  Set the job pool size to SIZE.  [default: (CPU-dependent)]
  --pool-type [thread-pool|process-pool]
                    Set the job pool type to the given type.
  --process-pool    (DEPRECATED: Use --pool-type=process-pool instead.)
  --thread-pool     (DEPRECATED: Use --pool-type=thread-pool instead.)

Output options:
  --headings / --no-headings  Set whether to include column headings in tabular
                              output.  [default: headings]
  --progress / --no-progress  Set whether to display a progress bar during
                              processing.  [default: progress]
  -T, --table-format [asciidoc|csv|csv-excel|csv-excel-tab|csv-unix|double-grid|double-outline|fancy-grid|fancy-outline|github|grid|heavy-grid|heavy-outline|html|jira|latex|latex-booktabs|latex-longtable|latex-raw|mediawiki|mixed-grid|mixed-outline|moinmoin|orgtbl|outline|pipe|plain|presto|pretty|psql|rounded-grid|rounded-outline|rst|simple|simple-grid|simple-outline|textile|tsv|unsafehtml|vertical|youtrack]
                              Set the rendering of tables to the given style.
                              [default: simple]

Other options:
  -h, --help  Show this message and exit.

Constraints:
  {--username, -u}  mutually exclusive
  {--password, -p}  mutually exclusive
  {--pool-type, --process-pool, --thread-pool}
                    mutually exclusive

The command requires:

• One or more nodes, from the Debugpanel Node Options (--node/-n, --nodes/-N).

It also accepts Debugpanel Output Format Options (--table-format/-T, --headings//--no-headings, --progress//--no-progress) and Debugpanel Job Pool Options (--pool-size, --pool-size).

3.1.12. debugpanel tree

The debugpanel tree command displays the subcommand tree for Debugpanel:

$ debugpanel tree
debugpanel - Command line tool to interact with the LOCKSS 1.x DebugPanel servlet.
├── check-substance - Cause nodes to check the substance of AUs.
├── copyright - Show the copyright and exit.
├── crawl - Cause nodes to crawl AUs.
├── crawl-plugins - Cause nodes to crawl plugins.
├── deep-crawl - Cause nodes to deep-crawl AUs.
├── disable-indexing - Cause nodes to disable metadata indexing for AUs.
├── license - Show the software license and exit.
├── poll - Cause nodes to poll AUs.
├── reindex-metadata - Cause nodes to reindex the metadata of AUs.
├── reload-config - Cause nodes to reload their configuration.
├── tree - show the command tree of your CLI
├── validate-files - Cause nodes to validate the files of AUs.
└── version - Show the version number and exit.

3.1.13. debugpanel validate-files

The debugpanel validate-files (or alternatively debugpanel vf) command is one of the Debugpanel AU Operations, used to cause nodes to reindex the metadata of AUs. It has its own --help/-h option:

$ debugpanel validate-files --help
Usage: debugpanel validate-files [OPTIONS]
Aliases: vf

  Cause nodes to validate the files of AUs.

Node options:
  -n, --node NODE      Add NODE to the list of nodes to process.
  -N, --nodes FILE     Add the nodes in FILE to the list of nodes to process.
  -U, --username USER  Set the UI username to USER.  [default: (interactive
                       prompt)]
  -u USER              (DEPRECATED: Use -U instead.)
  -P, --password PASS  Set the UI password to PASS.  [default: (interactive
                       prompt)]
  -p PASS              (DEPRECATED: Use -P instead.)

AUID options:
  -a, --auid AUID   Add AUID to the list of AUIDs to process.
  -A, --auids FILE  Add the AUIDs in FILE to the list of AUIDs to process.

Job pool options:
  --pool-size SIZE  Set the job pool size to SIZE.  [default: (CPU-dependent)]
  --pool-type [thread-pool|process-pool]
                    Set the job pool type to the given type.
  --process-pool    (DEPRECATED: Use --pool-type=process-pool instead.)
  --thread-pool     (DEPRECATED: Use --pool-type=thread-pool instead.)

Output options:
  --headings / --no-headings  Set whether to include column headings in tabular
                              output.  [default: headings]
  --progress / --no-progress  Set whether to display a progress bar during
                              processing.  [default: progress]
  -T, --table-format [asciidoc|csv|csv-excel|csv-excel-tab|csv-unix|double-grid|double-outline|fancy-grid|fancy-outline|github|grid|heavy-grid|heavy-outline|html|jira|latex|latex-booktabs|latex-longtable|latex-raw|mediawiki|mixed-grid|mixed-outline|moinmoin|orgtbl|outline|pipe|plain|presto|pretty|psql|rounded-grid|rounded-outline|rst|simple|simple-grid|simple-outline|textile|tsv|unsafehtml|vertical|youtrack]
                              Set the rendering of tables to the given style.
                              [default: simple]

Other options:
  -h, --help  Show this message and exit.

Constraints:
  {--username, -u}  mutually exclusive
  {--password, -p}  mutually exclusive
  {--pool-type, --process-pool, --thread-pool}
                    mutually exclusive

The command requires:

• One or more nodes, from the Debugpanel Node Options (--node/-n, --nodes/-N).

• One or more AUIDs, from the Debugpanel AUID Options (--auid/-a, --auids/-A).

It also accepts Debugpanel Output Format Options (--table-format/-T, --headings//--no-headings, --progress//--no-progress) and Debugpanel Job Pool Options (--pool-size, --pool-size).

3.1.14. debugpanel version

The debugpanel version command displays the version number of Debugpanel and exits:

$ debugpanel version
0.9.0

3.2. Debugpanel Node Options

Note

As of version 0.9.0, --node/-n and --nodes/-N options only accept one argument at a time each, rather than one or more each.

Commands for Debugpanel Node Operations expect one or more node references in HOST:PORT format, for instance lockss.myuniversity.edu:8081. The set of nodes to process is derived from:

• The nodes listed as --node/-n options. Each --node/-n option accepts one node reference. The long option --node and its argument can optionally be joined by an equals sign.

• The node references found in the files listed as --nodes/-N options. Each --nodes/-N option accepts one file paths. The long option --nodes and its argument can optionally be joined by an equals sign.

Examples:

# --node without an equals sign
debugpanel reload-config --node node1:8081 --node node2:8081 --node node3:8081 ...

# Same, with --node abbreviated to -n
debugpanel reload-config -n node1:8081 -n node2:8081 -n node3:8081 ...

# --node with an equals sign
debugpanel reload-config --node=node1:8081 ...

# --nodes without an equals sign
debugpanel reload-config --nodes list1.txt --nodes list2.txt --nodes list3.txt ...

# Same, with --nodes abbreviated to -N
debugpanel reload-config -N list1.txt -N list2.txt -N list3.txt ...

# --nodes with an equals sign
debugpanel reload-config --nodes=list1.txt ...

3.3. Debugpanel AUID Options

In addition to Debugpanel Node Options, commands for Debugpanel AU Operations expect one or more AUIDs. The set of AUIDs to process is derived from:

• The AUIDs listed as --auid/-a options. Each --auid/-a option accepts one. The long option --auid and its argument can optionally be joined by an equals sign.

• The AUIDs found in the files listed as --auids/-A options. Each --auids/-A option accepts one file path. The long option --auids and its argument can optionally be joined by an equals sign.

Examples:

# --auid without an equals sign
debugpanel poll ... --auid auid1 --auids auid2 --auid auid3 ...

# Same, with --auid abbreviated to -a
debugpanel poll ... -a auid1 -a auid2 -a auid3 ...

# --auid with an equals sign
debugpanel poll ... --auid=auid1 ...

# --auids without an equals sign
debugpanel poll ... --auids list1.txt --auids list2.txt --auid list3.txt ...

# Same, with --auids abbreviated to -A
debugpanel poll ... -A list1.txt -A list2.txt -A list3.txt ...

# --auids with an equals sign
debugpanel poll ... --auids=list1.txt ...

3.4. Debugpanel Output Format Options

Note

As of version 0.9.0, --output-format has been renamed to --table-format/-T.

Debugpanel's tabular output is performed by the Click Extra library, via the --table-format/-T and --headings//--no-headings options. See its documentation or the --help/-h message of any Debugpanel node or AU command for a list of the various output formats available in the --table-format/-T option. The default value is simple. This option accepts a single argument, with or without an equals sign:

# Without an equals sign
debugpanel ... --table-format outline

# With an equals sign
debugpanel ... --table-format=outline

The --headings//--no-headings options control whether or not column headings are displayed, respectively. The default is --headings.

The --progress//--no-progress options control whether or not a progress bar of individual tasks is displayed, respectively. The default is --progress.

3.5. Debugpanel Job Pool Options

Note

As of version 0.9.0, --process-pool and thread-pool are deprecated in favor of --pool-type=process-pool and --pool-type=thread-pool respectively.

Debugpanel performs multiple operations in parallel, contacting multiple nodes and/or working on multiple AU requests per node, using a thread pool (--pool-type=thread-pool) or a process pool (--pool-type=process-pool). If neither is specified, by default a thread pool is used. You can change the size of the job pool with the --pool-size option, which accepts a nonzero integer. Note that the underlying implementation may limit the number of threads or processes despite a larger number requested at the command line. The default value depends on the system's CPU characteristics (represented in this document as "N"). Using --pool-type=thread-pool --pool-size=1 approximates no parallel processing.