List nodes (network devices) managed by Oxidized.

Returns each node's name, full name (group/name), IP, group, model, last run status and time, and last run details. Node vars are redacted unless redaction is disabled in the server configuration. Pass a group or model on large installations: they are filtered by Oxidized itself, so only matching nodes are transferred. The group must match exactly; use find_nodes when unsure of the name.

Get details of a single Oxidized node.

Returns the node's name, full name, IP, group, model, vars and details of its last backup run (start, end, status, duration).

Find nodes by partial name, full name or IP address.

Useful to resolve an ambiguous device name before calling other tools. Exact matches are listed first, then prefix matches, then other substring matches (all case-insensitive).

Summarise backup health across Oxidized nodes.

Computed from the node list (oxidized-web's own stats JSON is not usable): counts per last-run status, per group and per model, the success rate, and lists of failed nodes, nodes never backed up and stale nodes. Optionally limited to one group or model, filtered by Oxidized itself.

"Stale" means Oxidized has not attempted a backup within the threshold (e.g. it is not polling the node); nodes that are attempted but keep failing are listed under failed_nodes instead. Oxidized does not expose the time of the last successful backup, and its run history is kept in memory only (reset on restart). Right after trigger_node_backup a node briefly shows as never backed up, because Oxidized clears its last run while it is queued.

Get the latest backed-up configuration of a node.

Large configurations are paged by lines: when 'truncated' is true, call again with offset set to 'next_offset' to read the rest.

Search the latest configurations of all nodes for a pattern.

oxidized-web first finds the nodes whose configuration matches, then those configurations are fetched to return the matching lines with line numbers. Use this to answer questions such as "which devices still have telnet enabled" or "where is VLAN 42 configured".

The pattern must be valid in both Ruby (oxidized-web) and Python regular expressions - stick to common syntax. Lines are matched one at a time, so patterns spanning several lines find nodes but no lines.

List the stored configuration versions of a node, newest first.

Each version has its git oid, date, author and commit message. Requires the Oxidized 'git' (or 'gitcrypt') output.

Get the configuration of a node as it was at a specific version.

Large configurations are paged by lines: when 'truncated' is true, call again with offset set to 'next_offset' to read the rest.

Show what changed in a node's configuration between two versions.

Returns a unified diff from 'base_oid' (older) to 'oid' (newer). With no arguments besides the node it shows the most recent change.

Queue an immediate configuration backup of a node.

Oxidized moves the node to the head of its queue; the backup itself runs asynchronously. Check get_node afterwards for the run result, and list_node_versions for a new version if the configuration changed. Oxidized picks the node by name or IP only (no group), so node names must be unique - otherwise the first node with that name is queued.

Reload the Oxidized node list from its source (router.db, SQL, HTTP, ...).

Use after devices were added, removed or changed in the source so Oxidized picks up the change without waiting for its next refresh. Always reloads every node: oxidized-web's per-node reload (/reload?node=X) replaces the whole in-memory node list with just the matching nodes, so it is deliberately not offered.

Returns: Dictionary with Oxidized's response message