opn_download_config
Download a full OPNsense config.xml backup as raw XML for archival; sensitive values are redacted by default, and unparseable configs are refused rather than returned.
Instructions
Download OPNsense config.xml backup as raw XML.
Use this ONLY when you need a full XML backup for archival purposes. For analyzing specific config sections, use opn_scan_config to build a cached inventory, then opn_get_config_section to query individual sections.
By default, sensitive data (passwords, keys, secrets) is redacted; a config that cannot be parsed for redaction is refused, never returned raw. include_sensitive=true additionally requires OPNSENSE_ALLOW_SENSITIVE=true in the server environment — without it, the call is refused. Returns: dict with 'config_xml' (str), 'stripped' (bool), 'size_bytes' (int), or 'error'/'error_type' when the config cannot be parsed.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "opn_download_config"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| include_sensitive | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||