store

Documentation

Index

• type Attributes
• type Device
  • func (dev *Device) Attributes() (*Attributes, error)
• type Filter
  • func NewFilter(exprs []string) (*Filter, error)
  • func (filter *Filter) Run(attr *Attributes) (bool, error)
• type IPAddress
  • func (ipaddr *IPAddress) Attributes() (*Attributes, error)
• type PollerProfile
  • func (profile *PollerProfile) FilterExpressions() []string
• type Site
  • func (site *Site) Attributes() (*Attributes, error)
• type SiteGroup
  • func (sg *SiteGroup) Attributes() (*Attributes, error)
• type Store
  • func NewStore(nc *client.NetboxClient) *Store
  • func (store *Store) Devices(filter *Filter) ([]*Device, error)
  • func (store *Store) IPAddresses(filter *Filter) ([]*IPAddress, error)
  • func (store *Store) LookupIPAddress(tenant string, address string) (*Attributes, error)
  • func (store *Store) LookupPollerProfile(name string) (*PollerProfile, error)
  • func (store *Store) Refresh() error
  • func (store *Store) SiteGroups(filter *Filter) ([]*SiteGroup, error)
  • func (store *Store) Sites(filter *Filter) ([]*Site, error)
  • func (store *Store) Tenants(filter *Filter) ([]*Tenant, error)
  • func (store *Store) VirtualMachines(filter *Filter) ([]*VirtualMachine, error)
• type Tenant
  • func (t *Tenant) Attributes() (*Attributes, error)
• type VirtualMachine
  • func (vm *VirtualMachine) Attributes() (*Attributes, error)
  • func (vm *VirtualMachine) PollerProfile() (*PollerProfile, error)

Types

type Attributes

type Attributes struct {
	ID        int64
	Model     string
	Name      string
	Slug      string
	IP        string
	Role      string
	Site      string
	SiteGroup string
	Status    string
	Type      string
	Tenant    string
	CF        map[string]any
}

Attributes is a generalized view on data of different Netbox models used for filtering and indexing

type Device

type Device struct {
	*models.DeviceWithConfigContext
	SiteGroup *SiteGroup
}

func (*Device) Attributes

func (dev *Device) Attributes() (*Attributes, error)

type Filter

type Filter struct {
	// contains filtered or unexported fields
}

func NewFilter

func NewFilter(exprs []string) (*Filter, error)

func (*Filter) Run

func (filter *Filter) Run(attr *Attributes) (bool, error)

type IPAddress

type IPAddress struct {
	*models.IPAddress
	Site      *Site
	SiteGroup *SiteGroup
}

func (*IPAddress) Attributes

func (ipaddr *IPAddress) Attributes() (*Attributes, error)

type PollerProfile

type PollerProfile struct {
	Realm            string
	Site             string
	SiteGroup        string
	Tenant           string
	DiscoverySites   []string
	DiscoveryTenants []string
}

func (*PollerProfile) FilterExpressions

func (profile *PollerProfile) FilterExpressions() []string

type Site

type Site struct {
	*models.Site
	SiteGroup *SiteGroup
}

func (*Site) Attributes

func (site *Site) Attributes() (*Attributes, error)

type SiteGroup

type SiteGroup struct {
	*models.SiteGroup
}

func (*SiteGroup) Attributes

func (sg *SiteGroup) Attributes() (*Attributes, error)

type Store

type Store struct {
	// contains filtered or unexported fields
}

func NewStore

func NewStore(nc *client.NetboxClient) *Store

func (*Store) Devices

func (store *Store) Devices(filter *Filter) ([]*Device, error)

func (*Store) IPAddresses

func (store *Store) IPAddresses(filter *Filter) ([]*IPAddress, error)

func (*Store) LookupIPAddress

func (store *Store) LookupIPAddress(tenant string, address string) (*Attributes, error)

func (*Store) LookupPollerProfile

func (store *Store) LookupPollerProfile(name string) (*PollerProfile, error)

func (*Store) Refresh

func (store *Store) Refresh() error

func (*Store) SiteGroups

func (store *Store) SiteGroups(filter *Filter) ([]*SiteGroup, error)

func (*Store) Sites

func (store *Store) Sites(filter *Filter) ([]*Site, error)

func (*Store) Tenants

func (store *Store) Tenants(filter *Filter) ([]*Tenant, error)

func (*Store) VirtualMachines

func (store *Store) VirtualMachines(filter *Filter) ([]*VirtualMachine, error)

type Tenant

type Tenant struct {
	*models.Tenant
}

func (*Tenant) Attributes

func (t *Tenant) Attributes() (*Attributes, error)

type VirtualMachine

type VirtualMachine struct {
	*models.VirtualMachineWithConfigContext
	SiteGroup *SiteGroup
}

func (*VirtualMachine) Attributes

func (vm *VirtualMachine) Attributes() (*Attributes, error)

func (*VirtualMachine) PollerProfile

func (vm *VirtualMachine) PollerProfile() (*PollerProfile, error)