openstack/pyeclib
Code Issues Proposed changes
Files
master
pyeclib/doc/source/cli.rst
Tim Burke 301e8f0cd7 Add some CLI tools 
pyeclib-backend version
      Print the versions of pyeclib, liberasurecode, and Python

   pyeclib-backend list
      List the status of backends

   pyeclib-backend check
      Check the status of a particular backend

   pyeclib-backend verify
      Verify the ability to decode given some unavailable fragments

   pyeclib-backend bench
      Benchmarks available backends

Co-Authored-By: Matthew Oliver <matt@oliver.net.au>
Signed-off-by: Tim Burke <tim.burke@gmail.com>
Change-Id: Ibe47b4665bfe763c07e68d8be0f92983bc15dff0
2025-08-25 15:48:02 -07:00

1.5 KiB
Raw Permalink Blame History

PyECLib CLI

PyECLib provides a pyeclib-backend tool to provide various information about backends.

version subcommand

pyeclib-backend [-V | version]

Displays the versions of pyeclib, liberasurecode, and python.

list subcommand

pyeclib-backend list [-a | --available] [<ec_type>]

Displays the status (available, missing, or unknwon) of requested backends. By default, all backends are displayed; if --available is provided, only available backends are displayed, and status is not displayed.

check subcommand

pyeclib-backend check [-q | --quiet] <ec_type>

Check whether a backend is available. Exits

  • 0 if ec_type is available,
  • 1 if ec_type is missing, or
  • 2 if ec_type is not recognized

If --quiet is provided, output nothing; rely only on exit codes.

verify subcommand

pyeclib-backend verify [-q | --quiet] [--ec-type=all]
    [--n-data=10] [--n-parity=5] [--unavailable=2] [--segment-size=1024]

Verify the ability to decode all combinations of fragments given some number of unavailable fragments.

bench subcommand

pyeclib-backend bench [-e | --encode] [-d | --decode] [--ec-type=all]
    [--n-data=10] [--n-parity=5] [--unavailable=2] [--segment-size=1048576]
    [--iterations=200]

Benchmark one or more backends.