ytti /oxidized

Oxidized is a network device configuration backup tool. It's a RANCID replacement!

★ 3,669⑂ 1,067👁 119⑃ 1,777● 2,185▤ 17
RubyApache-2.0Created 2013-04-17
下载:0.38.00.38.0 ↓0.38.02026-11-16
3,669
stars
1,067
forks
119
watchers
1,777
prs
2,185
issues
17
releases

README

Oxidized





Oxidized is a network device configuration backup tool. It's a RANCID replacement!

It is light and extensible and supports over 130 operating system types.

Feature highlights:

 Automatically adds/removes threads to meet configured retrieval interval
 Restful API to a move node immediately to head-of-queue (GET/PUT /node/next/[NODE])
 Syslog udp+file example to catch config change events (IOS/JunOS) and trigger a config fetch
   Will signal which IOS/JunOS user made the change, can then be used by output modules (via POST)
   The git output module uses this info - 'git blame' will show who changed each line
 Restful API to reload list of nodes (GET /reload)
 Restful API to fetch configurations (/node/fetch/[NODE] or /node/fetch/group/[NODE])
 Restful API to show list of nodes (GET /nodes)
 Restful API to show list of version for a node (/node/version[NODE]) and diffs

Check out the Oxidized TREX 2014 presentation video on YouTube!

 :warning: Maintainer Wanted! :warning:

 Is your company using Oxidized and has Ruby developers on staff? I'd love help from an extra maintainer!

 Index

1. Supported OS Types
2. Installation
     Debian and Ubuntu
     Rocky Linux, Red Hat Enterprise Linux
     FreeBSD
     Build from Git
     Docker & Podman
3. Initial Configuration
4. Configuration
     Debugging
     Privileged mode
     Disabling SSH exec channels
     Sources
       Source: CSV
       Source: SQL
       Source: SQLite
       Source: Mysql
       Source: HTTP
     Outputs
       Output: GIT
       Output: GIT-Crypt
       Output: HTTP
       Output: File
       Output types
     Advanced Configuration
     Advanced Group Configuration
     Hooks
       Hook: exec
       Hook: githubrepo
       Hook: awssns
       Hook: slackdiff
       Hook: xmppdiff
       Hook: ciscosparkdiff
5. Creating and Extending Models
6. Help
7. Help Needed
8. Ruby API
     Input
     Output
     Source
     Model

 Installation

 Debian and Ubuntu
Debian 12 "bookworm" or newer and Ubuntu 22.04 (Jammy Jellyfish) or newer are recommended. On Ubuntu, begin by enabling the universe
repository (required for libssh2-1-dev):

shell
add-apt-repository universe


Install the dependencies:

shell
apt install ruby ruby-dev libsqlite3-dev libssl-dev pkg-config cmake libssh2-1-dev libicu-dev zlib1g-dev g++ libyaml-dev libzstd-dev libgpg-error-dev


On Ubuntu 26.04 or newer, you also need libjitterentropy3-dev until
Ubuntu bug 2158026 is fixed:

shell
apt install libjitterentropy3-dev


Finally, install Oxidized:

shell
gem install oxidized


You can also install one or both of the optional gems. They are not required
to run Oxidized:
shell
gem install oxidized-web     Web interface and rest API
gem install oxidized-script  Script-based input/output extensions


 Rocky Linux, Red Hat Enterprise Linux
These instructions has been verified on Rocky Linux 9, Rocky Linux 10 and Fedora.

On Rocky Linux 9, you need to install/enable EPEL, CRB and Ruby 3.1:
shell
dnf install

Top issues

Latest release

0.38.0 0.38.0 2026-11-16
Release Notes
The git and gitcrypt outputs no longer provide the :date field in the node versions, as it was only used by oxidized-web = 0.17.0, older versions will fail to display node versions and diffs.

Oxidized no longer patches Puma's signal handling (needed for Puma 8). With oxidized-web  in oxidized-script, /reload?node= in oxidized-web), the node name must now match exactly. Previously, a node also matched when its name was contained in the requested name, so oxs router10 could run on router1.

net-ssh = 8.0 requires Diffie-Hellman group exchange groups of at least 2048 bits (pre

Snapshot: 2026-11-17T21:58:29Z · Data license Apache-2.0 · JSON