ips

Documentation

Overview

Package ips implements API functions residing under /provisioning/ips. This path contains methods for querying ips in a VLAN.

Index

• type API
  • func NewAPI(c client.Client) API
• type IP

Types

type API

type API interface {
	GetFree(ctx context.Context, location, vlan string) ([]IP, error)
}

API contains methods for IP manipulation (but only in the context of provisioning).

func NewAPI

func NewAPI(c client.Client) API

NewAPI creates a new IP API instance with the given client.

type IP

type IP struct {
	Identifier string `json:"identifier"`
	Text       string `json:"text"`
	Prefix     string `json:"prefix"`
}

IP defines informationen corresponding to the IP of a VLAN.