README
¶
netboxapi
This package provides custom functions for the default go-netbox package, it mostly handles pagination right now
Documentation
¶
Overview ¶
Package netboxapi provides custom functions for the default go-netbox package. It mostly handles pagination.
Index ¶
- type NetBoxAPI
- func (nb NetBoxAPI) GetClusterGroups(param virtualization.VirtualizationClusterGroupsListParams) ([]*models.ClusterGroup, error)
- func (nb NetBoxAPI) GetClusters(param virtualization.VirtualizationClustersListParams) ([]*models.Cluster, error)
- func (nb NetBoxAPI) GetDevices(param dcim.DcimDevicesListParams) ([]*models.DeviceWithConfigContext, error)
- func (nb NetBoxAPI) GetIPAddresses(param ipam.IpamIPAddressesListParams) ([]*models.IPAddress, error)
- func (nb NetBoxAPI) GetPrefixes(param ipam.IpamPrefixesListParams) ([]*models.Prefix, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type NetBoxAPI ¶
type NetBoxAPI struct {
client.NetBoxAPI // API of NetBox
Token string // Token used to access the NetBox API
URL string // URL of this NetBox instance
}
NetBoxAPI is the type we use to add custom functions
func NewNetBoxClient ¶
NewNetBoxClient returns a client to NetBox at the given url, using the provided token
func (NetBoxAPI) GetClusterGroups ¶ added in v0.0.7
func (nb NetBoxAPI) GetClusterGroups(param virtualization.VirtualizationClusterGroupsListParams) ([]*models.ClusterGroup, error)
func (NetBoxAPI) GetClusters ¶ added in v0.0.5
func (nb NetBoxAPI) GetClusters(param virtualization.VirtualizationClustersListParams) ([]*models.Cluster, error)
GetClusters returns Clusters from the api nb filtered by the parameter list param
func (NetBoxAPI) GetDevices ¶ added in v0.0.6
func (nb NetBoxAPI) GetDevices(param dcim.DcimDevicesListParams) ([]*models.DeviceWithConfigContext, error)
GetDevices returns devices from the api nb filtered by the parameter list param
func (NetBoxAPI) GetIPAddresses ¶
func (nb NetBoxAPI) GetIPAddresses(param ipam.IpamIPAddressesListParams) ([]*models.IPAddress, error)
GetIPAddresses returns IP addresses from the api nb filtered by the parameter list param
func (NetBoxAPI) GetPrefixes ¶
GetPrefixes returns prefixes from the api nb filtered by the parameter list param
Source Files