ipallocator

Documentation

Index

• Variables
• func RegisterExistingNetwork(network *net.IPNet) error
• func RegisterNetwork(network *net.IPNet, nameservers []string) error
• func ReleaseIP(network *net.IPNet, ip *net.IP) error
• func RequestIP(network *net.IPNet, ip *net.IP) (*net.IP, error)

Variables

var (
	ErrNetworkAlreadyAllocated        = errors.New("requested network overlaps with existing network")
	ErrNetworkAlreadyRegisterd        = errors.New("requested network is already registered")
	ErrNetworkOverlapsWithNameservers = errors.New("requested network overlaps with nameserver")
	ErrNoAvailableIPs                 = errors.New("no available ip addresses on network")
	ErrIPAlreadyAllocated             = errors.New("ip already allocated")
	ErrNetworkNotRegistered           = errors.New("network not registered")
)

Functions

func RegisterExistingNetwork

func RegisterExistingNetwork(network *net.IPNet) error

RegisterExistingNetwork registers an exising network created for use with the allocator but does not perform any validation

func RegisterNetwork

func RegisterNetwork(network *net.IPNet, nameservers []string) error

RegisterNetwork registers a new network with the allocator and validates that it contains a valid ip that does not overlap with existing routes and nameservers

func ReleaseIP

func ReleaseIP(network *net.IPNet, ip *net.IP) error

ReleaseIP adds the provided ip back into the pool of available ips to be returned for use.

func RequestIP

func RequestIP(network *net.IPNet, ip *net.IP) (*net.IP, error)

RequestIP requests an available ip from the given network. It will return the next available ip if the ip provided is nil. If the ip provided is not nil it will validate that the provided ip is available for use or return an error