api

package
v0.2.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 11, 2025 License: Apache-2.0 Imports: 34 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	RequestTimeout = 1200
)

Variables

View Source 
var (
	ErrParentPrefixExhausted           = errors.New("parent prefix exhausted")
	ErrParentPrefixNotFound            = errors.New("parent prefix not found")
	ErrWrongMatchingPrefixSubnetFormat = errors.New("wrong matchingPrefix subnet format")
	ErrInvalidIpFamily                 = errors.New("invalid IP Family")
	ErrRestorationHashMismatch         = errors.New("restoration hash mismatch")
)
View Source 
var (
	// TODO(henrybear327): centralize errors
	ErrNoPrefixMatchsSizeCriteria = errors.New("no available prefix matches size criteria")
)

Functions

func AssertError 

func AssertError(t *testing.T, err error, msg string)

func AssertIpAddress 

func AssertIpAddress(t *testing.T, given *netboxModels.WritableIPAddress, actual *netboxModels.IPAddress)

func AssertNil 

func AssertNil(t *testing.T, err error)

func SetIpAddressMask 

func SetIpAddressMask(ip string, ipFamily int64) (string, error)

func TruncateDescription 

func TruncateDescription(description string) string

Types

type CustomFieldEntry 

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

type IPFamily 

type IPFamily int64
const (
	IPv4Family IPFamily = iota + 4

	IPv6Family
)

type InstrumentedRoundTripper 

type InstrumentedRoundTripper struct {
	Transport http.RoundTripper
}

func (*InstrumentedRoundTripper) RoundTrip 

func (irt *InstrumentedRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

type NetboxClient 

type NetboxClient struct {
	Ipam    interfaces.IpamInterface
	Tenancy interfaces.TenancyInterface
	Extras  interfaces.ExtrasInterface
	Dcim    interfaces.DcimInterface
}

func GetNetboxClient 

func GetNetboxClient() (*NetboxClient, error)

func (*NetboxClient) CreateIpAddress 

func (r *NetboxClient) CreateIpAddress(ipAddress *netboxModels.WritableIPAddress) (*netboxModels.IPAddress, error)

func (*NetboxClient) CreateIpRange 

func (r *NetboxClient) CreateIpRange(ipRange *netboxModels.WritableIPRange) (*netboxModels.IPRange, error)

func (*NetboxClient) CreatePrefix 

func (r *NetboxClient) CreatePrefix(prefix *netboxModels.WritablePrefix) (*netboxModels.Prefix, error)

func (*NetboxClient) DeleteIpAddress 

func (r *NetboxClient) DeleteIpAddress(ipAddressId int64) error

func (*NetboxClient) DeleteIpRange 

func (r *NetboxClient) DeleteIpRange(ipRangeId int64) error

func (*NetboxClient) DeletePrefix 

func (r *NetboxClient) DeletePrefix(prefixId int64) error

func (*NetboxClient) GetAvailableIpAddressByClaim 

func (r *NetboxClient) GetAvailableIpAddressByClaim(ipAddressClaim *models.IPAddressClaim) (*models.IPAddress, error)

GetAvailableIpAddressByClaim searches an available IpAddress in Netbox matching IpAddressClaim requirements

func (*NetboxClient) GetAvailableIpAddressesByIpRange 

func (r *NetboxClient) GetAvailableIpAddressesByIpRange(ipRangeId int64) (*ipam.IpamIPRangesAvailableIpsListOK, error)

GetAvailableIpsByIpRange returns all available Ips in Netbox matching IpRangeClaim requirements

func (*NetboxClient) GetAvailableIpAddressesByParentPrefix 

func (r *NetboxClient) GetAvailableIpAddressesByParentPrefix(parentPrefixId int64) (*ipam.IpamPrefixesAvailableIpsListOK, error)

func (*NetboxClient) GetAvailableIpRangeByClaim 

func (r *NetboxClient) GetAvailableIpRangeByClaim(ipRangeClaim *models.IpRangeClaim) (*models.IpRange, error)

GetAvailableIpRangeByClaim searches an available IpRange in Netbox matching IpRangeClaim requirements

func (*NetboxClient) GetAvailablePrefixByClaim 

func (r *NetboxClient) GetAvailablePrefixByClaim(prefixClaim *models.PrefixClaim) (*models.Prefix, error)

GetAvailablePrefixByClaim searches an available Prefix in Netbox matching PrefixClaim requirements

func (*NetboxClient) GetAvailablePrefixesByParentPrefix 

func (r *NetboxClient) GetAvailablePrefixesByParentPrefix(parentPrefixId int64) (*ipam.IpamPrefixesAvailablePrefixesListOK, error)

func (*NetboxClient) GetAvailablePrefixesByParentPrefixSelector 

func (r *NetboxClient) GetAvailablePrefixesByParentPrefixSelector(prefixClaimSpec *netboxv1.PrefixClaimSpec) ([]*models.Prefix, error)

func (*NetboxClient) GetIpAddress 

func (r *NetboxClient) GetIpAddress(ipAddress *models.IPAddress) (*ipam.IpamIPAddressesListOK, error)

func (*NetboxClient) GetIpRange 

func (r *NetboxClient) GetIpRange(ipRange *models.IpRange) (*ipam.IpamIPRangesListOK, error)

func (*NetboxClient) GetPrefix 

func (r *NetboxClient) GetPrefix(prefix *models.Prefix) (*ipam.IpamPrefixesListOK, error)

func (*NetboxClient) GetSiteDetails 

func (r *NetboxClient) GetSiteDetails(name string) (*models.Site, error)

func (*NetboxClient) GetTenantDetails 

func (r *NetboxClient) GetTenantDetails(name string) (*models.Tenant, error)

func (*NetboxClient) ReserveOrUpdateIpAddress 

func (r *NetboxClient) ReserveOrUpdateIpAddress(ipAddress *models.IPAddress) (*netboxModels.IPAddress, error)

func (*NetboxClient) ReserveOrUpdateIpRange 

func (r *NetboxClient) ReserveOrUpdateIpRange(ipRange *models.IpRange) (*netboxModels.IPRange, error)

func (*NetboxClient) ReserveOrUpdatePrefix 

func (r *NetboxClient) ReserveOrUpdatePrefix(prefix *models.Prefix) (*netboxModels.Prefix, error)

ReserveOrUpdatePrefix creates or updates the prefix passed as parameter

func (*NetboxClient) RestoreExistingIpByHash 

func (r *NetboxClient) RestoreExistingIpByHash(hash string) (*models.IPAddress, error)

func (*NetboxClient) RestoreExistingIpRangeByHash 

func (r *NetboxClient) RestoreExistingIpRangeByHash(hash string) (*models.IpRange, error)

func (*NetboxClient) RestoreExistingPrefixByHash 

func (r *NetboxClient) RestoreExistingPrefixByHash(hash string, requestedPrefixLength string) (*models.Prefix, error)

func (*NetboxClient) UpdateIpAddress 

func (r *NetboxClient) UpdateIpAddress(ipAddressId int64, ipAddress *netboxModels.WritableIPAddress) (*netboxModels.IPAddress, error)

func (*NetboxClient) UpdateIpRange 

func (r *NetboxClient) UpdateIpRange(ipRangeId int64, ipRange *netboxModels.WritableIPRange) (*netboxModels.IPRange, error)

func (*NetboxClient) UpdatePrefix 

func (r *NetboxClient) UpdatePrefix(prefixId int64, prefix *netboxModels.WritablePrefix) (*netboxModels.Prefix, error)

func (*NetboxClient) VerifyNetboxConfiguration 

func (r *NetboxClient) VerifyNetboxConfiguration() error

Checks that the Netbox host is properly configured for the operator to function. Currently only checks that the required custom fields for IP address handling have been added.

type QueryFilter 

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

func (*QueryFilter) WriteToRequest 

func (o *QueryFilter) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.