api

May 7, 2025

Changes in this version

+ const RequestTimeout

+ var ErrInvalidIpFamily = errors.New("invalid IP Family")

+ var ErrNoPrefixMatchsSizeCriteria = errors.New("no available prefix matches size criterias")

+ var ErrParentPrefixExhausted = errors.New("parent prefix exhausted")

+ var ErrParentPrefixNotFound = errors.New("parent prefix not found")

+ var ErrRestorationHashMismatch = errors.New("restoration hash mismatch")

+ var ErrWrongMatchingPrefixSubnetFormat = errors.New("wrong matchingPrefix subnet format")

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

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

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

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

+ func TruncateDescription(description string) string

+ type CustomFieldEntry struct

+ type IPFamily int64

+ const IPv4Family

+ const IPv6Family

+ type InstrumentedRoundTripper struct

+ Transport http.RoundTripper

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

+ type NetboxClient struct

+ Dcim interfaces.DcimInterface

+ Extras interfaces.ExtrasInterface

+ Ipam interfaces.IpamInterface

+ Tenancy interfaces.TenancyInterface

+ func GetNetboxClient() (*NetboxClient, error)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

+ func (r *NetboxClient) VerifyNetboxConfiguration() error

+ type QueryFilter struct

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