Package: lockss-debugpanel
Debugpanel is a library and command line tool to interact with the LOCKSS 1.x DebugPanel servlet.Latest release:0.7.0-post1 (2023-05-02)Table of ContentsInstallationPrerequisitespipOverviewPer-Node OperationsPer-AU OperationsCommand Line ToolSynopsisCommandsTop-Level Programcheck-substancecopyrightcrawlcrawl-pluginsdeep-crawldisable-indexinglicensepollreindex-metadatareload-configusagevalidate-filesversionOptionsNode Arguments and OptionsAUID OptionsOutput Format ControlJob Pool ControlLibraryInstallationDebugpanel is available from thePython Package Index(PyPI) aslockss-debugpanel(https://pypi.org/project/lockss-debugpanel), and can be installed withpip.The installation process adds alockss.debugpanelPythonLibraryand adebugpanelCommand Line Tool. You can check at the command line that the installation is functional by runningdebugpanel versionordebugpanel--help.PrerequisitesPython3.7 or greater. (You can check the version of Python 3 withpython3--version.)Prerequisites for development work only:Poetry1.4 or greater. (You can check the version of Poetry withpoetry--version.)pipYou can install Debugpanel withpip.To install it in your own non-root, non-virtual environment, use the--useroption:pip3 install --user lockss-debugpanelTo install it in a virtual environment, simply use:pip3 install lockss-debugpanel!DANGER!Do not runpip3/pipasroot, withsudoor otherwise.OverviewPer-Node OperationsSome operations operate on one or more nodes.OperationCommandFunctionCrawl pluginscrawl-pluginscrawl_plugins()Reload node configurationreload-configreload_config()Per-AU OperationsSome operation operate on one or more AUs on one or more nodes.OperationCommandFunctionCheck substance of AUscheck-substancecheck_substance()Crawl AUscrawlcrawl()Crawl AUs with depthdeep-crawldeep_crawl()Disable metadata indexing of AUsdisable-indexingdisable_indexing()Pollpollpoll()Reindex AU metadatareindex-metadatareindex_metadata()Validate AU filesvalidate-filesvalidate_files()Command Line ToolDebugpanel is invoked at the command line as:debugpanelor as a Python module:python3 -m lockss.debugpanelHelp messages and this document usedebugpanelthroughout, but the two invocation styles are interchangeable.SynopsisDebugpanel usesCommands, in the style of programs likegit,dnf/yum,apt/apt-get, and the like. You can see the list of availableCommandsby invokingdebugpanel--help, and you can find a usage summary of all theCommandsby invokingdebugpanel usage:usage: debugpanel [-h] [--debug-cli] [--verbose] COMMAND ...

       debugpanel check-substance [-h] [--output-format FMT]
                                  [--node HOST:PORT] [--nodes FILE]
                                  [--password PASS] [--username USER]
                                  [--auid AUID] [--auids FILE]
                                  [--pool-size SIZE]
                                  [--process-pool | --thread-pool]
                                  [HOST:PORT ...]

       debugpanel copyright [-h]

       debugpanel crawl [-h] [--output-format FMT] [--node HOST:PORT]
                        [--nodes FILE] [--password PASS] [--username USER]
                        [--auid AUID] [--auids FILE] [--pool-size SIZE]
                        [--process-pool | --thread-pool]
                        [HOST:PORT ...]

       debugpanel crawl-plugins [-h] [--output-format FMT] [--node HOST:PORT]
                                [--nodes FILE] [--password PASS]
                                [--username USER] [--pool-size SIZE]
                                [--process-pool | --thread-pool]
                                [HOST:PORT ...]

       debugpanel deep-crawl [-h] [--output-format FMT] [--node HOST:PORT]
                             [--nodes FILE] [--password PASS]
                             [--username USER] [--auid AUID] [--auids FILE]
                             [--pool-size SIZE]
                             [--process-pool | --thread-pool] [--depth DEPTH]
                             [HOST:PORT ...]

       debugpanel disable-indexing [-h] [--output-format FMT]
                                   [--node HOST:PORT] [--nodes FILE]
                                   [--password PASS] [--username USER]
                                   [--auid AUID] [--auids FILE]
                                   [--pool-size SIZE]
                                   [--process-pool | --thread-pool]
                                   [HOST:PORT ...]

       debugpanel license [-h]

       debugpanel poll [-h] [--output-format FMT] [--node HOST:PORT]
                       [--nodes FILE] [--password PASS] [--username USER]
                       [--auid AUID] [--auids FILE] [--pool-size SIZE]
                       [--process-pool | --thread-pool]
                       [HOST:PORT ...]

       debugpanel reindex-metadata [-h] [--output-format FMT]
                                   [--node HOST:PORT] [--nodes FILE]
                                   [--password PASS] [--username USER]
                                   [--auid AUID] [--auids FILE]
                                   [--pool-size SIZE]
                                   [--process-pool | --thread-pool]
                                   [HOST:PORT ...]

       debugpanel reload-config [-h] [--output-format FMT] [--node HOST:PORT]
                                [--nodes FILE] [--password PASS]
                                [--username USER] [--pool-size SIZE]
                                [--process-pool | --thread-pool]
                                [HOST:PORT ...]

       debugpanel usage [-h]

       debugpanel validate-files [-h] [--output-format FMT] [--node HOST:PORT]
                                 [--nodes FILE] [--password PASS]
                                 [--username USER] [--auid AUID]
                                 [--auids FILE] [--pool-size SIZE]
                                 [--process-pool | --thread-pool]
                                 [HOST:PORT ...]

       debugpanel version [-h]CommandsThe available commands are:CommandAbbreviationPurposecheck-substancecscause nodes to check the substance of AUscopyrightshow copyright and exitcrawlcrcause nodes to crawl AUscrawl-pluginscpcause nodes to crawl pluginsdeep-crawldccause nodes to crawl AUs, with depthdisable-indexingdicause nodes to disable metadata indexing of AUslicenseshow license and exitpollpocause nodes to poll AUsreindex-metadataricause nodes to reindex the metadata of AUsreload-configrccause nodes to reload their configurationusageshow detailed usage and exitvalidate-filesvfcause nodes to run file validation on AUsversionshow version and exitTop-Level ProgramThe top-level executable alone does not perform any action or default to a given command. It does define a few options, which you can see by invoking Debugpanel with the--help/-hoption:usage: debugpanel [-h] [--debug-cli] [--verbose] COMMAND ...

options:
  -h, --help            show this help message and exit
  --debug-cli           print the result of parsing command line arguments
  --verbose, -v         print verbose output

commands:
  Add --help to see the command's own help message.

  COMMAND               DESCRIPTION
    check-substance (cs)
                        cause nodes to check the substance of AUs
    copyright           show copyright and exit
    crawl (cr)          cause nodes to crawl AUs
    crawl-plugins (cp)  cause nodes to crawl plugins
    deep-crawl (dc)     cause nodes to crawl AUs, with depth
    disable-indexing (di)
                        cause nodes to disable metadata indexing of AUs
    license             show license and exit
    poll (po)           cause nodes to poll AUs
    reindex-metadata (ri)
                        cause nodes to reindex the metadata of AUs
    reload-config (rc)  cause nodes to reload their configuration
    usage               show detailed usage and exit
    validate-files (vf)
                        Cause nodes to run file validation on AUs
    version             show version and exitcheck-substance(cs)Thecheck-substancecommand is one of thePer-AU Operations, used to cause nodes to check the substance of AUs. It has its own--help/-hoption:usage: debugpanel check-substance [-h] [--output-format FMT]
                                  [--node HOST:PORT] [--nodes FILE]
                                  [--password PASS] [--username USER]
                                  [--auid AUID] [--auids FILE]
                                  [--pool-size SIZE]
                                  [--process-pool | --thread-pool]
                                  [HOST:PORT ...]

Cause nodes to check the substance of AUs.

options:
  -h, --help            show this help message and exit
  --output-format FMT   set tabular output format to FMT (default: simple;
                        choices: asciidoc, 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, youtrack)

node arguments and options:
  HOST:PORT             node to process
  --node HOST:PORT, -n HOST:PORT
                        add HOST:PORT to the list of nodes to process
  --nodes FILE, -N FILE
                        add the nodes in FILE to the list of nodes to process
  --password PASS, -p PASS
                        UI password (default: interactive prompt)
  --username USER, -u USER
                        UI username (default: interactive prompt)

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

job pool options:
  --pool-size SIZE      nonzero size of job pool (default: N)
  --process-pool        use a process pool
  --thread-pool         use a thread pool (default)The command needs:One or more nodes, from theNode Arguments and Options(bare arguments,--node/-noptions,--nodes/-Noptions).One or more AUIDs, from theAUID Options(--auid/-aoptions,--auids/-Aoptions).It also acceptsOptionsforOutput Format ControlandJob Pool Control.copyrightThecopyrightcommand displays the copyright notice for Debugpanel and exits.crawl(cr)Thecrawlcommand is one of thePer-AU Operations, used to cause nodes to crawl AUs. It has its own--help/-hoption:usage: debugpanel crawl-plugins [-h] [--output-format FMT] [--node HOST:PORT]
                                [--nodes FILE] [--password PASS]
                                [--username USER] [--pool-size SIZE]
                                [--process-pool | --thread-pool]
                                [HOST:PORT ...]

Cause nodes to crawl plugins.

options:
  -h, --help            show this help message and exit
  --output-format FMT   set tabular output format to FMT (default: simple;
                        choices: asciidoc, 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, youtrack)

node arguments and options:
  HOST:PORT             node to process
  --node HOST:PORT, -n HOST:PORT
                        add HOST:PORT to the list of nodes to process
  --nodes FILE, -N FILE
                        add the nodes in FILE to the list of nodes to process
  --password PASS, -p PASS
                        UI password (default: interactive prompt)
  --username USER, -u USER
                        UI username (default: interactive prompt)

job pool options:
  --pool-size SIZE      nonzero size of job pool (default: N)
  --process-pool        use a process pool
  --thread-pool         use a thread pool (default)The command needs:One or more nodes, from theNode Arguments and Options(bare arguments,--node/-noptions,--nodes/-Noptions).One or more AUIDs, from theAUID Options(--auid/-aoptions,--auids/-Aoptions).It also acceptsOptionsforOutput Format ControlandJob Pool Control.crawl-plugins(cp)Thecrawl-pluginscommand is one of thePer-Node Operations, used to cause nodes to crawl their plugins. It has its own--help/-hoption:usage: debugpanel crawl-plugins [-h] [--output-format FMT] [--node HOST:PORT]
                                [--nodes FILE] [--password PASS]
                                [--username USER] [--pool-size SIZE]
                                [--process-pool | --thread-pool]
                                [HOST:PORT ...]

Cause nodes to crawl plugins.

options:
  -h, --help            show this help message and exit
  --output-format FMT   set tabular output format to FMT (default: simple;
                        choices: asciidoc, 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, youtrack)

node arguments and options:
  HOST:PORT             node to process
  --node HOST:PORT, -n HOST:PORT
                        add HOST:PORT to the list of nodes to process
  --nodes FILE, -N FILE
                        add the nodes in FILE to the list of nodes to process
  --password PASS, -p PASS
                        UI password (default: interactive prompt)
  --username USER, -u USER
                        UI username (default: interactive prompt)

job pool options:
  --pool-size SIZE      nonzero size of job pool (default: N)
  --process-pool        use a process pool
  --thread-pool         use a thread pool (default)The command needs:One or more nodes, from theNode Arguments and Options(bare arguments,--node/-noptions,--nodes/-Noptions).It also acceptsOptionsforOutput Format ControlandJob Pool Control.deep-crawl(dc)Thedeep-crawlcommand is one of thePer-AU Operations, used to cause nodes to crawl AUs with depth. It has its own--help/-hoption:usage: debugpanel deep-crawl [-h] [--output-format FMT] [--node HOST:PORT]
                             [--nodes FILE] [--password PASS]
                             [--username USER] [--auid AUID] [--auids FILE]
                             [--pool-size SIZE]
                             [--process-pool | --thread-pool] [--depth DEPTH]
                             [HOST:PORT ...]

Cause nodes to crawl AUs, with depth.

options:
  -h, --help            show this help message and exit
  --output-format FMT   set tabular output format to FMT (default: simple;
                        choices: asciidoc, 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, youtrack)
  --depth DEPTH, -d DEPTH
                        depth of deep crawls (default: 123)

node arguments and options:
  HOST:PORT             node to process
  --node HOST:PORT, -n HOST:PORT
                        add HOST:PORT to the list of nodes to process
  --nodes FILE, -N FILE
                        add the nodes in FILE to the list of nodes to process
  --password PASS, -p PASS
                        UI password (default: interactive prompt)
  --username USER, -u USER
                        UI username (default: interactive prompt)

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

job pool options:
  --pool-size SIZE      nonzero size of job pool (default: N)
  --process-pool        use a process pool
  --thread-pool         use a thread pool (default)The command needs:One or more nodes, from theNode Arguments and Options(bare arguments,--node/-noptions,--nodes/-Noptions).One or more AUIDs, from theAUID Options(--auid/-aoptions,--auids/-Aoptions).It has a unique option,--depth/-d, which is an integer specifying the desired crawl depth.It also acceptsOptionsforOutput Format ControlandJob Pool Control.disable-indexing(di)Thedisable-indexingcommand is one of thePer-AU Operations, used to cause nodes to disable metadata indexing of AUs. It has its own--help/-hoption:usage: debugpanel disable-indexing [-h] [--output-format FMT]
                                   [--node HOST:PORT] [--nodes FILE]
                                   [--password PASS] [--username USER]
                                   [--auid AUID] [--auids FILE]
                                   [--pool-size SIZE]
                                   [--process-pool | --thread-pool]
                                   [HOST:PORT ...]

Cause nodes to disable metadata indexing of AUs.

options:
  -h, --help            show this help message and exit
  --output-format FMT   set tabular output format to FMT (default: simple;
                        choices: asciidoc, 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, youtrack)

node arguments and options:
  HOST:PORT             node to process
  --node HOST:PORT, -n HOST:PORT
                        add HOST:PORT to the list of nodes to process
  --nodes FILE, -N FILE
                        add the nodes in FILE to the list of nodes to process
  --password PASS, -p PASS
                        UI password (default: interactive prompt)
  --username USER, -u USER
                        UI username (default: interactive prompt)

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

job pool options:
  --pool-size SIZE      nonzero size of job pool (default: N)
  --process-pool        use a process pool
  --thread-pool         use a thread pool (default)The command needs:One or more nodes, from theNode Arguments and Options(bare arguments,--node/-noptions,--nodes/-Noptions).One or more AUIDs, from theAUID Options(--auid/-aoptions,--auids/-Aoptions).It also acceptsOptionsforOutput Format ControlandJob Pool Control.licenseThelicensecommand displays the license terms for Debugpanel and exits.poll(po)Thepollcommand is one of thePer-AU Operations, used to cause nodes to poll AUs. It has its own--help/-hoption:usage: debugpanel poll [-h] [--output-format FMT] [--node HOST:PORT]
                       [--nodes FILE] [--password PASS] [--username USER]
                       [--auid AUID] [--auids FILE] [--pool-size SIZE]
                       [--process-pool | --thread-pool]
                       [HOST:PORT ...]

Cause nodes to poll AUs.

options:
  -h, --help            show this help message and exit
  --output-format FMT   set tabular output format to FMT (default: simple;
                        choices: asciidoc, 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, youtrack)

node arguments and options:
  HOST:PORT             node to process
  --node HOST:PORT, -n HOST:PORT
                        add HOST:PORT to the list of nodes to process
  --nodes FILE, -N FILE
                        add the nodes in FILE to the list of nodes to process
  --password PASS, -p PASS
                        UI password (default: interactive prompt)
  --username USER, -u USER
                        UI username (default: interactive prompt)

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

job pool options:
  --pool-size SIZE      nonzero size of job pool (default: N)
  --process-pool        use a process pool
  --thread-pool         use a thread pool (default)The command needs:One or more nodes, from theNode Arguments and Options(bare arguments,--node/-noptions,--nodes/-Noptions).One or more AUIDs, from theAUID Options(--auid/-aoptions,--auids/-Aoptions).It also acceptsOptionsforOutput Format ControlandJob Pool Control.reindex-metadata(ri)Thereindex-metadatacommand is one of thePer-AU Operations, used to cause nodes to reindex the metadata of AUs. It has its own--help/-hoption:usage: debugpanel reindex-metadata [-h] [--output-format FMT]
                                   [--node HOST:PORT] [--nodes FILE]
                                   [--password PASS] [--username USER]
                                   [--auid AUID] [--auids FILE]
                                   [--pool-size SIZE]
                                   [--process-pool | --thread-pool]
                                   [HOST:PORT ...]

Cause nodes to reindex the metadata of AUs.

options:
  -h, --help            show this help message and exit
  --output-format FMT   set tabular output format to FMT (default: simple;
                        choices: asciidoc, 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, youtrack)

node arguments and options:
  HOST:PORT             node to process
  --node HOST:PORT, -n HOST:PORT
                        add HOST:PORT to the list of nodes to process
  --nodes FILE, -N FILE
                        add the nodes in FILE to the list of nodes to process
  --password PASS, -p PASS
                        UI password (default: interactive prompt)
  --username USER, -u USER
                        UI username (default: interactive prompt)

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

job pool options:
  --pool-size SIZE      nonzero size of job pool (default: N)
  --process-pool        use a process pool
  --thread-pool         use a thread pool (default)The command needs:One or more nodes, from theNode Arguments and Options(bare arguments,--node/-noptions,--nodes/-Noptions).One or more AUIDs, from theAUID Options(--auid/-aoptions,--auids/-Aoptions).It also acceptsOptionsforOutput Format ControlandJob Pool Control.reload-config(rc)Thereload-configcommand is one of thePer-Node Operations, used to cause nodes to reload their configuration. It has its own--help/-hoption:usage: debugpanel reload-config [-h] [--output-format FMT] [--node HOST:PORT]
                                [--nodes FILE] [--password PASS]
                                [--username USER] [--pool-size SIZE]
                                [--process-pool | --thread-pool]
                                [HOST:PORT ...]

Cause nodes to reload their configuration.

options:
  -h, --help            show this help message and exit
  --output-format FMT   set tabular output format to FMT (default: simple;
                        choices: asciidoc, 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, youtrack)

node arguments and options:
  HOST:PORT             node to process
  --node HOST:PORT, -n HOST:PORT
                        add HOST:PORT to the list of nodes to process
  --nodes FILE, -N FILE
                        add the nodes in FILE to the list of nodes to process
  --password PASS, -p PASS
                        UI password (default: interactive prompt)
  --username USER, -u USER
                        UI username (default: interactive prompt)

job pool options:
  --pool-size SIZE      nonzero size of job pool (default: N)
  --process-pool        use a process pool
  --thread-pool         use a thread pool (default)The command needs:One or more nodes, from theNode Arguments and Options(bare arguments,--node/-noptions,--nodes/-Noptions).It also acceptsOptionsforOutput Format ControlandJob Pool Control.usageTheusagecommand displays the usage message of all the DebugpanelCommands.validate-files(vf)Thevalidate-filescommand is one of thePer-AU Operations, used to cause nodes to reindex the metadata of AUs. It has its own--help/-hoption:usage: debugpanel validate-files [-h] [--output-format FMT] [--node HOST:PORT]
                                 [--nodes FILE] [--password PASS]
                                 [--username USER] [--auid AUID]
                                 [--auids FILE] [--pool-size SIZE]
                                 [--process-pool | --thread-pool]
                                 [HOST:PORT ...]

Cause nodes to run file validation on AUs.

options:
  -h, --help            show this help message and exit
  --output-format FMT   set tabular output format to FMT (default: simple;
                        choices: asciidoc, 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, youtrack)

node arguments and options:
  HOST:PORT             node to process
  --node HOST:PORT, -n HOST:PORT
                        add HOST:PORT to the list of nodes to process
  --nodes FILE, -N FILE
                        add the nodes in FILE to the list of nodes to process
  --password PASS, -p PASS
                        UI password (default: interactive prompt)
  --username USER, -u USER
                        UI username (default: interactive prompt)

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

job pool options:
  --pool-size SIZE      nonzero size of job pool (default: N)
  --process-pool        use a process pool
  --thread-pool         use a thread pool (default)The command needs:One or more nodes, from theNode Arguments and Options(bare arguments,--node/-noptions,--nodes/-Noptions).One or more AUIDs, from theAUID Options(--auid/-aoptions,--auids/-Aoptions).It also acceptsOptionsforOutput Format ControlandJob Pool Control.versionTheversioncommand displays the version number of Debugpanel and exits.OptionsNode Arguments and OptionsCommandsforPer-Node Operationsexpect one or more node references inHOST:PORTformat, for instancelockss.myuniversity.edu:8081. The list of nodes to process is derived from:The nodes listed as bare arguments to the command.The nodes listed as--node/-noptions.The nodes found in the files listed as--nodes/-Noptions.AUID OptionsIn addition toNode Arguments and Options,CommandsforPer-AU Operationsexpect one or more AUIDs. The list of AUIDs to target is derived from:The AUIDs listed as--auid/-aoptions.The AUIDs found in the files listed as--auids/-Aoptions.Output Format ControlDebugpanel’s tabular output is performed by thetabulatelibrary through the--output-formatoption. See its PyPI page for a visual reference of the various output formats available. Thedefaultissimple.Job Pool ControlDebugpanel performs multiple operations (contacting multiple nodes and/or working on multiple AU requests per node) in parallel using a thread pool (--thread-pool, the default) or a process pool (--process-pool). You can change the size of the job pool with the--pool-sizeoption, which accepts a nonzero integer. Note that the underlying implementation may limit the number of threads or processes despite a larger number at the command line. The default value depends on the system’s CPU characteristics (represented in this document as “N”). Using--thread-pool--pool-size=1approximates no parallel processing.LibraryYou can use Debugpanel as a Python library.Thelockss.debugpanelmodule’snode()method can create a node object from a node reference (a string likehost:8081,http://host:8081,http://host:8081/,https://host:8081,https://host:8081/; no protocol defaults tohttp://), a username, and a password.This node object can be used as the argument tocrawl_plugins()orreload_config().It can also be used as the first argument tocheck_substance(),crawl(),deep_crawl(),disable_indexing(),poll(),reindex_metadata(), orvalidate_files(), together with an AUID string as the second argument.Thedeep_crawl()method has an optional third argument,depth, for the crawl depth (whch defaults tolockss.debugpanel.DEFAULT_DEPTH).All operations return the modifiedhttp.client.HTTPResponseobject fromurllib.request.urlopen()(seehttps://docs.python.org/3.7/library/urllib.request.html#urllib.request.urlopen). A status code of 200 indicates that the request to the node was made successfully (but not much else; for example if there is no such AUID for an AUID operation, nothing happens).Use of the module is illustrated in this example:import getpass
import lockss.debugpanel

hostport = '...'
username = input('Username: ')
password = getpass.getpass('Password: ')
node = lockss.debugpanel.node(hostport, username, password)
auid = '...'

try:
    resp = lockss.debugpanel.poll(node, auid)
    if resp.status == 200:
        print('Poll requested (200)')
    else:
        print(f'{resp.reason} ({resp.status})')
except Exception as exc:
    print(f'Error: {exc!s}')