client

Documentation

Index

• type CustomFieldSet
  • func (cfs *CustomFieldSet) Bool(name string) (*bool, error)
  • func (cfs *CustomFieldSet) Has(name string) bool
  • func (cfs *CustomFieldSet) LinkedObject(name string) (*LinkedObject, error)
  • func (cfs *CustomFieldSet) LinkedObjects(name string) ([]*LinkedObject, error)
  • func (cfs *CustomFieldSet) String(name string) (*string, error)
  • func (cfs *CustomFieldSet) StringMap() map[string]any
• type Filter
  • func NewFilter(transport *FilterTransport) *Filter
  • func (f *Filter) Hash() string
  • func (f *Filter) Set(name string, values ...string)
• type FilterTransport
  • func (c *FilterTransport) RoundTrip(req *http.Request) (*http.Response, error)
• type LinkedObject
• type NetboxClient
  • func NewClient(cfg config.Config) *NetboxClient
  • func (nc *NetboxClient) Filter() *Filter
  • func (nc *NetboxClient) ListDevices() ([]*models.DeviceWithConfigContext, error)
  • func (nc *NetboxClient) ListIPAddresses() ([]*models.IPAddress, error)
  • func (nc *NetboxClient) ListSiteGroups() ([]*models.SiteGroup, error)
  • func (nc *NetboxClient) ListSites() ([]*models.Site, error)
  • func (nc *NetboxClient) ListTenants() ([]*models.Tenant, error)
  • func (nc *NetboxClient) ListVirtualMachines() ([]*models.VirtualMachineWithConfigContext, error)
  • func (nc *NetboxClient) Transport() *FilterTransport

Types

type CustomFieldSet

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

func (*CustomFieldSet) Bool

func (cfs *CustomFieldSet) Bool(name string) (*bool, error)

func (*CustomFieldSet) Has

func (cfs *CustomFieldSet) Has(name string) bool

func (*CustomFieldSet) LinkedObject

func (cfs *CustomFieldSet) LinkedObject(name string) (*LinkedObject, error)

func (*CustomFieldSet) LinkedObjects

func (cfs *CustomFieldSet) LinkedObjects(name string) ([]*LinkedObject, error)

func (*CustomFieldSet) String

func (cfs *CustomFieldSet) String(name string) (*string, error)

func (*CustomFieldSet) StringMap

func (cfs *CustomFieldSet) StringMap() map[string]any

type Filter

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

func NewFilter

func NewFilter(transport *FilterTransport) *Filter

func (*Filter) Hash

func (f *Filter) Hash() string

func (*Filter) Set

func (f *Filter) Set(name string, values ...string)

type FilterTransport

type FilterTransport struct {
	Transport       http.RoundTripper
	QueryParameters map[string][]string
}

FilterTransport wraps http.RoundTripper for injecting custom query parameters

func (*FilterTransport) RoundTrip

func (c *FilterTransport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip injects custom query parameters before calling underlying transport

type LinkedObject

type LinkedObject struct {
	Display string
	ID      int64
	Name    string
	Slug    string
	URL     *url.URL
}

type NetboxClient

type NetboxClient struct {
	API *client.NetBoxAPI
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cfg config.Config) *NetboxClient

func (*NetboxClient) Filter

func (nc *NetboxClient) Filter() *Filter

func (*NetboxClient) ListDevices

func (nc *NetboxClient) ListDevices() ([]*models.DeviceWithConfigContext, error)

func (*NetboxClient) ListIPAddresses

func (nc *NetboxClient) ListIPAddresses() ([]*models.IPAddress, error)

func (*NetboxClient) ListSiteGroups

func (nc *NetboxClient) ListSiteGroups() ([]*models.SiteGroup, error)

func (*NetboxClient) ListSites

func (nc *NetboxClient) ListSites() ([]*models.Site, error)

func (*NetboxClient) ListTenants

func (nc *NetboxClient) ListTenants() ([]*models.Tenant, error)

func (*NetboxClient) ListVirtualMachines

func (nc *NetboxClient) ListVirtualMachines() ([]*models.VirtualMachineWithConfigContext, error)

func (*NetboxClient) Transport

func (nc *NetboxClient) Transport() *FilterTransport