1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
package osapi
// Copied from https://raw.githubusercontent.com/lxc/incus-os/refs/heads/main/incus-osd/api/system_network.go
// License: Apache-2.0
import (
"slices"
)
const (
// SystemNetworkInterfaceRoleManagement represents the "management" role.
SystemNetworkInterfaceRoleManagement = "management"
// SystemNetworkInterfaceRoleCluster represents the "cluster" role.
SystemNetworkInterfaceRoleCluster = "cluster"
// SystemNetworkInterfaceRoleInstances represents the "instances" role.
SystemNetworkInterfaceRoleInstances = "instances"
// SystemNetworkInterfaceRoleStorage represents the "storage" role.
SystemNetworkInterfaceRoleStorage = "storage"
)
// SystemNetwork defines a struct to hold the three types of supported network configuration.
type SystemNetwork struct {
Config *SystemNetworkConfig `json:"config" yaml:"config"`
State SystemNetworkState `incusos:"-" json:"state" yaml:"state"`
}
// SystemNetworkConfig represents the user modifiable network configuration.
type SystemNetworkConfig struct {
DNS *SystemNetworkDNS `json:"dns,omitempty" yaml:"dns,omitempty"`
NTP *SystemNetworkNTP `json:"ntp,omitempty" yaml:"ntp,omitempty"`
Proxy *SystemNetworkProxy `json:"proxy,omitempty" yaml:"proxy,omitempty"`
Interfaces []SystemNetworkInterface `json:"interfaces,omitempty" yaml:"interfaces,omitempty"`
Bonds []SystemNetworkBond `json:"bonds,omitempty" yaml:"bonds,omitempty"`
VLANs []SystemNetworkVLAN `json:"vlans,omitempty" yaml:"vlans,omitempty"`
}
// SystemNetworkInterface contains information about a network interface.
type SystemNetworkInterface struct {
Name string `json:"name" yaml:"name"`
MTU int `json:"mtu,omitempty" yaml:"mtu,omitempty"`
VLAN int `json:"vlan,omitempty" yaml:"vlan,omitempty"`
VLANTags []int `json:"vlan_tags,omitempty" yaml:"vlan_tags,omitempty"`
Addresses []string `json:"addresses,omitempty" yaml:"addresses,omitempty"`
RequiredForOnline string `json:"required_for_online,omitempty" yaml:"required_for_online,omitempty"`
Routes []SystemNetworkRoute `json:"routes,omitempty" yaml:"routes,omitempty"`
Hwaddr string `json:"hwaddr" yaml:"hwaddr"`
Roles []string `json:"roles,omitempty" yaml:"roles,omitempty"`
LLDP bool `json:"lldp" yaml:"lldp"`
}
// SystemNetworkBond contains information about a network bond.
type SystemNetworkBond struct {
Name string `json:"name" yaml:"name"`
Mode string `json:"mode" yaml:"mode"`
MTU int `json:"mtu,omitempty" yaml:"mtu,omitempty"`
VLAN int `json:"vlan,omitempty" yaml:"vlan,omitempty"`
VLANTags []int `json:"vlan_tags,omitempty" yaml:"vlan_tags,omitempty"`
Addresses []string `json:"addresses,omitempty" yaml:"addresses,omitempty"`
RequiredForOnline string `json:"required_for_online,omitempty" yaml:"required_for_online,omitempty"`
Routes []SystemNetworkRoute `json:"routes,omitempty" yaml:"routes,omitempty"`
Hwaddr string `json:"hwaddr,omitempty" yaml:"hwaddr,omitempty"`
Members []string `json:"members,omitempty" yaml:"members,omitempty"`
Roles []string `json:"roles,omitempty" yaml:"roles,omitempty"`
LLDP bool `json:"lldp" yaml:"lldp"`
}
// SystemNetworkVLAN contains information about a network vlan.
type SystemNetworkVLAN struct {
Name string `json:"name" yaml:"name"`
Parent string `json:"parent" yaml:"parent"`
ID int `json:"id" yaml:"id"`
MTU int `json:"mtu,omitempty" yaml:"mtu,omitempty"`
Addresses []string `json:"addresses,omitempty" yaml:"addresses,omitempty"`
RequiredForOnline string `json:"required_for_online,omitempty" yaml:"required_for_online,omitempty"`
Routes []SystemNetworkRoute `json:"routes,omitempty" yaml:"routes,omitempty"`
Roles []string `json:"roles,omitempty" yaml:"roles,omitempty"`
}
// SystemNetworkRoute defines a route.
type SystemNetworkRoute struct {
To string `json:"to" yaml:"to"`
Via string `json:"via" yaml:"via"`
}
// SystemNetworkDNS defines DNS configuration options.
type SystemNetworkDNS struct {
Hostname string `json:"hostname" yaml:"hostname"`
Domain string `json:"domain" yaml:"domain"`
SearchDomains []string `json:"search_domains,omitempty" yaml:"search_domains,omitempty"`
Nameservers []string `json:"nameservers,omitempty" yaml:"nameservers,omitempty"`
}
// SystemNetworkNTP defines static timeservers to use.
type SystemNetworkNTP struct {
Timeservers []string `json:"timeservers,omitempty" yaml:"timeservers,omitempty"`
}
// SystemNetworkProxy defines proxy configuration.
type SystemNetworkProxy struct {
Servers map[string]SystemNetworkProxyServer `json:"servers,omitempty" yaml:"servers,omitempty"`
Rules []SystemNetworkProxyRule `json:"rules,omitempty" yaml:"rules,omitempty"`
}
// SystemNetworkProxyServer defines a proxy server configuration.
type SystemNetworkProxyServer struct {
Host string `json:"host" yaml:"host"`
UseTLS bool `json:"use_tls" yaml:"use_tls"`
Auth string `json:"auth" yaml:"auth"`
Username string `json:"username,omitempty" yaml:"username,omitempty"`
Password string `json:"password,omitempty" yaml:"password,omitempty"`
Realm string `json:"realm,omitempty" yaml:"realm,omitempty"`
}
// SystemNetworkProxyRule defines a proxy rule.
type SystemNetworkProxyRule struct {
Destination string `json:"destination" yaml:"destination"`
Target string `json:"target" yaml:"target"`
}
// SystemNetworkState holds information about the current network state.
type SystemNetworkState struct {
Interfaces map[string]SystemNetworkInterfaceState `json:"interfaces" yaml:"interfaces"`
}
// GetInterfaceNamesByRole returns a slice of interface names that have the given role applied to them.
func (n *SystemNetworkState) GetInterfaceNamesByRole(role string) []string {
names := []string{}
for name, iState := range n.Interfaces {
if slices.Contains(iState.Roles, role) {
names = append(names, name)
}
}
return names
}
// SystemNetworkInterfaceState holds state information about a specific network interface.
type SystemNetworkInterfaceState struct {
Type string `json:"type,omitempty" yaml:"type,omitempty"`
Addresses []string `json:"addresses,omitempty" yaml:"addresses,omitempty"`
Hwaddr string `json:"hwaddr" yaml:"hwaddr"`
Routes []SystemNetworkRoute `json:"routes,omitempty" yaml:"routes,omitempty"`
MTU int `json:"mtu,omitempty" yaml:"mtu,omitempty"`
Speed string `json:"speed,omitempty" yaml:"speed,omitempty"`
State string `json:"state" yaml:"state"`
Stats SystemNetworkInterfaceStats `json:"stats" yaml:"stats"`
LLDP []SystemNetworkLLDPState `json:"lldp,omitempty" yaml:"lldp,omitempty"`
LACP *SystemNetworkLACPState `json:"lacp,omitempty" yaml:"lacp,omitempty"`
Members map[string]SystemNetworkInterfaceState `json:"members,omitempty" yaml:"members,omitempty"`
Roles []string `json:"roles,omitempty" yaml:"roles,omitempty"`
}
// SystemNetworkInterfaceStats holds RX/TX stats for an interface.
type SystemNetworkInterfaceStats struct {
RXBytes int `json:"rx_bytes" yaml:"rx_bytes"`
TXBytes int `json:"tx_bytes" yaml:"tx_bytes"`
RXErrors int `json:"rx_errors" yaml:"rx_errors"`
TXErrors int `json:"tx_errors" yaml:"tx_errors"`
}
// SystemNetworkLLDPState holds information about the LLDP state.
type SystemNetworkLLDPState struct {
Name string `json:"name" yaml:"name"`
ChassisID string `json:"chassis_id" yaml:"chassis_id"`
PortID string `json:"port_id" yaml:"port_id"`
Port string `json:"port,omitempty" yaml:"port,omitempty"`
}
// SystemNetworkLACPState holds information about a bond's LACP state.
type SystemNetworkLACPState struct {
LocalMAC string `json:"local_mac" yaml:"local_mac"`
RemoteMAC string `json:"remote_mac" yaml:"remote_mac"`
}
|
