Skip to content

Latest commit

 

History

History
315 lines (189 loc) · 5.99 KB

USAGE.md

File metadata and controls

315 lines (189 loc) · 5.99 KB

CLI Reference

Usage:

$ pearasys [OPTIONS] COMMAND [ARGS]...

Options:

  • -v, --verbose: Verbose output.
  • -s, --slot slot: <domain>:<bus>:<device>.<func>
  • -d, --pid pid: <vendor>:<device>
  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • pci: Access PCI related resources under...
  • service: pearasys systemd service related commands.

pearasys pci

Access PCI related resources under /sys/bus/pci

Usage:

$ pearasys pci [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

Options:

  • --help: Show this message and exit.

Commands:

  • rescan: Forces a rescan and re-discovers removed...
  • device: Access resources under /sys/bus/pci/devices/
  • driver: Access resources under /sys/bus/pci/drivers/

pearasys pci rescan

Forces a rescan and re-discovers removed devices.

Usage:

$ pearasys pci rescan [OPTIONS]

Options:

  • --help: Show this message and exit.

pearasys pci device

See the (https://www.kernel.org/doc/Documentation/ABI/testing/sysfs-bus-pci)

Usage:

$ pearasys pci device [OPTIONS] COMMAND [ARGS]...

Options:

  • -s, --slot slot: <domain>:<bus>:<device>.<func>
  • -d, --pid pid: <vendor>:<device>
  • --driver driver_name: Driver to be used, overriding the current driver (if any). Example: pearasys -s <slot> pci device --driver=vfio-pci bind
  • --help: Show this message and exit.

Commands:

  • driver-override: ...
  • bind: /sys/bus/pci/devices/&lt;device&gt;/driver/bind
  • unbind: /sys/bus/pci/devices/&lt;device&gt;/driver/unbind
  • new-id: /sys/bus/pci/devices/&lt;device&gt;/driver/new_id
  • remove-id: /sys/bus/pci/devices/&lt;device&gt;/driver/remove_id
  • remove: /sys/bus/pci/devices/&lt;device&gt;/remove
  • rescan: /sys/bus/pci/devices/&lt;device&gt;/rescan
  • reset: /sys/bus/pci/devices/&lt;device&gt;/reset

pearasys pci device driver-override

/sys/bus/pci/devices/&lt;device&gt;/driver_override

Usage:

$ pearasys pci device driver-override [OPTIONS]

Options:

  • --help: Show this message and exit.

pearasys pci device bind

Attempts to bind the specified device(s) to the driver given by the argument. Unbinds the device(s) from it's current driver, if any.

Usage:

$ pearasys pci device bind [OPTIONS]

Options:

  • --help: Show this message and exit.

pearasys pci device unbind

Unbinds the specified device(s) from it's currently bound driver(s).

Usage:

$ pearasys pci device unbind [OPTIONS]

Options:

  • --help: Show this message and exit.

pearasys pci device new-id

Adds the device ID of the specified devices to it's currently bound driver, or the value of --driver if specified.

Usage:

$ pearasys pci device new-id [OPTIONS]

Options:

  • --help: Show this message and exit.

pearasys pci device remove-id

Removes the device ID of the specified devices to it's currently bound driver, or the value of --driver if specified.

Usage:

$ pearasys pci device remove-id [OPTIONS]

Options:

  • --help: Show this message and exit.

pearasys pci device remove

Removes device from kernel's list

Usage:

$ pearasys pci device remove [OPTIONS]

Options:

  • --help: Show this message and exit.

pearasys pci device rescan

Rescans the device's parent/child bus(es).

Usage:

$ pearasys pci device rescan [OPTIONS]

Options:

  • --help: Show this message and exit.

pearasys pci device reset

Resets the device if a reset function is present.

Usage:

$ pearasys pci device reset [OPTIONS]

Options:

  • --help: Show this message and exit.

pearasys pci driver

See the (https://www.kernel.org/doc/Documentation/filesystems/sysfs-pci.txt)

Usage:

$ pearasys pci driver [OPTIONS] driver_name COMMAND [ARGS]...

Arguments:

  • driver_name: [required]

Options:

  • -s, --slot slot: <domain>:<bus>:<device>.<func>
  • -d, --pid pid: <vendor>:<device>
  • --help: Show this message and exit.

Commands:

  • bind: /sys/bus/pci/drivers/.../bind
  • unbind: /sys/bus/pci/drivers/.../unbind
  • new-id: /sys/bus/pci/drivers/.../new_id
  • remove-id: /sys/bus/pci/drivers/.../remove_id

pearasys pci driver bind

/sys/bus/pci/drivers/.../bind

Usage:

$ pearasys pci driver bind [OPTIONS]

Options:

  • --help: Show this message and exit.

pearasys pci driver unbind

/sys/bus/pci/drivers/.../unbind

Usage:

$ pearasys pci driver unbind [OPTIONS]

Options:

  • --help: Show this message and exit.

pearasys pci driver new-id

/sys/bus/pci/drivers/.../new_id

Usage:

$ pearasys pci driver new-id [OPTIONS]

Options:

  • --help: Show this message and exit.

pearasys pci driver remove-id

/sys/bus/pci/drivers/.../remove_id

Usage:

$ pearasys pci driver remove-id [OPTIONS]

Options:

  • --help: Show this message and exit.

pearasys service

pearasys systemd service related commands.

Usage:

$ pearasys service [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • install: Installs a systemd service to manage a...

pearasys service install

Installs a systemd service to manage a device's driver.

Usage:

$ pearasys service install [OPTIONS] driver_name

Arguments:

  • driver_name: [required]

Options:

  • --prefix path: Specify the service installation directory. [default: /etc/systemd/system]
  • --help: Show this message and exit.