Skip to content
Navigation Menu
{{ message }}
forked from MoroccoAgriServices/softlayer-python
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathnetwork.py
More file actions
429 lines (346 loc) · 16.6 KB
/
Copy pathnetwork.py
File metadata and controls
429 lines (346 loc) · 16.6 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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
"""
SoftLayer.network
~~~~~~~~~~~~~~~~~
Network Manager/helpers
:license: MIT, see LICENSE for more details.
"""
import collections
from SoftLayer import exceptions
from SoftLayer import utils
DEFAULT_SUBNET_MASK = ','.join(['hardware',
'datacenter',
'ipAddressCount',
'virtualGuests',
'networkVlan[id,networkSpace]'])
DEFAULT_VLAN_MASK = ','.join([
'firewallInterfaces',
'hardwareCount',
'primaryRouter[id, fullyQualifiedDomainName, datacenter]',
'subnetCount',
'totalPrimaryIpAddressCount',
'virtualGuestCount',
'networkSpace',
])
DEFAULT_GET_VLAN_MASK = ','.join([
'firewallInterfaces',
'primaryRouter[id, fullyQualifiedDomainName, datacenter]',
'totalPrimaryIpAddressCount',
'networkSpace',
'hardware',
'subnets',
'virtualGuests',
])
class NetworkManager(object):
"""Manage SoftLayer network objects: VLANs, subnets, IPs and rwhois
See product information here: http://www.softlayer.com/networking
:param SoftLayer.API.BaseClient client: the client instance
"""
def __init__(self, client):
self.client = client
self.account = client['Account']
self.vlan = client['Network_Vlan']
self.subnet = client['Network_Subnet']
self.network_storage = self.client['Network_Storage']
def add_global_ip(self, version=4, test_order=False):
"""Adds a global IP address to the account.
:param int version: Specifies whether this is IPv4 or IPv6
:param bool test_order: If true, this will only verify the order.
"""
# This method is here to improve the public interface from a user's
# perspective since ordering a single global IP through the subnet
# interface is not intuitive.
return self.add_subnet('global', version=version,
test_order=test_order)
def add_subnet(self, subnet_type, quantity=None, vlan_id=None, version=4,
test_order=False):
"""Orders a new subnet
:param str subnet_type: Type of subnet to add: private, public, global
:param int quantity: Number of IPs in the subnet
:param int vlan_id: VLAN id for the subnet to be placed into
:param int version: 4 for IPv4, 6 for IPv6
:param bool test_order: If true, this will only verify the order.
"""
package = self.client['Product_Package']
category = 'sov_sec_ip_addresses_priv'
desc = ''
if version == 4:
if subnet_type == 'global':
quantity = 0
category = 'global_ipv4'
elif subnet_type == 'public':
category = 'sov_sec_ip_addresses_pub'
else:
category = 'static_ipv6_addresses'
if subnet_type == 'global':
quantity = 0
category = 'global_ipv6'
desc = 'Global'
elif subnet_type == 'public':
desc = 'Portable'
# In the API, every non-server item is contained within package ID 0.
# This means that we need to get all of the items and loop through them
# looking for the items we need based upon the category, quantity, and
# item description.
price_id = None
quantity_str = str(quantity)
for item in package.getItems(id=0, mask='itemCategory'):
category_code = utils.lookup(item, 'itemCategory', 'categoryCode')
if all([category_code == category,
item.get('capacity') == quantity_str,
version == 4 or (version == 6 and
desc in item['description'])]):
price_id = item['prices'][0]['id']
break
if not price_id:
raise TypeError('Invalid combination specified for ordering a'
' subnet.')
order = {
'packageId': 0,
'prices': [{'id': price_id}],
'quantity': 1,
# This is necessary in order for the XML-RPC endpoint to select the
# correct order container
'complexType': 'SoftLayer_Container_Product_Order_Network_Subnet',
}
if subnet_type != 'global':
order['endPointVlanId'] = vlan_id
if test_order:
return self.client['Product_Order'].verifyOrder(order)
else:
return self.client['Product_Order'].placeOrder(order)
def assign_global_ip(self, global_ip_id, target):
"""Assigns a global IP address to a specified target.
:param int global_ip_id: The ID of the global IP being assigned
:param string target: The IP address to assign
"""
return self.client['Network_Subnet_IpAddress_Global'].route(
target, id=global_ip_id)
def cancel_global_ip(self, global_ip_id):
"""Cancels the specified global IP address.
:param int id: The ID of the global IP to be cancelled.
"""
service = self.client['Network_Subnet_IpAddress_Global']
ip_address = service.getObject(id=global_ip_id, mask='billingItem')
billing_id = ip_address['billingItem']['id']
return self.client['Billing_Item'].cancelService(id=billing_id)
def cancel_subnet(self, subnet_id):
"""Cancels the specified subnet.
:param int subnet_id: The ID of the subnet to be cancelled.
"""
subnet = self.get_subnet(subnet_id, mask='id, billingItem.id')
if "billingItem" not in subnet:
raise exceptions.SoftLayerError("subnet %s can not be cancelled"
" " % subnet_id)
billing_id = subnet['billingItem']['id']
return self.client['Billing_Item'].cancelService(id=billing_id)
def edit_rwhois(self, abuse_email=None, address1=None, address2=None,
city=None, company_name=None, country=None,
first_name=None, last_name=None, postal_code=None,
private_residence=None, state=None):
"""Edit rwhois record."""
update = {}
for key, value in [('abuseEmail', abuse_email),
('address1', address1),
('address2', address2),
('city', city),
('companyName', company_name),
('country', country),
('firstName', first_name),
('lastName', last_name),
('privateResidenceFlag', private_residence),
('state', state),
('postalCode', postal_code)]:
if value is not None:
update[key] = value
# If there's anything to update, update it
if update:
rwhois = self.get_rwhois()
return self.client['Network_Subnet_Rwhois_Data'].editObject(
update, id=rwhois['id'])
return True
def ip_lookup(self, ip_address):
"""Looks up an IP address and returns network information about it.
:param string ip_address: An IP address. Can be IPv4 or IPv6
:returns: A dictionary of information about the IP
"""
obj = self.client['Network_Subnet_IpAddress']
return obj.getByIpAddress(ip_address, mask='hardware, virtualGuest')
def get_rwhois(self):
"""Returns the RWhois information about the current account.
:returns: A dictionary containing the account's RWhois information.
"""
return self.account.getRwhoisData()
def get_subnet(self, subnet_id, **kwargs):
"""Returns information about a single subnet.
:param string id: Either the ID for the subnet or its network
identifier
:returns: A dictionary of information about the subnet
"""
if 'mask' not in kwargs:
kwargs['mask'] = DEFAULT_SUBNET_MASK
return self.subnet.getObject(id=subnet_id, **kwargs)
def get_vlan(self, vlan_id):
"""Returns information about a single VLAN.
:param int id: The unique identifier for the VLAN
:returns: A dictionary containing a large amount of information about
the specified VLAN.
"""
return self.vlan.getObject(id=vlan_id, mask=DEFAULT_GET_VLAN_MASK)
def list_global_ips(self, version=None, identifier=None, **kwargs):
"""Returns a list of all global IP address records on the account.
:param int version: Only returns IPs of this version (4 or 6)
:param string identifier: If specified, the list will only contain the
global ips matching this network identifier.
"""
if 'mask' not in kwargs:
mask = ['destinationIpAddress[hardware, virtualGuest]',
'ipAddress']
kwargs['mask'] = ','.join(mask)
_filter = utils.NestedDict({})
if version:
ver = utils.query_filter(version)
_filter['globalIpRecords']['ipAddress']['subnet']['version'] = ver
if identifier:
subnet_filter = _filter['globalIpRecords']['ipAddress']['subnet']
subnet_filter['networkIdentifier'] = utils.query_filter(identifier)
kwargs['filter'] = _filter.to_dict()
return self.account.getGlobalIpRecords(**kwargs)
def list_subnets(self, identifier=None, datacenter=None, version=0,
subnet_type=None, network_space=None, **kwargs):
"""Display a list of all subnets on the account.
This provides a quick overview of all subnets including information
about data center residence and the number of devices attached.
:param string identifier: If specified, the list will only contain the
subnet matching this network identifier.
:param string datacenter: If specified, the list will only contain
subnets in the specified data center.
:param int version: Only returns subnets of this version (4 or 6).
:param string subnet_type: If specified, it will only returns subnets
of this type.
:param string network_space: If specified, it will only returns subnets
with the given address space label.
:param dict \\*\\*kwargs: response-level options (mask, limit, etc.)
"""
if 'mask' not in kwargs:
kwargs['mask'] = DEFAULT_SUBNET_MASK
_filter = utils.NestedDict(kwargs.get('filter') or {})
if identifier:
_filter['subnets']['networkIdentifier'] = (
utils.query_filter(identifier))
if datacenter:
_filter['subnets']['datacenter']['name'] = (
utils.query_filter(datacenter))
if version:
_filter['subnets']['version'] = utils.query_filter(version)
if subnet_type:
_filter['subnets']['subnetType'] = utils.query_filter(subnet_type)
else:
# This filters out global IPs from the subnet listing.
_filter['subnets']['subnetType'] = {'operation': '!= GLOBAL_IP'}
if network_space:
_filter['subnets']['networkVlan']['networkSpace'] = (
utils.query_filter(network_space))
kwargs['filter'] = _filter.to_dict()
return self.account.getSubnets(**kwargs)
def list_vlans(self, datacenter=None, vlan_number=None, name=None,
**kwargs):
"""Display a list of all VLANs on the account.
This provides a quick overview of all VLANs including information about
data center residence and the number of devices attached.
:param string datacenter: If specified, the list will only contain
VLANs in the specified data center.
:param int vlan_number: If specified, the list will only contain the
VLAN matching this VLAN number.
:param int name: If specified, the list will only contain the
VLAN matching this VLAN name.
:param dict \\*\\*kwargs: response-level options (mask, limit, etc.)
"""
_filter = utils.NestedDict(kwargs.get('filter') or {})
if vlan_number:
_filter['networkVlans']['vlanNumber'] = (
utils.query_filter(vlan_number))
if name:
_filter['networkVlans']['name'] = utils.query_filter(name)
if datacenter:
_filter['networkVlans']['primaryRouter']['datacenter']['name'] = (
utils.query_filter(datacenter))
kwargs['filter'] = _filter.to_dict()
if 'mask' not in kwargs:
kwargs['mask'] = DEFAULT_VLAN_MASK
return self.account.getNetworkVlans(**kwargs)
def resolve_global_ip_ids(self, identifier):
"""Resolve global ip ids."""
return utils.resolve_ids(identifier,
[self._list_global_ips_by_identifier])
def resolve_subnet_ids(self, identifier):
"""Resolve subnet ids."""
return utils.resolve_ids(identifier,
[self._list_subnets_by_identifier])
def resolve_vlan_ids(self, identifier):
"""Resolve VLAN ids."""
return utils.resolve_ids(identifier, [self._list_vlans_by_name])
def summary_by_datacenter(self):
"""Summary of the networks on the account, grouped by data center.
The resultant dictionary is primarily useful for statistical purposes.
It contains count information rather than raw data. If you want raw
information, see the :func:`list_vlans` method instead.
:returns: A dictionary keyed by data center with the data containing a
set of counts for subnets, hardware, virtual servers, and
other objects residing within that data center.
"""
datacenters = collections.defaultdict(lambda: {
'hardware_count': 0,
'public_ip_count': 0,
'subnet_count': 0,
'virtual_guest_count': 0,
'vlan_count': 0,
})
for vlan in self.list_vlans():
name = utils.lookup(vlan, 'primaryRouter', 'datacenter', 'name')
datacenters[name]['vlan_count'] += 1
datacenters[name]['public_ip_count'] += (
vlan['totalPrimaryIpAddressCount'])
datacenters[name]['subnet_count'] += vlan['subnetCount']
# NOTE(kmcdonald): Only count hardware/guests once
if vlan.get('networkSpace') == 'PRIVATE':
datacenters[name]['hardware_count'] += (
vlan['hardwareCount'])
datacenters[name]['virtual_guest_count'] += (
vlan['virtualGuestCount'])
return dict(datacenters)
def unassign_global_ip(self, global_ip_id):
"""Unassigns a global IP address from a target.
:param int id: The ID of the global IP being unassigned
"""
return self.client['Network_Subnet_IpAddress_Global'].unroute(
id=global_ip_id)
def _list_global_ips_by_identifier(self, identifier):
"""Returns a list of IDs of the global IP matching the identifier.
:param string identifier: The identifier to look up
:returns: List of matching IDs
"""
results = self.list_global_ips(identifier=identifier, mask='id')
return [result['id'] for result in results]
def _list_subnets_by_identifier(self, identifier):
"""Returns a list of IDs of the subnet matching the identifier.
:param string identifier: The identifier to look up
:returns: List of matching IDs
"""
identifier = identifier.split('/', 1)[0]
results = self.list_subnets(identifier=identifier, mask='id')
return [result['id'] for result in results]
def _list_vlans_by_name(self, name):
"""Returns a list of IDs of VLANs which match the given VLAN name.
:param string name: a VLAN name
:returns: List of matching IDs
"""
results = self.list_vlans(name=name, mask='id')
return [result['id'] for result in results]
def get_nas_credentials(self, identifier, **kwargs):
"""Returns a list of IDs of VLANs which match the given VLAN name.
:param integer instance_id: the instance ID
:returns: A dictionary containing a large amount of information about
the specified instance.
"""
result = self.network_storage.getObject(id=identifier, **kwargs)
return result
You can’t perform that action at this time.