forked from linode/linode_api4-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnetworking.py
More file actions
258 lines (195 loc) · 7.36 KB
/
networking.py
File metadata and controls
258 lines (195 loc) · 7.36 KB
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
from dataclasses import dataclass
from typing import Optional
from linode_api4.errors import UnexpectedResponseError
from linode_api4.objects import Base, DerivedBase, JSONObject, Property, Region
class IPv6Pool(Base):
"""
DEPRECATED
"""
api_endpoint = "/networking/ipv6/pools/{range}"
id_attribute = "range"
properties = {
"range": Property(identifier=True),
"region": Property(slug_relationship=Region),
}
class IPv6Range(Base):
"""
An instance of a Linode IPv6 Range.
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-ipv6-range
"""
api_endpoint = "/networking/ipv6/ranges/{range}"
id_attribute = "range"
properties = {
"range": Property(identifier=True),
"region": Property(slug_relationship=Region),
"prefix": Property(),
"route_target": Property(),
"linodes": Property(
unordered=True,
),
"is_bgp": Property(),
}
@dataclass
class InstanceIPNAT1To1(JSONObject):
"""
InstanceIPNAT1To1 contains information about the NAT 1:1 mapping
of VPC IP together with the VPC and subnet ids.
"""
address: str = ""
subnet_id: int = 0
vpc_id: int = 0
class IPAddress(Base):
"""
note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
Represents a Linode IP address object.
When attempting to reset the `rdns` field to default, consider using the ExplicitNullValue class::
ip = IPAddress(client, "127.0.0.1")
ip.rdns = ExplicitNullValue
ip.save()
# Re-populate all attributes with new information from the API
ip.invalidate()
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-ip
"""
api_endpoint = "/networking/ips/{address}"
id_attribute = "address"
properties = {
"address": Property(identifier=True),
"gateway": Property(),
"subnet_mask": Property(),
"prefix": Property(),
"type": Property(),
"public": Property(),
"rdns": Property(mutable=True),
"linode_id": Property(),
"region": Property(slug_relationship=Region),
"vpc_nat_1_1": Property(json_object=InstanceIPNAT1To1),
}
@property
def linode(self):
from .linode import Instance # pylint: disable-all
if not hasattr(self, "_linode"):
self._set("_linode", Instance(self._client, self.linode_id))
return self._linode
def to(self, linode):
"""
This is a helper method for ip-assign, and should not be used outside
of that context. It's used to cleanly build an IP Assign request with
pretty python syntax.
"""
from .linode import Instance # pylint: disable-all
if not isinstance(linode, Instance):
raise ValueError("IP Address can only be assigned to a Linode!")
return {"address": self.address, "linode_id": linode.id}
@dataclass
class VPCIPAddress(JSONObject):
"""
VPCIPAddress represents the IP address of a VPC.
NOTE: This is not implemented as a typical API object (Base) because VPC IPs
cannot be refreshed through the /networking/ips/{address} endpoint.
"""
address: str = ""
gateway: str = ""
region: str = ""
subnet_mask: str = ""
vpc_id: int = 0
subnet_id: int = 0
linode_id: int = 0
config_id: int = 0
interface_id: int = 0
prefix: int = 0
active: bool = False
address_range: Optional[str] = None
nat_1_1: Optional[str] = None
class VLAN(Base):
"""
.. note:: At this time, the Linode API only supports listing VLANs.
.. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
An instance of a Linode VLAN.
VLANs provide a mechanism for secure communication between two or more Linodes that are assigned to the same VLAN.
VLANs are implicitly created during Instance or Instance Config creation.
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-vlans
"""
api_endpoint = "/networking/vlans/{label}"
id_attribute = "label"
properties = {
"label": Property(identifier=True),
"created": Property(is_datetime=True),
"linodes": Property(unordered=True),
"region": Property(slug_relationship=Region),
}
class FirewallDevice(DerivedBase):
"""
An object representing the assignment between a Linode Firewall and another Linode resource.
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-firewall-device
"""
api_endpoint = "/networking/firewalls/{firewall_id}/devices/{id}"
derived_url_path = "devices"
parent_id_name = "firewall_id"
properties = {
"created": Property(is_datetime=True),
"updated": Property(is_datetime=True),
"entity": Property(),
"id": Property(identifier=True),
}
class Firewall(Base):
"""
.. note:: This endpoint is in beta. This will only function if base_url is set to `https://api.linode.com/v4beta`.
An instance of a Linode Cloud Firewall.
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-firewall
"""
api_endpoint = "/networking/firewalls/{id}"
properties = {
"id": Property(identifier=True),
"label": Property(mutable=True),
"tags": Property(mutable=True, unordered=True),
"status": Property(mutable=True),
"created": Property(is_datetime=True),
"updated": Property(is_datetime=True),
"devices": Property(derived_class=FirewallDevice),
"rules": Property(),
}
def update_rules(self, rules):
"""
Sets the JSON rules for this Firewall.
API Documentation: https://techdocs.akamai.com/linode-api/reference/put-firewall-rules
:param rules: The rules to apply to this Firewall.
:type rules: dict
"""
self._client.put(
"{}/rules".format(self.api_endpoint), model=self, data=rules
)
self.invalidate()
def get_rules(self):
"""
Gets the JSON rules for this Firewall.
API Documentation: https://techdocs.akamai.com/linode-api/reference/put-firewall-rules
:returns: The rules that this Firewall is currently configured with.
:rtype: dict
"""
return self._client.get(
"{}/rules".format(self.api_endpoint), model=self
)
def device_create(self, id, type="linode", **kwargs):
"""
Creates and attaches a device to this Firewall
API Documentation: https://techdocs.akamai.com/linode-api/reference/post-firewall-device
:param id: The ID of the entity to create a device for.
:type id: int
:param type: The type of entity the device is being created for. (`linode`)
:type type: str
"""
params = {
"id": id,
"type": type,
}
params.update(kwargs)
result = self._client.post(
"{}/devices".format(Firewall.api_endpoint), model=self, data=params
)
self.invalidate()
if not "id" in result:
raise UnexpectedResponseError(
"Unexpected response creating device!", json=result
)
c = FirewallDevice(self._client, result["id"], self.id, result)
return c