netboxgo/devices.go

381 lines
14 KiB
Go
Raw Normal View History

2019-09-11 20:12:42 +02:00
package netboxgo
2019-09-11 13:53:11 +02:00
import (
2021-11-26 11:09:27 +01:00
"context"
"fmt"
2019-09-11 13:53:11 +02:00
"net/http"
"net/url"
"time"
2019-09-17 09:53:24 +02:00
"github.com/gorilla/schema"
2019-09-11 13:53:11 +02:00
)
2021-11-26 11:09:27 +01:00
type DevicesService service
// Devices is used for Netbox dcim_device_list return struct
type Devices struct {
2021-05-24 15:10:20 +02:00
Count int `json:"count"`
Next string `json:"next"`
Previous string `json:"previous"`
Results []Device `json:"results"`
}
type Device struct {
ID int `json:"id"`
Name string `json:"name"`
DisplayName string `json:"display_name"`
DeviceType struct {
ID int `json:"id"`
URL string `json:"url"`
Manufacturer struct {
ID int `json:"id"`
URL string `json:"url"`
Name string `json:"name"`
Slug string `json:"slug"`
DevicetypeCount int `json:"devicetype_count"`
} `json:"manufacturer"`
Model string `json:"model"`
Slug string `json:"slug"`
DisplayName string `json:"display_name"`
DeviceCount int `json:"device_count"`
} `json:"device_type"`
DeviceRole struct {
ID int `json:"id"`
URL string `json:"url"`
Name string `json:"name"`
Slug string `json:"slug"`
DeviceCount int `json:"device_count"`
VirtualmachineCount int `json:"virtualmachine_count"`
} `json:"device_role"`
Tenant struct {
ID int `json:"id"`
URL string `json:"url"`
Name string `json:"name"`
Slug string `json:"slug"`
} `json:"tenant"`
Platform struct {
ID int `json:"id"`
URL string `json:"url"`
Name string `json:"name"`
Slug string `json:"slug"`
DeviceCount int `json:"device_count"`
VirtualmachineCount int `json:"virtualmachine_count"`
} `json:"platform"`
Serial string `json:"serial"`
AssetTag string `json:"asset_tag"`
Site struct {
ID int `json:"id"`
URL string `json:"url"`
Name string `json:"name"`
Slug string `json:"slug"`
} `json:"site"`
Rack struct {
2019-09-11 13:53:11 +02:00
ID int `json:"id"`
2021-05-24 15:10:20 +02:00
URL string `json:"url"`
2019-09-11 13:53:11 +02:00
Name string `json:"name"`
DisplayName string `json:"display_name"`
2021-05-24 15:10:20 +02:00
DeviceCount int `json:"device_count"`
} `json:"rack"`
Position int `json:"position"`
Face struct {
Label string `json:"label"`
Value string `json:"value"`
} `json:"face"`
ParentDevice struct {
ID int `json:"id"`
URL string `json:"url"`
Name string `json:"name"`
DisplayName string `json:"display_name"`
} `json:"parent_device"`
Status struct {
Label string `json:"label"`
Value string `json:"value"`
} `json:"status"`
PrimaryIP struct {
ID int `json:"id"`
URL string `json:"url"`
Family int `json:"family"`
Address string `json:"address"`
} `json:"primary_ip"`
PrimaryIP4 struct {
ID int `json:"id"`
URL string `json:"url"`
Family int `json:"family"`
Address string `json:"address"`
} `json:"primary_ip4"`
PrimaryIP6 struct {
ID int `json:"id"`
URL string `json:"url"`
Family int `json:"family"`
Address string `json:"address"`
} `json:"primary_ip6"`
Cluster struct {
ID int `json:"id"`
URL string `json:"url"`
Name string `json:"name"`
VirtualmachineCount int `json:"virtualmachine_count"`
} `json:"cluster"`
VirtualChassis struct {
ID int `json:"id"`
URL string `json:"url"`
Master struct {
2019-09-11 13:53:11 +02:00
ID int `json:"id"`
URL string `json:"url"`
Name string `json:"name"`
DisplayName string `json:"display_name"`
2021-05-24 15:10:20 +02:00
} `json:"master"`
MemberCount int `json:"member_count"`
} `json:"virtual_chassis"`
VcPosition int `json:"vc_position"`
VcPriority int `json:"vc_priority"`
Comments string `json:"comments"`
// LocalContextData string `json:"local_context_data"`
Tags []struct {
ID int `json:"id"`
URL string `json:"url"`
Name string `json:"name"`
Slug string `json:"slug"`
Color string `json:"color"`
} `json:"tags"`
CustomFields struct {
DcimDeviceBelongsToService struct {
Value int `json:"value"`
2019-09-11 13:53:11 +02:00
Label string `json:"label"`
2021-05-24 15:10:20 +02:00
} `json:"dcim_device_belongs_to_service"`
DcimDeviceCendotid string `json:"dcim_device_cendotid"`
DcimDeviceExposedToInternet struct {
Value int `json:"value"`
2019-09-11 13:53:11 +02:00
Label string `json:"label"`
2021-05-24 15:10:20 +02:00
} `json:"dcim_device_exposed_to_internet"`
DcimDeviceImportOsVersion bool `json:"dcim_device_import_os_version"`
DcimDeviceOsVersion interface{} `json:"dcim_device_os_version"`
DcimDevicesImportInterfaces interface{} `json:"dcim_devices_import_interfaces"`
DcimDeviceImportvlan bool `json:"dcim_device_importvlan"`
DcimDeviceL2Domain interface{} `json:"dcim_device_l2domain"`
DcimDeviceCountTrunkVlans interface{} `json:"dcim_device_count_trunk_vlans"`
DcimDeviceLogicalportsDeviceLimit interface{} `json:"dcim_device_logicalports_device_limit"`
DcimDeviceLogicalportsActiveNum interface{} `json:"dcim_device_logicalports_active_num"`
DcimDeviceLogicalportsConfiguredNum interface{} `json:"dcim_device_logicalports_configured_num"`
DcimDeviceCountTimesLastRun interface{} `json:"dcim_device_count_times_last_run"`
DcimDeviceImportVrfs interface{} `json:"dcim_device_import_vrfs"`
DcimDeviceVrfTag interface{} `json:"dcim_device_vrf_tag"`
DcimDevicePod interface{} `json:"dcim_device_pod"`
} `json:"custom_fields"`
ConfigContext struct {
AdditionalProp1 string `json:"additionalProp1"`
AdditionalProp2 string `json:"additionalProp2"`
AdditionalProp3 string `json:"additionalProp3"`
} `json:"config_context"`
Created string `json:"created"`
LastUpdated time.Time `json:"last_updated"`
2019-09-11 13:53:11 +02:00
}
2021-11-26 11:09:27 +01:00
type NewDevice struct {
2021-11-26 11:15:19 +01:00
Name string `json:"name,omitempty"`
DeviceType int `json:"device_type,omitempty"`
DeviceRole int `json:"device_role,omitempty"`
Tenant int `json:"tenant,omitempty"`
Platform int `json:"platform,omitempty"`
2020-08-10 10:28:22 +02:00
Serial string `json:"serial,omitempty"`
AssetTag string `json:"asset_tag,omitempty"`
Site int `json:"site,omitempty"`
Rack int `json:"rack,omitempty"`
Position int `json:"position,omitempty"`
Face string `json:"face,omitempty"`
ParentDevice struct {
Name string `json:"name,omitempty"`
} `json:"parent_device,omitempty"`
2020-10-15 13:01:55 +02:00
Status string `json:"status,omitempty"`
PrimaryIP4 int `json:"primary_ip4,omitempty"`
PrimaryIP6 int `json:"primary_ip6,omitempty"`
Cluster int `json:"cluster,omitempty"`
VirtualChassis int `json:"virtual_chassis,omitempty"`
VcPosition int `json:"vc_position,omitempty"`
VcPriority int `json:"vc_priority,omitempty"`
Comments string `json:"comments,omitempty"`
LocalContextData string `json:"local_context_data,omitempty"`
Tags []struct {
Name string `json:"name"`
Slug string `json:"slug"`
Color string `json:"color"`
} `json:"tags"`
CustomFields struct {
2020-08-10 10:28:22 +02:00
DcimDeviceBelongsToService struct {
Value int `json:"value,omitempty"`
Label string `json:"label,omitempty"`
} `json:"dcim_device_belongs_to_service,omitempty"`
DcimDeviceCendotid string `json:"dcim_device_cendotid,omitempty"`
DcimDeviceExposedToInternet struct {
Value int `json:"value,omitempty"`
Label string `json:"label,omitempty"`
} `json:"dcim_device_exposed_to_internet,omitempty"`
DcimDeviceImportOsVersion bool `json:"dcim_device_import_os_version,omitempty"`
DcimDevicePod struct {
Value int `json:"value,omitempty"`
Label string `json:"label,omitempty"`
} `json:"dcim_device_pod,omitempty"`
DcimDeviceOsVersion interface{} `json:"dcim_device_os_version,omitempty"`
DcimDevicesImportInterfaces interface{} `json:"dcim_devices_import_interfaces,omitempty"`
DcimDeviceImportvlan bool `json:"dcim_device_importvlan,omitempty"`
DcimDeviceL2Domain interface{} `json:"dcim_device_l2domain,omitempty"`
DcimDeviceCountTrunkVlans interface{} `json:"dcim_device_count_trunk_vlans,omitempty"`
DcimDeviceLogicalportsDeviceLimit interface{} `json:"dcim_device_logicalports_device_limit,omitempty"`
DcimDeviceLogicalportsActiveNum interface{} `json:"dcim_device_logicalports_active_num,omitempty"`
DcimDeviceLogicalportsConfiguredNum interface{} `json:"dcim_device_logicalports_configured_num,omitempty"`
DcimDeviceCountTimesLastRun interface{} `json:"dcim_device_count_times_last_run,omitempty"`
DcimDeviceImportVrfs interface{} `json:"dcim_device_import_vrfs,omitempty"`
DcimDeviceVrfTag interface{} `json:"dcim_device_vrf_tag,omitempty"`
} `json:"custom_fields,omitempty"`
}
2021-11-26 11:09:27 +01:00
type UpdateDevice struct {
2020-09-03 13:52:52 +02:00
Name string `json:"name,omitempty"`
DeviceType int `json:"device_type,omitempty"`
DeviceRole int `json:"device_role,omitempty"`
Tenant int `json:"tenant,omitempty"`
Platform int `json:"platform,omitempty"`
Serial string `json:"serial,omitempty"`
AssetTag string `json:"asset_tag,omitempty"`
Site int `json:"site,omitempty"`
Rack int `json:"rack,omitempty"`
Position int `json:"position,omitempty"`
Face string `json:"face,omitempty"`
ParentDevice *struct {
Name string `json:"name,omitempty"`
} `json:"parent_device,omitempty"`
Status string `json:"status,omitempty"`
PrimaryIP4 int `json:"primary_ip4,omitempty"`
PrimaryIP6 int `json:"primary_ip6,omitempty"`
Cluster int `json:"cluster,omitempty"`
VirtualChassis int `json:"virtual_chassis,omitempty"`
VcPosition int `json:"vc_position,omitempty"`
VcPriority int `json:"vc_priority,omitempty"`
Comments string `json:"comments,omitempty"`
LocalContextData string `json:"local_context_data,omitempty"`
Tags []string `json:"tags,omitempty"`
CustomFields struct {
DcimDeviceBelongsToService int `json:"dcim_device_belongs_to_service,omitempty"`
DcimDeviceCendotid string `json:"dcim_device_cendotid,omitempty"`
DcimDeviceExposedToInternet int `json:"dcim_device_exposed_to_internet,omitempty"`
2021-11-26 11:15:19 +01:00
DcimDeviceImportOsVersion bool `json:"dcim_device_import_os_version,omitempty"`
2020-09-03 13:52:52 +02:00
DcimDevicePod int `json:"dcim_device_pod,omitempty"`
} `json:"custom_fields,omitempty"`
}
2019-09-17 09:53:24 +02:00
// DeviceFilter is used to filter dcim_device_list query to the Netbox API
2019-09-11 13:53:11 +02:00
type DeviceFilter struct {
Offset int64 `schema:"offset,omitempty"`
Limit int64 `schema:"limit,omitempty"`
2020-08-10 10:28:22 +02:00
// User specific filters
2019-09-17 09:53:24 +02:00
ID string `schema:"id,omitempty"`
2019-09-11 13:53:11 +02:00
Name string `schema:"name,omitempty"`
AssetTag string `schema:"asset_tag,omitempty"`
Face string `schema:"face,omitempty"`
Position string `schema:"position,omitempty"`
VcPosition string `schema:"vc_position,omitempty"`
VcPriority string `schema:"vc_priority,omitempty"`
2019-09-17 09:53:24 +02:00
TenantGroupID string `schema:"tenant_group_id,omitempty"`
TenantGroup string `schema:"tenant_group,omitempty"`
2019-09-17 09:53:24 +02:00
TenantID string `schema:"tenant_id,omitempty"`
2019-09-11 13:53:11 +02:00
Tenant string `schema:"tenant,omitempty"`
2019-09-17 09:53:24 +02:00
IDIn string `schema:"id__in,omitempty"`
2019-09-11 13:53:11 +02:00
Q string `schema:"q,omitempty"`
2019-09-17 09:53:24 +02:00
ManufacturerID string `schema:"manufacturer_id,omitempty"`
2019-09-11 13:53:11 +02:00
Manufacturer string `schema:"manufacturer,omitempty"`
2019-09-17 09:53:24 +02:00
DeviceTypeID string `schema:"device_type_id,omitempty"`
RoleID string `schema:"role_id,omitempty"`
2019-09-11 13:53:11 +02:00
Role string `schema:"role,omitempty"`
2019-09-17 09:53:24 +02:00
RegionID string `schema:"region_id,omitempty"`
2019-09-11 13:53:11 +02:00
Region string `schema:"region,omitempty"`
2019-09-17 09:53:24 +02:00
SiteID string `schema:"site_id,omitempty"`
2019-09-11 13:53:11 +02:00
Site string `schema:"site,omitempty"`
2019-09-17 09:53:24 +02:00
RackGroupID string `schema:"rack_group_id,omitempty"`
RackID string `schema:"rack_id,omitempty"`
ClusterID string `schema:"cluster_id,omitempty"`
2019-09-11 13:53:11 +02:00
Model string `schema:"model,omitempty"`
Status string `schema:"status,omitempty"`
IsfullDepth string `schema:"is_full_depth,omitempty"`
MacAddress string `schema:"mac_address,omitempty"`
Serial string `schema:"serial,omitempty"`
2019-09-17 09:53:24 +02:00
HasPrimaryIP string `schema:"has_primary_ip,omitempty"`
VirtualChassiID string `schema:"virtual_chassis_id,omitempty"`
2019-09-11 13:53:11 +02:00
VirtualChassiMember string `schema:"virtual_chassis_member,omitempty"`
ConsolePorts string `schema:"console_ports,omitempty"`
ConsoleServerPorts string `schema:"console_server_ports,omitempty"`
PowerPorts string `schema:"power_ports,omitempty"`
PowerOutlets string `schema:"power_outlets,omitempty"`
Interfaces string `schema:"interfaces,omitempty"`
PassThroughPorts string `schema:"pass_through_ports,omitempty"`
Tag string `schema:"tag,omitempty"`
}
2021-11-26 11:09:27 +01:00
const devicesPath = "/dcim/devices"
2019-09-11 13:53:11 +02:00
2021-11-26 11:09:27 +01:00
// List devices. DeviceFilter is used to list based on filter queries.
func (s *DevicesService) List(ctx context.Context, f *DeviceFilter) (*Devices, error) {
var devices Devices
var query string
var req *http.Request
var err error
2019-09-11 13:53:11 +02:00
2021-11-26 11:09:27 +01:00
encoder := schema.NewEncoder()
2019-09-11 13:53:11 +02:00
2021-11-26 11:09:27 +01:00
form := url.Values{}
err = encoder.Encode(f, form)
2019-09-11 13:53:11 +02:00
if err != nil {
2021-11-26 11:09:27 +01:00
return &devices, err
2019-09-11 13:53:11 +02:00
}
2021-11-26 11:09:27 +01:00
query = form.Encode()
2019-09-11 13:53:11 +02:00
2021-11-26 11:09:27 +01:00
req, err = s.client.newRequest(ctx, "GET", devicesPath, query, nil)
2019-09-17 09:53:24 +02:00
if err != nil {
2021-11-26 11:09:27 +01:00
return &devices, err
2019-09-17 09:53:24 +02:00
}
2021-11-26 11:09:27 +01:00
_, err = s.client.do(req, &devices)
2019-09-11 13:53:11 +02:00
if err != nil {
2021-11-26 11:09:27 +01:00
return &devices, err
2019-09-11 13:53:11 +02:00
}
2021-11-26 11:09:27 +01:00
return &devices, nil
2019-09-11 13:53:11 +02:00
}
2020-08-10 10:28:22 +02:00
2021-11-26 11:09:27 +01:00
// Create a device
func (s *DevicesService) Create(ctx context.Context, c *NewDevice) error {
var err error
var req *http.Request
req, err = s.client.newRequest(ctx, "POST", devicesPath, "", c)
2020-08-10 10:28:22 +02:00
if err != nil {
2021-11-26 11:09:27 +01:00
return fmt.Errorf("unable to create request: %w", err)
2020-08-10 10:28:22 +02:00
}
2021-11-26 11:09:27 +01:00
_, err = s.client.do(req, nil)
2020-08-10 10:28:22 +02:00
if err != nil {
2021-11-26 11:09:27 +01:00
return fmt.Errorf("unable to do request: %w", err)
2020-08-10 10:28:22 +02:00
}
2021-11-26 11:09:27 +01:00
return nil
2020-08-10 10:28:22 +02:00
}
2021-11-26 11:09:27 +01:00
// Update a device
func (s *DevicesService) Update(ctx context.Context, id string, c *UpdateDevice) error {
var req *http.Request
var err error
path := fmt.Sprintf("%s/%s", devicesPath, id)
req, err = s.client.newRequest(ctx, "PATCH", path, "", c)
2020-08-10 10:28:22 +02:00
if err != nil {
2021-11-26 11:09:27 +01:00
return fmt.Errorf("unable to create request: %w", err)
2020-08-10 10:28:22 +02:00
}
2020-09-03 13:52:52 +02:00
2021-11-26 11:09:27 +01:00
_, err = s.client.do(req, nil)
2020-08-10 10:28:22 +02:00
if err != nil {
2021-11-26 11:09:27 +01:00
return fmt.Errorf("unable to do request: %w", err)
2020-08-10 10:28:22 +02:00
}
2021-06-01 22:53:19 +02:00
return nil
2020-08-10 10:28:22 +02:00
}