ipam

Documentation

Overview

Package ipam is a very simple IPAM it administers a single CIDR range, e.g "172.30.0.0/16"

Index

• Variables
• func Allocate() (net.IP, error)
• func Fix() error
• func Free(a net.IP)
• func Reserve(a net.IP) error
• func ReserveFirstAndLast()
• func Unallocated() uint32
• type IPAM
  • func NewFileIPAM(fn, cidr string) (IPAM, error)

Variables

var (
	ErrNoAddressesLeft    = errors.New("error: no addresses left")
	ErrAddressOutOfRange  = errors.New("error: address out of range")
	ErrAddressAlreadyUsed = errors.New("error: address already used")
)

var Check = Fix

Functions

func Allocate

func Allocate() (net.IP, error)

func Fix

func Fix() error

func Free

func Free(a net.IP)

func Reserve

func Reserve(a net.IP) error

func ReserveFirstAndLast

func ReserveFirstAndLast()

func Unallocated

func Unallocated() uint32

Types

type IPAM

type IPAM interface {
	Allocate() (net.IP, error)
	Free(a net.IP)
	Unallocated() uint32
	Reserve(a net.IP) error
	ReserveFirstAndLast()
}

var DefaultIPAM IPAM = &nullIPAM{}

func NewFileIPAM

func NewFileIPAM(fn, cidr string) (IPAM, error)

NewFileIPAM creates a new file backed IPAM for the passed subnet in CIDR form Error if the passed CIDR is invalid.