network

Documentation

Overview

Package network provides structs and functions pertaining to network resources.

Index

• Variables
• type IPAddressPool
  • func (p *IPAddressPool) Validate(ctx context.Context) error
• type Switch
  • func (s *Switch) Validate(ctx context.Context) error
• type VLANPool
  • func (v *VLANPool) Validate(ctx context.Context) error

Variables

var ErrIPEmpty = errors.New("ip address is nil")

var ErrInvalidRange = errors.New("range bounds are invalid, start is greater than end")

var ErrMaskEmpty = errors.New("mask is nil")

var ErrModelEmpty = errors.New("model is empty")

var ErrNumPortsEmpty = errors.New("number of ports is 0")

var ErrSerialNumberEmpty = errors.New("serial number is empty")

Types

type IPAddressPool

type IPAddressPool struct {
	zebra.BaseResource
	Subnets []net.IPNet `json:"subnets"`
}

An IPAddressPool represents a range of consecutive IP addresses belonging to the same network.

func (*IPAddressPool) Validate

func (p *IPAddressPool) Validate(ctx context.Context) error

Validate returns an error if the given IPAddressPool object has incorrect values. Else, it returns nil.

type Switch

type Switch struct {
	zebra.BaseResource
	Credentials  zebra.Credentials `json:"credentials"`
	ManagementIP net.IP            `json:"managementIP"` //nolint:tagliatelle
	SerialNumber string            `json:"serialNumber"`
	Model        string            `json:"model"`
	NumPorts     uint32            `json:"numPorts"`
}

A Switch represents a switching device which has an ID, an associated IP address, a serial number, model, and ports.

func (*Switch) Validate

func (s *Switch) Validate(ctx context.Context) error

Validate returns an error if the given Switch object has incorrect values. Else, it returns nil.

type VLANPool

type VLANPool struct {
	zebra.BaseResource
	RangeStart uint16 `json:"rangeStart"`
	RangeEnd   uint16 `json:"rangeEnd"`
}

A VLANPool represents a pool of VLANs belonging to the same network.

func (*VLANPool) Validate

func (v *VLANPool) Validate(ctx context.Context) error

Validate returns an error if the given VLANPool object has incorrect values. Else, it returns nil.