kc/netboxgo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

When creating objects return the created object

Browse source 
TODO: Do this for all objects
This commit is contained in:
Kalle Carlbark 2022-02-14 11:09:50 +01:00
parent f5bf955b0e
commit 236a9bb23e
No known key found for this signature in database
2 changed files with 276 additions and 149 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

234
interfaces.go
View file

@ -5,6 +5,7 @@ import (
"fmt" "fmt"
"net/http" "net/http"
"net/url" "net/url"
"time"
// "fmt" // "fmt"
@ -13,84 +14,171 @@ import (
type InterfacesService service type InterfacesService service
// NewInterface is used for the return values from Netbox API dcim_interfaces_create // NewInterface is used for creating a new interface
type NewInterface struct { type NewInterface struct {
Device int `json:"device"` MacAddress string `json:"mac_address,omitempty"`
Name string `json:"name"` Name string `json:"name"`
Type int `json:"type,omitempty"` Cable struct {
Enabled bool `json:"enabled,omitempty"`
Lag int `json:"lag,omitempty"`
Mtu int `json:"mtu,omitempty"`
MacAddress string `json:"mac_address,omitempty"`
MgmtOnly bool `json:"mgmt_only,omitempty"`
Description string `json:"description,omitempty"`
ConnectionStatus bool `json:"connection_status,omitempty"`
Cable struct {
Label string `json:"label,omitempty"` Label string `json:"label,omitempty"`
} `json:"cable,omitempty"` } `json:"cable,omitempty"`
Mode int `json:"mode,omitempty"` Description string `json:"description,omitempty"`
UntaggedVLAN int `json:"untagged_vlan,omitempty"` TaggedVLANs []int `json:"tagged_vlans,omitempty"`
TaggedVLANs []int `json:"tagged_vlans,omitempty"` Tags []string `json:"tags,omitempty"`
Tags []string `json:"tags,omitempty"` Device int `json:"device"`
Mtu int `json:"mtu,omitempty"`
Lag int `json:"lag,omitempty"`
UntaggedVLAN int `json:"untagged_vlan,omitempty"`
Type int `json:"type,omitempty"`
Mode int `json:"mode,omitempty"`
ConnectionStatus bool `json:"connection_status,omitempty"`
Enabled bool `json:"enabled,omitempty"`
MgmtOnly bool `json:"mgmt_only,omitempty"`
} }
// Interfaces is used for the return value from NetBox API dcim_interfaces_list // Interfaces is a list of interfaces
type Interfaces struct { type Interfaces struct {
Count int `json:"count,omitempty"`
Next interface{} `json:"next,omitempty"` Next interface{} `json:"next,omitempty"`
Previous interface{} `json:"previous,omitempty"` Previous interface{} `json:"previous,omitempty"`
Results []struct { Results []Interface `json:"results,omitempty"`
ID int `json:"id,omitempty"` Count int `json:"count,omitempty"`
Device struct { }
ID int `json:"id,omitempty"`
URL string `json:"url,omitempty"` // Interface is one interface
Name string `json:"name,omitempty"` type Interface struct {
DisplayName string `json:"display_name,omitempty"` ID int `json:"id"`
} `json:"device,omitempty"` URL string `json:"url"`
Name string `json:"name,omitempty"` Display string `json:"display"`
Type struct { Device struct {
Value int `json:"value,omitempty"` ID int `json:"id"`
Label string `json:"label,omitempty"` URL string `json:"url"`
} `json:"type,omitempty"` Display string `json:"display"`
FormFactor struct { Name string `json:"name"`
Value int `json:"value,omitempty"` } `json:"device"`
Label string `json:"label,omitempty"` Name string `json:"name"`
} `json:"form_factor,omitempty"` Label string `json:"label"`
Enabled bool `json:"enabled,omitempty"` Type struct {
Lag struct { Label string `json:"label"`
ID int `json:"id,omitempty"` Value string `json:"value"`
URL string `json:"url,omitempty"` } `json:"type"`
Device struct { Enabled bool `json:"enabled"`
ID int `json:"id,omitempty"` Parent struct {
URL string `json:"url,omitempty"` ID int `json:"id"`
Name string `json:"name,omitempty"` URL string `json:"url"`
DisplayName string `json:"display_name,omitempty"` Display string `json:"display"`
} `json:"device,omitempty"` Device struct {
Name string `json:"name,omitempty"` ID int `json:"id"`
Cable interface{} `json:"cable,omitempty"` URL string `json:"url"`
ConnectionStatus interface{} `json:"connection_status,omitempty"` Display string `json:"display"`
} `json:"lag,omitempty"` Name string `json:"name"`
Mtu interface{} `json:"mtu,omitempty"` } `json:"device"`
MacAddress interface{} `json:"mac_address,omitempty"` Name string `json:"name"`
MgmtOnly bool `json:"mgmt_only,omitempty"` Cable int `json:"cable"`
Description string `json:"description,omitempty"` Occupied string `json:"_occupied"`
ConnectedEndpointType interface{} `json:"connected_endpoint_type,omitempty"` } `json:"parent"`
ConnectedEndpoint interface{} `json:"connected_endpoint,omitempty"` Bridge struct {
ConnectionStatus interface{} `json:"connection_status,omitempty"` ID int `json:"id"`
Cable interface{} `json:"cable,omitempty"` URL string `json:"url"`
Mode interface{} `json:"mode,omitempty"` Display string `json:"display"`
UntaggedVLAN interface{} `json:"untagged_vlan,omitempty"` Device struct {
TaggedVLANs []interface{} `json:"tagged_vlans,omitempty"` ID int `json:"id"`
Tags []interface{} `json:"tags,omitempty"` URL string `json:"url"`
CountIpaddresses int `json:"count_ipaddresses,omitempty"` Display string `json:"display"`
} `json:"results,omitempty"` Name string `json:"name"`
} `json:"device"`
Name string `json:"name"`
Cable int `json:"cable"`
Occupied string `json:"_occupied"`
} `json:"bridge"`
Lag struct {
ID int `json:"id"`
URL string `json:"url"`
Display string `json:"display"`
Device struct {
ID int `json:"id"`
URL string `json:"url"`
Display string `json:"display"`
Name string `json:"name"`
} `json:"device"`
Name string `json:"name"`
Cable int `json:"cable"`
Occupied string `json:"_occupied"`
} `json:"lag"`
Mtu int `json:"mtu"`
MacAddress string `json:"mac_address"`
Wwn string `json:"wwn"`
MgmtOnly bool `json:"mgmt_only"`
Description string `json:"description"`
Mode struct {
Label string `json:"label"`
Value string `json:"value"`
} `json:"mode"`
RFRole struct {
Label string `json:"label"`
Value string `json:"value"`
} `json:"rf_role"`
RFChannel struct {
Label string `json:"label"`
Value string `json:"value"`
} `json:"rf_channel"`
RFChannelFrequency int `json:"rf_channel_frequency"`
RFChannelWidth int `json:"rf_channel_width"`
TXPower int `json:"tx_power"`
UntaggedVlan struct {
ID int `json:"id"`
URL string `json:"url"`
Display string `json:"display"`
Vid int `json:"vid"`
Name string `json:"name"`
} `json:"untagged_vlan"`
TaggedVlans []struct {
ID int `json:"id"`
URL string `json:"url"`
Display string `json:"display"`
Vid int `json:"vid"`
Name string `json:"name"`
} `json:"tagged_vlans"`
MarkConnected bool `json:"mark_connected"`
Cable struct {
ID int `json:"id"`
URL string `json:"url"`
Display string `json:"display"`
Label string `json:"label"`
} `json:"cable"`
WirelessLink struct {
ID int `json:"id"`
URL string `json:"url"`
Display string `json:"display"`
Ssid string `json:"ssid"`
} `json:"wireless_link"`
LinkPeer interface{} `json:"link_peer"`
LinkPeerType string `json:"link_peer_type"`
WirelessLans []struct {
ID int `json:"id"`
URL string `json:"url"`
Display string `json:"display"`
Ssid string `json:"ssid"`
} `json:"wireless_lans"`
ConnectedEndpoint interface{} `json:"connected_endpoint"`
ConnectedEndpointType string `json:"connected_endpoint_type"`
ConnectedEndpointReachable bool `json:"connected_endpoint_reachable"`
Tags []struct {
ID int `json:"id"`
URL string `json:"url"`
Display string `json:"display"`
Name string `json:"name"`
Slug string `json:"slug"`
Color string `json:"color"`
} `json:"tags"`
CustomFields struct{} `json:"custom_fields"`
Created string `json:"created"`
LastUpdated time.Time `json:"last_updated"`
CountIpaddresses int `json:"count_ipaddresses"`
CountFhrpGroups int `json:"count_fhrp_groups"`
Occupied bool `json:"_occupied"`
} }
// InterfaceFilter is used to filter out returned object from Netbox API dcim_interfaces_list // InterfaceFilter is used to filter out returned object from Netbox API dcim_interfaces_list
type InterfaceFilter struct { type InterfaceFilter struct {
Offset int64 `schema:"offset,omitempty"`
Limit int64 `schema:"limit,omitempty"`
// User specific filters // User specific filters
ID string `schema:"id,omitempty"` ID string `schema:"id,omitempty"`
Name string `schema:"name,omitempty"` Name string `schema:"name,omitempty"`
@ -110,6 +198,9 @@ type InterfaceFilter struct {
Tag string `schema:"tag,omitempty"` Tag string `schema:"tag,omitempty"`
VLANID string `schema:"vlan_id,omitempty"` VLANID string `schema:"vlan_id,omitempty"`
VLAN string `schema:"vlan,omitempty"` VLAN string `schema:"vlan,omitempty"`
Offset int64 `schema:"offset,omitempty"`
Limit int64 `schema:"limit,omitempty"`
} }
const interfacesPath = dcimPath + "/interfaces" const interfacesPath = dcimPath + "/interfaces"
@ -144,19 +235,20 @@ func (s *InterfacesService) List(ctx context.Context, f *InterfaceFilter) (*Inte
} }
// Create a interfaces // Create a interfaces
func (s *InterfacesService) Create(ctx context.Context, c *NewInterface) error { func (s *InterfacesService) Create(ctx context.Context, c *NewInterface) (*Interface, error) {
var err error var err error
var req *http.Request var req *http.Request
var nic Interface
req, err = s.client.newRequest(ctx, "POST", interfacesPath, "", c) req, err = s.client.newRequest(ctx, "POST", interfacesPath, "", c)
if err != nil { if err != nil {
return fmt.Errorf("unable to create request: %w", err) return &nic, fmt.Errorf("unable to create request: %w", err)
} }
_, err = s.client.do(req, nil) _, err = s.client.do(req, &nic)
if err != nil { if err != nil {
return fmt.Errorf("unable to do request: %w", err) return &nic, fmt.Errorf("unable to do request: %w", err)
} }
return nil return &nic, nil
} }

191
virtual_machines.go
View file

@ -12,90 +12,124 @@ import (
type VirtualMachinesService service type VirtualMachinesService service
// VirtualMachines is a list of virtual-machines
type VirtualMachines struct { type VirtualMachines struct {
Next interface{} `json:"next"` Next interface{} `json:"next"`
Previous interface{} `json:"previous"` Previous interface{} `json:"previous"`
Results []struct { Results []VirtualMachine `json:"results"`
LastUpdated time.Time `json:"last_updated"` Count int `json:"count"`
Vcpus interface{} `json:"vcpus"` }
CustomFields interface{} `json:"custom_fields,omitempty"`
LocalContextData interface{} `json:"local_context_data"` // VirtualMachine is one virtual-machine
Disk interface{} `json:"disk"` type VirtualMachine struct {
Site interface{} `json:"site"` CustomFields interface{} `json:"custom_fields"`
Memory interface{} `json:"memory"` LastUpdated time.Time `json:"last_updated"`
ConfigContext interface{} `json:"config_context,omitempty"` Tenant struct {
Tenant interface{} `json:"tenant"` URL string `json:"url"`
PrimaryIP6 interface{} `json:"primary_ip6"` Display string `json:"display"`
Status struct { Name string `json:"name"`
Value string `json:"value"` Slug string `json:"slug"`
Label string `json:"label"` ID int `json:"id"`
} `json:"status"` } `json:"tenant"`
Name string `json:"name"` Site struct {
URL string `json:"url"` URL string `json:"url"`
Display string `json:"display"` Display string `json:"display"`
Created string `json:"created"` Name string `json:"name"`
Comments string `json:"comments"` Slug string `json:"slug"`
Platform struct { ID int `json:"id"`
URL string `json:"url"` } `json:"site"`
Display string `json:"display"` PrimaryIP6 struct {
Name string `json:"name"` URL string `json:"url"`
Slug string `json:"slug"` Display string `json:"display"`
ID int `json:"id"` Address string `json:"address"`
} `json:"platform"` ID int `json:"id"`
Role struct { Family int `json:"family"`
URL string `json:"url"` } `json:"primary_ip6"`
Display string `json:"display"` PrimaryIP struct {
Name string `json:"name"` URL string `json:"url"`
Slug string `json:"slug"` Display string `json:"display"`
ID int `json:"id"` Address string `json:"address"`
} `json:"role"` ID int `json:"id"`
Cluster struct { Family int `json:"family"`
URL string `json:"url"` } `json:"primary_ip"`
Display string `json:"display"` PrimaryIP4 struct {
Name string `json:"name"` URL string `json:"url"`
ID int `json:"id"` Display string `json:"display"`
} `json:"cluster"` Address string `json:"address"`
Tags []interface{} `json:"tags"` ID int `json:"id"`
PrimaryIP4 struct { Family int `json:"family"`
URL string `json:"url"` } `json:"primary_ip4"`
Display string `json:"display"` ConfigContext interface{} `json:"config_context"`
Address string `json:"address"` Status struct {
ID int `json:"id"` Label string `json:"label"`
Family int `json:"family"` Value string `json:"value"`
} `json:"primary_ip4"` } `json:"status"`
PrimaryIP struct { URL string `json:"url"`
URL string `json:"url"` Name string `json:"name"`
Display string `json:"display"` Display string `json:"display"`
Address string `json:"address"` Created string `json:"created"`
ID int `json:"id"` Comments string `json:"comments"`
Family int `json:"family"` LocalContextData string `json:"local_context_data"`
} `json:"primary_ip"` Cluster struct {
ID int `json:"id"` URL string `json:"url"`
} `json:"results"` Display string `json:"display"`
Count int `json:"count"` Name string `json:"name"`
ID int `json:"id"`
VirtualmachineCount int `json:"virtualmachine_count"`
} `json:"cluster"`
Tags []struct {
URL string `json:"url"`
Display string `json:"display"`
Name string `json:"name"`
Slug string `json:"slug"`
Color string `json:"color"`
ID int `json:"id"`
} `json:"tags"`
Platform struct {
URL string `json:"url"`
Display string `json:"display"`
Name string `json:"name"`
Slug string `json:"slug"`
ID int `json:"id"`
DeviceCount int `json:"device_count"`
VirtualmachineCount int `json:"virtualmachine_count"`
} `json:"platform"`
Role struct {
URL string `json:"url"`
Display string `json:"display"`
Name string `json:"name"`
Slug string `json:"slug"`
ID int `json:"id"`
DeviceCount int `json:"device_count"`
VirtualmachineCount int `json:"virtualmachine_count"`
} `json:"role"`
Disk int `json:"disk"`
Memory int `json:"memory"`
Vcpus int `json:"vcpus"`
ID int `json:"id"`
} }
// NewVirtualMachine is used to create new VirtualizationVirtualMachines // NewVirtualMachine is used to create new VirtualizationVirtualMachines
type NewVirtualMachine struct { type NewVirtualMachine struct {
CustomFields *struct{} `json:"custom_fields,omitempty"`
Status string `json:"status"`
LocalContextData interface{} `json:"local_context_data,omitempty"` LocalContextData interface{} `json:"local_context_data,omitempty"`
Comments string `json:"comments,omitempty"` CustomFields *struct{} `json:"custom_fields,omitempty"`
Name string `json:"name"`
Tags *[]struct { Tags *[]struct {
Name string `json:"name,omitempty"` Name string `json:"name,omitempty"`
Slug string `json:"slug,omitempty"` Slug string `json:"slug,omitempty"`
Color string `json:"color,omitempty"` Color string `json:"color,omitempty"`
} `json:"tags,omitempty"` } `json:"tags,omitempty"`
Platform int `json:"platform,omitempty"` Status string `json:"status"`
PrimaryIP4 int `json:"primary_ip4,omitempty"` Comments string `json:"comments,omitempty"`
VCPUs int `json:"vcpus,omitempty"` Name string `json:"name"`
Memory int `json:"memory,omitempty"` PrimaryIP4 int `json:"primary_ip4,omitempty"`
Disk int `json:"disk,omitempty"` Platform int `json:"platform,omitempty"`
Role int `json:"role,omitempty"` VCPUs int `json:"vcpus,omitempty"`
Cluster int `json:"cluster,omitempty"` Memory int `json:"memory,omitempty"`
Tenant int `json:"tenant,omitempty"` Disk int `json:"disk,omitempty"`
PrimaryIP6 int `json:"primary_ip6,omitempty"` Role int `json:"role,omitempty"`
Cluster int `json:"cluster,omitempty"`
Tenant int `json:"tenant,omitempty"`
PrimaryIP6 int `json:"primary_ip6,omitempty"`
} }
// VirtualMachineFilter is used to filter dcim_device_list query to the Netbox API // VirtualMachineFilter is used to filter dcim_device_list query to the Netbox API
@ -177,21 +211,22 @@ func (s *VirtualMachinesService) List(ctx context.Context, f *VirtualMachineFilt
} }
// Create a virtual-machine // Create a virtual-machine
func (s *VirtualMachinesService) Create(ctx context.Context, c *NewVirtualMachine) error { func (s *VirtualMachinesService) Create(ctx context.Context, c *NewVirtualMachine) (*VirtualMachine, error) {
var err error var err error
var req *http.Request var req *http.Request
var virtualMachine VirtualMachine
req, err = s.client.newRequest(ctx, "POST", virtualMachinesPath, "", c) req, err = s.client.newRequest(ctx, "POST", virtualMachinesPath, "", c)
if err != nil { if err != nil {
return fmt.Errorf("unable to create request: %w", err) return &virtualMachine, fmt.Errorf("unable to create request: %w", err)
} }
_, err = s.client.do(req, nil) _, err = s.client.do(req, &virtualMachine)
if err != nil { if err != nil {
return fmt.Errorf("unable to do request: %w", err) return &virtualMachine, fmt.Errorf("unable to do request: %w", err)
} }
return nil return &virtualMachine, nil
} }
// Delete a virtual-machine // Delete a virtual-machine