Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

devicesync

package

Go to main page

Versions in this module

v1

v1.1.1

Sep 20, 2026

v1.1.0

Sep 15, 2026

v1.0.9

Sep 8, 2026

v1.0.8

Sep 8, 2026

v1.0.7

Sep 8, 2026

v1.0.6

Sep 8, 2026

v1.0.5

Sep 6, 2026

v1.0.4

Sep 3, 2026

Changes in this version

type FactumAPI

+ ApplyOpticalInventory func(deviceID uint, inv optical.Inventory) (*optical.ApplyResult, error)

type NetboxAPI

+ UpdateDevice func(deviceID uint, changes map[string]any) error

type NetboxMgr

+ func (m *NetboxMgr) UpdateDevice(device *models.Device, changes map[string]any) error

v1.0.3

Sep 1, 2026

Changes in this version

type FactumAPI

+ GetServiceTypes func() ([]models.ServiceType, error)

type NetboxAPI

+ CreateCableWithOptions func(aInterfaceID, bInterfaceID uint, extra map[string]any) (*netboxtool.NBCable, error)

+ CreateVRF func(name, rd, description string) (*netboxtool.NBVRF, error)

+ GetVRFByName func(name string) (*netboxtool.NBVRF, error)

type NetboxMgr

+ func (m *NetboxMgr) EnsureL2VPN(deviceName, name, l2vpnType string, identifier int) (*netboxtool.NBL2VPN, error)

+ func (m *NetboxMgr) EnsureVRF(deviceName, name, rd, description string) (*netboxtool.NBVRF, error)

v1.0.2

Aug 31, 2026

v1.0.1

Aug 21, 2026

v1.0.0

Aug 21, 2026

Changes in this version

+ func FetchRemoteConfig(factumConfig *util.ConfigFactum) (*util.ConfigDeviceSync, error)

+ func Sync(api NetboxAPI, factumAPI FactumAPI, cfg *util.ConfigDeviceSync, ...) error

+ type DeviceSync struct

+ type FactumAPI interface

+ GetDeviceByName func(name string) (*models.Device, error)

+ GetDevices func() ([]*models.Device, error)

+ type NetboxAPI interface

+ AddressDelete func(addressID int) error

+ AddressUpdate func(addressID int, changes map[string]any) error

+ CreateCable func(aInterfaceID, bInterfaceID uint) (*netboxtool.NBCable, error)

+ CreateInterfaceAddress func(interfaceID uint, address string, extra map[string]any) (*netboxtool.NBAddress, error)

+ CreateInterfaceWithOptions func(deviceID uint, name string, extra map[string]any) (*netboxtool.NetboxInterfaceREST, error)

+ CreateL2VPN func(name, slug, l2vpnType string, identifier int) (*netboxtool.NBL2VPN, error)

+ CreateL2VPNTermination func(l2vpnID, interfaceID uint) (*netboxtool.NBL2VPNTermination, error)

+ CreatePrefix func(prefix string) (*netboxtool.NBPrefix, error)

+ CreateVlan func(vid int, name string, groupID uint) (*netboxtool.NBVlan, error)

+ CreateVlanGroup func(name, slug string) (*netboxtool.NBVlanGroup, error)

+ DeleteCable func(cableID uint) error

+ GetCable func(cableID uint) (*netboxtool.NBCable, error)

+ GetDevice func(name string, id int) (*netboxtool.NBDevice, error)

+ GetDeviceType func(manufacturer, model string) (*netboxtool.NetboxDeviceTypeDetail, error)

+ GetDevices func() ([]*netboxtool.NBDevice, error)

+ GetL2VPNByIdentifier func(identifier int) (*netboxtool.NBL2VPN, error)

+ GetL2VPNByName func(name string) (*netboxtool.NBL2VPN, error)

+ GetL2VPNTerminations func(l2vpnID uint) ([]*netboxtool.NBL2VPNTermination, error)

+ GetPrefix func(prefix string) (*netboxtool.NBPrefix, error)

+ GetVlan func(vid int, groupID uint) (*netboxtool.NBVlan, error)

+ GetVlanGroup func(name string) (*netboxtool.NBVlanGroup, error)

+ InterfaceDelete func(interfaceID int) error

+ InterfaceUpdate func(interfaceID int, changes map[string]any) error

+ UpdateCableTermination func(cableID uint, side int, interfaceID uint) error

+ UpdateL2VPN func(l2vpnID uint, changes map[string]any) error

+ UpdateVlan func(id uint, changes map[string]any) error

+ type NetboxMgr struct

+ func NewNetboxMgr(api NetboxAPI, reporter jobevent.Reporter) *NetboxMgr

+ func (m *NetboxMgr) BuildInterfaceVlanChanges(mode string, untaggedVID int, taggedVIDs []int) (map[string]any, error)

+ func (m *NetboxMgr) CreateAddress(device *models.Device, iface *models.Interface, address string, ...) (*netboxtool.NBAddress, error)

+ func (m *NetboxMgr) CreateCable(device, remoteDevice *models.Device, localIface, remoteIface *models.Interface) error

+ func (m *NetboxMgr) CreateInterface(device *models.Device, iface *drivers.Interface) (*netboxtool.NetboxInterfaceREST, error)

+ func (m *NetboxMgr) DeleteAddress(device *models.Device, iface *models.Interface, addr *models.Address) error

+ func (m *NetboxMgr) DeleteCable(cable *netboxtool.NBCable) error

+ func (m *NetboxMgr) DeleteInterface(device *models.Device, iface *models.Interface) error

+ func (m *NetboxMgr) EnsureL2VPNEVPL(deviceName, name string, identifier int) (*netboxtool.NBL2VPN, error)

+ func (m *NetboxMgr) EnsureL2VPNTermination(deviceName, l2vpnName string, l2vpnID, interfaceID uint, ifaceName string, ...) error

+ func (m *NetboxMgr) EnsurePrefix(prefix string) error

+ func (m *NetboxMgr) EnsureVlan(vid int, name string) (*netboxtool.NBVlan, error)

+ func (m *NetboxMgr) EnsureVlanGroup(name string) (uint, error)

+ func (m *NetboxMgr) GetL2VPNTerminations(l2vpnID uint) ([]*netboxtool.NBL2VPNTermination, error)

+ func (m *NetboxMgr) SetConnectionTermination(device *models.Device, cable *netboxtool.NBCable, side int, ...) error

+ func (m *NetboxMgr) TemplateInterfaceTypes(manufacturer, model string) (map[string]string, error)

+ func (m *NetboxMgr) UpdateAddress(device *models.Device, iface *models.Interface, addr *models.Address, ...) error

+ func (m *NetboxMgr) UpdateInterface(device *models.Device, iface *models.Interface, changes map[string]any) error

+ func (m *NetboxMgr) VlanNetboxID(vid int) (uint, bool)

+ type SyncOptions struct

+ Name string

+ Platform string

+ Unattended bool