Added 'slcli hw vlan-add' and 'slcli hw vlan-list'

Author: allmightyspiff

SoftLayer/CLI/hardware/vlan_add.py

@@ -0,0 +1,58 @@
+"""Trunk a VLAN to this server."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import exceptions
+from SoftLayer.CLI import helpers
+
+
+@click.command(cls=SoftLayer.CLI.command.SLCommand, )
+@click.argument('hardware', nargs=1)
+@click.argument('vlans', nargs=-1)
+@environment.pass_env
+def cli(env, hardware, vlans):
+    """Trunk a VLAN to this server.
+
+    HARDWARE is the id of the server
+    VLANS is the ID, name, or number of the VLANs you want to add. Multiple vlans can be added at the same time.
+    It is recommended to use the vlan ID, especially if you have multiple vlans with the same name/number.
+    """
+
+    h_mgr = SoftLayer.HardwareManager(env.client)
+    n_mgr = SoftLayer.NetworkManager(env.client)
+    hw_id = helpers.resolve_id(h_mgr.resolve_ids, hardware, 'hardware')
+    # Enclosing in quotes is required for any input that has a space in it.
+    # "Public DAL10" for example needs to be sent to search as \"Public DAL10\"
+    sl_vlans = n_mgr.search_for_vlan(" ".join(f"\"{v}\"" for v in vlans))
+    if not sl_vlans:
+        raise exceptions.ArgumentError(f"No vlans found matching {' '.join(vlans)}")
+    add_vlans = parse_vlans(sl_vlans)
+    component_mask = "mask[id, name, port, macAddress, primaryIpAddress]"
+    # TODO: Add nice output / exception handling
+    if len(add_vlans['public']) > 0:
+        components = h_mgr.get_network_components(hw_id, mask=component_mask, space='public')
+        for c in components:
+            if c.get('primaryIpAddress'):
+                h_mgr.trunk_vlan(c.get('id'), add_vlans['public'])
+    if len(add_vlans['private']) > 0:
+        components = h_mgr.get_network_components(hw_id, mask=component_mask, space='private')
+        for c in components:
+            if c.get('primaryIpAddress'):
+                h_mgr.trunk_vlan(c.get('id'), add_vlans['private'])
+
+
+def parse_vlans(vlans):
+    """returns a dictionary mapping for public / private vlans"""
+
+    pub_vlan = []
+    pri_vlan = []
+    for vlan in vlans:
+        print(f"{vlan.get('networkSpace')} | {vlan.get('id')} -> {vlan.get('vlanNumber')}")
+        if vlan.get('networkSpace') == "PUBLIC":
+            pub_vlan.append(vlan)
+        else:
+            pri_vlan.append(vlan)
+    return {"public": pub_vlan, "private": pri_vlan}

SoftLayer/CLI/hardware/vlan_list.py

@@ -0,0 +1,34 @@
+"""List VLANs this server can be attached to."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+from SoftLayer.CLI import helpers
+
+
+@click.command(cls=SoftLayer.CLI.command.SLCommand, )
+@click.argument('hardware')
+@environment.pass_env
+def cli(env, hardware):
+    """List VLANs this server can be attached to."""
+
+    mgr = SoftLayer.HardwareManager(env.client)
+    hw_id = helpers.resolve_id(mgr.resolve_ids, hardware, 'hardware')
+    mask = (
+        "mask[id,primaryIpAddress,"
+        "networkVlansTrunkable[id,name,vlanNumber,fullyQualifiedName,networkSpace]]"
+    )
+    table = formatting.Table([
+        "ID", "VLAN", "Name", "Space"
+    ])
+    hw_components = env.client.call('SoftLayer_Hardware_Server', 'getNetworkComponents', id=hw_id, mask=mask)
+    for component in hw_components:
+        if component.get('primaryIpAddress'):
+            for vlan in component.get('networkVlansTrunkable', []):
+                table.add_row([
+                    vlan.get('id'), vlan.get('fullyQualifiedName'), vlan.get('name'), vlan.get('networkSpace')
+                ])
+    env.fout(table)

SoftLayer/CLI/routes.py

@@ -315,6 +315,8 @@
     ('hardware:notification-add', 'SoftLayer.CLI.hardware.notification_add:cli'),
     ('hardware:notification-delete', 'SoftLayer.CLI.hardware.notification_delete:cli'),
     ('hardware:create-credential', 'SoftLayer.CLI.hardware.create_credential:cli'),
+    ('hardware:vlan-list', 'SoftLayer.CLI.hardware.vlan_list:cli'),
+    ('hardware:vlan-add', 'SoftLayer.CLI.hardware.vlan_add:cli'),
 
     ('securitygroup', 'SoftLayer.CLI.securitygroup'),
     ('securitygroup:list', 'SoftLayer.CLI.securitygroup.list:cli'),

SoftLayer/managers/hardware.py

@@ -1164,22 +1164,42 @@ def get_components(self, hardware_id, mask=None, filter_component=None):
                         "createDate": {
                             "operation": "orderBy",
                             "options": [
-                                {
-                                    "name": "sort",
-                                    "value": [
-                                        "DESC"
-                                    ]
-                                },
-                                {
-                                    "name": "sortOrder",
-                                    "value": [
-                                        1
-                                    ]}]}
-                    }}}}
+                                {"name": "sort", "value": ["DESC"]},
+                                {"name": "sortOrder", "value": [1]}
+                            ]
+                        }
+                    }
+                }}}
 
         return self.client.call('Hardware_Server', 'getComponents',
                                 mask=mask, filter=filter_component, id=hardware_id)
 
+    def get_network_components(self, hardware_id, mask=None, space=None):
+        """Calls SoftLayer_Hardware_Server::getNetworkComponents()
+
+        :param int hardware_id: SoftLayer_Hardware_Server id
+        :param string mask: The object mask to use if you do not want the default
+        :param string space: 'public', 'private', or None for both.
+        :returns: https://sldn.softlayer.com/reference/datatypes/SoftLayer_Network_Component/
+        """
+
+        if mask is None:
+            mask = "mask[uplinkComponent, router, redundancyEnabledFlag, redundancyCapableFlag]"
+        method = "getNetworkComponents"
+        if space == "public":
+            method = "getFrontendNetworkComponents"
+        elif space == "private":
+            method = "getBackendNetworkComponents"
+        return self.client.call("SoftLayer_Hardware_Server", method, id=hardware_id, mask=mask)
+
+    def trunk_vlan(self, component_id, vlans):
+        """Calls SoftLayer_Network_Component::addNetworkVlanTrunks()
+
+        :param int component_id: SoftLayer_Network_Component id
+        :param list vlans: list of SoftLayer_Network_Vlan objects to add. Each object needs at least id or vlanNumber
+        """
+        return self.client.call('SoftLayer_Network_Component', 'addNetworkVlanTrunks', vlans, id=component_id)
+
     def get_sensors(self, hardware_id):
         """Returns Hardware sensor data"""
         return self.client.call('Hardware', 'getSensorData', id=hardware_id)

SoftLayer/managers/network.py

@@ -81,6 +81,7 @@ def __init__(self, client):
         self.subnet = client['Network_Subnet']
         self.network_storage = self.client['Network_Storage']
         self.security_group = self.client['Network_SecurityGroup']
+        self.resolvers = [self.search_for_vlan]
 
     def add_global_ip(self, version=4, test_order=False):
         """Adds a global IP address to the account.
@@ -887,3 +888,17 @@ def clear_route(self, identifier):
         returns  true or false.
         """
         return self.client.call('SoftLayer_Network_Subnet', 'clearRoute', id=identifier)
+
+    def search_for_vlan(self, vlan):
+        """Returns a list of matching VLAN objects.
+
+        :param string vlan: Could be either vlan name, number, id, or fully qualified name
+        :return list: List of SoftLayer_Network_Vlan objects
+        """
+
+        query = f"_objectType:SoftLayer_Network_Vlan {vlan}"
+        mask = "mask[resource(SoftLayer_Network_Vlan)[id,name,vlanNumber,fullyQualifiedName,networkSpace]]"
+
+        results = self.client.call('SoftLayer_Search', 'advancedSearch', query, mask=mask)
+        # This returns JUST the Network_Vlan information, none of the search information.
+        return [result.get('resource') for result in results]

docs/cli/hardware.rst

@@ -147,3 +147,11 @@ This function updates the firmware of a server. If already at the latest version
 .. click:: SoftLayer.CLI.hardware.create_credential:cli
    :prog: hardware create-credential
    :show-nested:
+
+.. click:: SoftLayer.CLI.hardware.vlan_add:cli
+   :prog: hardware vlan_add
+   :show-nested:
+
+.. click:: SoftLayer.CLI.hardware.vlan_list:cli
+   :prog: hardware vlan_list
+   :show-nested: