Skip to content

validate

opnDossier validate

Validate OPNsense configuration files

Synopsis

The 'validate' command checks one or more OPNsense config.xml files for structural and semantic correctness without performing any conversion. This is useful for verifying configuration integrity before processing or for automated quality checks in CI/CD pipelines.

The validation includes: - XML syntax validation - OPNsense schema validation - Required field validation - Cross-field consistency checks - Enum value validation

Examples: # Validate a single configuration file opnDossier validate config.xml

# Validate multiple configuration files opnDossier validate config1.xml config2.xml config3.xml

# Validate with verbose output to see detailed validation results opnDossier --verbose validate config.xml

# Validate with quiet mode (only show errors) opnDossier --quiet validate config.xml

opnDossier validate [file ...] [flags]

Options

  -h, --help          help for validate
      --json-output   Output errors in JSON format (for machine consumption)

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 - opnDossier: A CLI tool for processing OPNsense and pfSense configuration files.
Auto generated by spf13/cobra on 20-Apr-2026