netbox

Documentation

Index

• Variables
• func NewAllocator(opts ...Option) (netalloc.Allocator, error)
• type Allocator
  • func (a *Allocator) Alloc() (*net.IPAddr, error)
  • func (a *Allocator) AllocCIDR() (cidr string, err error)
  • func (a *Allocator) CIDR(ip *net.IPAddr) string
  • func (a *Allocator) Free(ip *net.IPAddr) error
  • func (a *Allocator) FreeCIDR(cidr string) (err error)
  • func (a *Allocator) SetStore(_ netalloc.Store)
• type Option
  • func WithEndpoint(endpoint string) Option
  • func WithHTTPClient(c *http.Client) Option
  • func WithInsecureClient(insecure bool) Option
  • func WithPrefix(prefix string) Option
  • func WithToken(token string) Option

Variables

var (
	ErrMissingPrefix   = errors.New("missing prefix config")
	ErrMissingEndpoint = errors.New("missing endpoint config")
	ErrMissingToken    = errors.New("missing token config")

	ErrPrefixNotFound       = errors.New("prefix not found")
	ErrIPNotFound           = errors.New("ip not found")
	ErrUnexpectedStatusCode = errors.New("unexpected status code")
)

Functions

func NewAllocator

func NewAllocator(opts ...Option) (netalloc.Allocator, error)

Types

type Allocator

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

func (*Allocator) Alloc

func (a *Allocator) Alloc() (*net.IPAddr, error)

func (*Allocator) AllocCIDR

func (a *Allocator) AllocCIDR() (cidr string, err error)

func (*Allocator) CIDR

func (a *Allocator) CIDR(ip *net.IPAddr) string

func (*Allocator) Free

func (a *Allocator) Free(ip *net.IPAddr) error

func (*Allocator) FreeCIDR

func (a *Allocator) FreeCIDR(cidr string) (err error)

func (*Allocator) SetStore

func (a *Allocator) SetStore(_ netalloc.Store)

SetStore is a no-op

type Option

type Option func(*Allocator)

func WithEndpoint

func WithEndpoint(endpoint string) Option

func WithHTTPClient

func WithHTTPClient(c *http.Client) Option

func WithInsecureClient

func WithInsecureClient(insecure bool) Option

func WithPrefix

func WithPrefix(prefix string) Option

func WithToken

func WithToken(token string) Option