"""
SoftLayer.network
~~~~~~~~~~~~~~~~~
Network Manager/helpers
:license: MIT, see LICENSE for more details.
"""
from SoftLayer import exceptions
from SoftLayer import utils
DEFAULT_SUBNET_MASK = ','.join(['hardware',
'datacenter',
'ipAddressCount',
'virtualGuests'])
DEFAULT_VLAN_MASK = ','.join(['firewallInterfaces',
'hardware',
'networkComponents',
'primaryRouter' # Lack of comma intential
'[id, fullyQualifiedDomainName, datacenter]',
'subnets',
'totalPrimaryIpAddressCount',
'virtualGuests'])
[docs]class NetworkManager(object):
""" Manage Networks """
def __init__(self, client):
self.client = client
self.account = client['Account']
self.vlan = client['Network_Vlan']
self.subnet = client['Network_Subnet']
[docs] 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)
[docs] 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)
[docs] 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)
[docs] 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)
[docs] 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)
[docs] 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()
self.client['Network_Subnet_Rwhois_Data'].editObject(
update, id=rwhois['id'])
[docs] 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')
[docs] 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()
[docs] 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)
[docs] 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_VLAN_MASK)
[docs] 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)
[docs] def list_subnets(self, identifier=None, datacenter=None, version=0,
subnet_type=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 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'}
kwargs['filter'] = _filter.to_dict()
return self.account.getSubnets(**kwargs)
[docs] 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)
[docs] def resolve_global_ip_ids(self, identifier):
""" Resolve global ip ids """
return utils.resolve_ids(identifier,
[self._list_global_ips_by_identifier])
[docs] def resolve_subnet_ids(self, identifier):
""" Resolve subnet ids """
return utils.resolve_ids(identifier,
[self._list_subnets_by_identifier])
[docs] def resolve_vlan_ids(self, identifier):
""" Resolve VLAN ids """
return utils.resolve_ids(identifier, [self._list_vlans_by_name])
[docs] def summary_by_datacenter(self):
""" Provides a dictionary with a summary of all network information 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
series of counts for hardware, subnets, CCIs, and other
objects residing within that data center.
"""
datacenters = {}
unique_vms = []
unique_servers = []
unique_network = []
for vlan in self.list_vlans():
name = utils.lookup(vlan, 'primaryRouter', 'datacenter', 'name')
if name not in datacenters:
datacenters[name] = {
'hardwareCount': 0,
'networkingCount': 0,
'primaryIpCount': 0,
'subnetCount': 0,
'virtualGuestCount': 0,
'vlanCount': 0,
}
datacenters[name]['vlanCount'] += 1
for hardware in vlan['hardware']:
if hardware['id'] not in unique_servers:
datacenters[name]['hardwareCount'] += 1
unique_servers.append(hardware['id'])
for net in vlan['networkComponents']:
if net['id'] not in unique_network:
datacenters[name]['networkingCount'] += 1
unique_network.append(net['id'])
for virtual_guest in vlan['virtualGuests']:
if virtual_guest['id'] not in unique_vms:
datacenters[name]['virtualGuestCount'] += 1
unique_vms.append(virtual_guest['id'])
datacenters[name]['primaryIpCount'] += (
vlan['totalPrimaryIpAddressCount'])
datacenters[name]['subnetCount'] += len(vlan['subnets'])
return datacenters
[docs] 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 specified
network 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 specified
network 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]