Netbox-Sync

Imagine this, you are managing your infrastructure for your lab or server farm using the popular NetBox tool. Everytime you install a new machine you connect to it and collect all the system's information to enter into NetBox. Including stuff like system resources, architecture, vendor, type and all the network interfaces. Tedious isn't it?

Well, this is where NetBox-Sync comes in (name subject to change). NetBox-Sync is going to be a CLI application, written in Rust, that will automatically collect your machine's details and send them to your NetBox instance. This will make it easier for you to install and update your inventory.

If you want to learn Rust and help me build this project please reach out to me through the public channels linked in my GitHub Profile, your help is greatly appreciated!

Goal for this Hackweek

There are multiple goals for this Hackweek. Split into the main focus and nice-to-have goals.

Main Focus

  • [x] Get a working API client for Netbox-Sync so it can communicate with a Netbox instance
  • [ ] Implement functions to create machines/VMs and get a list of existing ones.
  • [ ] Implement a "publisher" module to "steer" API calls.

Acceptance criteria for this goal

  • [x] NetBox-Sync is correctly addressing the right NetBox URI from config file or CLI according to set hierarchy.
  • [ ] The payload data is in the correct format

Nice-To-Have

  • [x] Error Handling PR is done and documented correctly.

Resources

NetBox-Sync Repository: https://github.com/ByteOtter/netbox-sync

API-Client PR: https://github.com/ByteOtter/netbox-sync/pull/36

Netbox Documentation: https://docs.netbox.dev/en/stable/

Who I need

People with some Rust knowledge and familiarity with OpenAPI stuff would be a huge help I think. But anyone is welcome! :)

Looking for hackers with the skills:

rust netbox cli systemsmanagement

This project is part of:

Hack Week 23

Activity

  • 7 months ago: smflood liked this project.
  • 7 months ago: renxt0310 liked this project.
  • 7 months ago: jzerebecki liked this project.
  • 8 months ago: digitaltomm liked this project.
  • 8 months ago: chock added keyword "systemsmanagement" to this project.
  • 8 months ago: chock joined this project.
  • 8 months ago: mfriedrich started this project.
  • 8 months ago: c-hagenest liked this project.
  • 8 months ago: chock added keyword "rust" to this project.
  • 8 months ago: chock removed keyword systemsmanagement from this project.
  • 8 months ago: chock added keyword "rust" to this project.
  • 8 months ago: chock added keyword "netbox" to this project.
  • 8 months ago: chock added keyword "cli" to this project.
  • 8 months ago: chock added keyword "systemsmanagement" to this project.
  • 8 months ago: chock originated this project.

  • Comments

    Be the first to comment!

    Similar Projects

    A Flight Dynamics Library written in Rust with an Entity Component System architecture by vcuadradojuan

    [comment]: # (Please use the project descriptio...


    Relm4-based user interface for Agama by IGonzalezSosa

    Motivation

    Disclaimer: the idea of this pr...


    toniowm by fabriziosestito

    toniowm is yet another window manager written i...


    Waysettings by dspinella

    [comment]: # (Please use the project descriptio...


    Kanidm - Account Policy by firstyear

    Project Description

    Kanidm is a identity ...


    Rancher Upgrader - Upgrades your rancher install via helm, and communicates critical changes from release A to B. by rweir

    [comment]: # (Please use the project descriptio...


    A CLI for Harvester by mohamed.belgaied

    [comment]: # Harvester does not officially come...