How to Install Oxidized on FreeBSD Latest

Oxidized is an open-source network device configuration backup tool. It automatically backs up network device configurations and provides a version-controlled history of changes.

In this tutorial, we will walk you through the steps to install Oxidized on FreeBSD Latest using GitHub.

Prerequisites

Step 1: Install Dependencies

Oxidized requires Ruby as a dependency. Use the following command to install Ruby:

$ sudo pkg install ruby

Step 2: Install Git

Git is required to clone the Oxidized repository. Use the following command to install Git:

$ sudo pkg install git

Step 3: Install Oxidized

  1. Use the following command to clone the Oxidized repository:

    $ git clone https://github.com/ytti/oxidized.git
    
  2. Navigate to the cloned directory:

    $ cd oxidized
    
  3. Use the following command to install Oxidized:

    $ gem install oxidized
    

Step 4: Configure Oxidized

  1. Copy the default Oxidized configuration file:

    $ cp oxidized/config.example oxidized/config
    
  2. Edit the oxidized/config file and update the following values:

    i. Set the username and password for your network devices.

    username: your_username
    password: your_password
    

    ii. Set the interval at which the configuration backups will be taken.

    interval: 3600
    

    iii. Set the output file type (text, JSON, or YAML) and location.

    output:
      default: text
      text:
        file: /home/user/oxidized/configs/:hostname.txt
    

    iv. Set the source for the Oxidized to look for network devices configurations.

    source:
      default: csv
    
      csv:
        file: /home/user/oxidized/devices.csv
        delimiter: !ruby/regexp /[,!]\s*/
    
        map:
          name: 0
          ip: 1
    
  3. Save and close the file.

Step 5: Test Oxidized

  1. Use the following command to test the Oxidized configuration:

    $ oxidized --config ~/.config/oxidized/config
    
  2. Verify that Oxidized successfully backed up network device configurations.

Conclusion

Congratulations! You have successfully installed and configured Oxidized on FreeBSD Latest using GitHub repository. You can now use Oxidized to automate network device configuration backups and manage version control.

If you want to self-host in an easy, hands free way, need an external IP address, or simply want your data in your own hands, give IPv6.rs a try!