DocumentsopnDossier
opnDossier_list_devices
opnDossier_list_devices
Type
External
Status
Published
Created
Jul 18, 2026
Updated
Jul 18, 2026

opnDossier list devices#

List supported device-config parsers

Synopsis#

List the device-configuration parsers the running opnDossier binary supports.

The output is sourced from the parser registry, so it always reflects what the
binary can actually accept for --device-type.

By default the command writes one name per line. Use --json to emit a structured
array of {name, description} objects suitable for jq or other automation.

opnDossier list devices [flags]

Examples#

  # Plain text, one device type per line
  opnDossier list devices

  # JSON output for automation
  opnDossier list devices --json

Options#

  -h, --help help for devices
      --json Emit a JSON array of {name, description} objects

Options inherited from parent commands#

      --color string Color output mode (auto, always, never) (default "auto")
      --config string Configuration file path (default: $HOME/.opnDossier.yaml)
      --debug Enable debug-level logging (all messages, for troubleshooting)
      --device-type string Force device type (supported: opnsense, pfsense). Bypasses auto-detection.
      --minimal Minimal output mode (suppresses progress and verbose messages)
      --no-progress Disable progress indicators
  -q, --quiet Suppress all output except errors and critical messages
      --timestamps Include timestamps in log output
  -v, --verbose Enable info-level logging (warnings, errors, and informational messages)

SEE ALSO#

  • opnDossier list - Enumerate supported plugins, devices, and output formats
Auto generated by spf13/cobra on 21-May-2026