#2104 added vlan trunks on the server detail page, improved performance of 'hw detail'

Author: allmightyspiff

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2023-09-27T14:21:34Z",
+  "generated_at": "2023-10-03T22:08:00Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -238,7 +238,7 @@
         "hashed_secret": "fb5f2f1b65d1f2bc130ce9d5729b38d12f2b444e",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 259,
+        "line_number": 260,
         "type": "Secret Keyword",
         "verified_result": null
       }

SoftLayer/CLI/hardware/detail.py

@@ -29,7 +29,7 @@ def cli(env, identifier, passwords, price, components):
     table.align['value'] = 'l'
 
     hardware_id = helpers.resolve_id(hardware.resolve_ids, identifier, 'hardware')
-    result = hardware.get_hardware(hardware_id)
+    result = hardware.get_hardware_fast(hardware_id)
     result = utils.NestedDict(result)
     hard_drives = hardware.get_hard_drives(hardware_id)
 
@@ -72,11 +72,30 @@ def cli(env, identifier, passwords, price, components):
     table.add_row(['last_transaction', last_transaction])
     table.add_row(['billing', 'Hourly' if result['hourlyBillingFlag'] else 'Monthly'])
 
-    vlan_table = formatting.Table(['type', 'number', 'id', 'name', 'netmask'])
+    vlan_table = formatting.Table(['Network', 'Number', 'Id', 'Name', 'Type'])
     for vlan in result['networkVlans']:
-        vlan_table.add_row([vlan['networkSpace'], vlan['vlanNumber'],
-                            vlan['id'], vlan['fullyQualifiedName'],
-                            vlan['primarySubnets'][0]['netmask']])
+        vlan_table.add_row([
+            vlan.get('networkSpace'),
+            vlan.get('vlanNumber'),
+            vlan['id'],
+            vlan['fullyQualifiedName'],
+            'Primary'
+        ])
+
+    # Shows any VLANS trunked/tagged on this server
+    for component in result.get('networkComponents', []):
+        # These are the Primary network components
+        if component.get('primaryIpAddress', False):
+            uplink = component.get('uplinkComponent')
+            for trunk in uplink.get('networkVlanTrunks'):
+                trunk_vlan = trunk.get('networkVlan')
+                vlan_table.add_row([
+                    trunk_vlan.get('networkSpace'),
+                    trunk_vlan.get('vlanNumber'),
+                    trunk_vlan.get('id'),
+                    trunk_vlan.get('fullyQualifiedName'),
+                    'Trunked'
+                ])
 
     table.add_row(['vlans', vlan_table])
 

SoftLayer/fixtures/SoftLayer_Hardware_Server.py

@@ -161,6 +161,7 @@
         }
     }
 ]
+getNetworkComponents = getFrontendNetworkComponents
 
 getBandwidthAllotmentDetail = {
     'allocationId': 25465663,
@@ -410,4 +411,64 @@
             {
                 "createDate": "2019-10-14T16:51:12-06:00",
                 "version": "5.10"
-            }]}}]
+            }
+        ]
+    }
+}]
+getActiveComponents = getComponents
+getActiveTransaction = getObject['activeTransaction']
+getOperatingSystem = getObject['operatingSystem']
+getSoftwareComponents = [
+    {
+        "hardwareId": 1907356,
+        "id": 59003868,
+        "manufacturerLicenseInstance": "",
+        "softwareLicense": {
+            "id": 20658,
+            "softwareDescriptionId": 2888,
+            "softwareDescription": {
+                "controlPanel": 0,
+                "id": 2888,
+                "licenseTermValue": 0,
+                "longDescription": "Juniper vSRX 1G 19.4R2-S3 Standard 19.4.2.3",
+                "manufacturer": "Juniper",
+                "name": "vSRX 1G 19.4R2-S3 Standard",
+                "operatingSystem": 1,
+                "referenceCode": "UBUNTU_18_64",
+                "upgradeSoftwareDescriptionId": None,
+                "upgradeSwDescId": None,
+                "version": "19.4.2.3",
+                "virtualLicense": 0,
+                "virtualizationPlatform": 0,
+                "requiredUser": "root"
+            }
+        }
+    },
+    {
+        "hardwareId": 1907356,
+        "id": 59003870,
+        "manufacturerLicenseInstance": "",
+        "softwareLicense": {
+            "id": 147,
+            "softwareDescriptionId": 148,
+            "softwareDescription": {
+                "controlPanel": 0,
+                "id": 148,
+                "licenseTermValue": None,
+                "longDescription": "Passmark Suite Latest",
+                "manufacturer": "Passmark",
+                "name": "Passmark Suite",
+                "operatingSystem": 0,
+                "upgradeSoftwareDescriptionId": None,
+                "upgradeSwDescId": None,
+                "version": "Latest",
+                "virtualLicense": 0,
+                "virtualizationPlatform": 0
+            }
+        }
+    }
+]
+getBillingItem = getObject['billingItem']
+getTagReferences = getObject['tagReferences']
+getNetworkVlans = getObject['networkVlans']
+getRemoteManagementAccounts = getObject['remoteManagementAccounts']

SoftLayer/managers/hardware.py

@@ -5,6 +5,7 @@
 
     :license: MIT, see LICENSE for more details.
 """
+import concurrent.futures as cf
 import datetime
 import logging
 import socket
@@ -276,6 +277,97 @@ def get_hardware(self, hardware_id, **kwargs):
 
         return self.hardware.getObject(id=hardware_id, **kwargs)
 
+    @retry(logger=LOGGER)
+    def get_hardware_fast(self, hardware_id):
+        """Get details about a hardware device. Similar to get_hardware() but this uses threads
+
+        :param integer id: the hardware ID
+        :returns: A dictionary containing a large amount of information about the specified server.
+        """
+
+        hw_mask = (
+            'id, globalIdentifier, fullyQualifiedDomainName, hostname, domain,'
+            'provisionDate, hardwareStatus, bareMetalInstanceFlag, processorPhysicalCoreAmount,'
+            'memoryCapacity, notes, privateNetworkOnlyFlag, primaryBackendIpAddress,'
+            'primaryIpAddress, networkManagementIpAddress, userData, datacenter, hourlyBillingFlag,'
+            'lastTransaction[transactionGroup], hardwareChassis[id,name]'
+        )
+        server = self.client.call('SoftLayer_Hardware_Server', 'getObject', id=hardware_id, mask=hw_mask)
+        with cf.ThreadPoolExecutor(max_workers=10) as executor:
+            networkComponentsMask = (
+                "id, status, speed, maxSpeed, name, ipmiMacAddress, ipmiIpAddress, macAddress, primaryIpAddress,"
+                "port, primarySubnet[id, netmask, broadcastAddress, networkIdentifier, gateway],"
+                "uplinkComponent[networkVlanTrunks[networkVlan[networkSpace]]]"
+            )
+            networkComponents = executor.submit(
+                self.client.call, 'SoftLayer_Hardware_Server', 'getNetworkComponents',
+                id=hardware_id, mask=networkComponentsMask
+            )
+            activeComponentsMask = (
+               'id,hardwareComponentModel[hardwareGenericComponentModel[id,hardwareComponentType[keyName]]]'
+            )
+            activeComponents = executor.submit(
+                self.client.call, 'SoftLayer_Hardware_Server', 'getActiveComponents',
+                id=hardware_id, mask=activeComponentsMask
+            )
+
+            activeTransaction = executor.submit(
+                self.client.call, 'SoftLayer_Hardware_Server', 'getActiveTransaction',
+                id=hardware_id, mask="id, transactionStatus[friendlyName,name]"
+            )
+
+            operatingSystemMask = (
+                'softwareLicense[softwareDescription[manufacturer, name, version, referenceCode]],'
+                'passwords[id,username,password]'
+            )
+            operatingSystem = executor.submit(
+                self.client.call, 'SoftLayer_Hardware_Server', 'getOperatingSystem',
+                id=hardware_id, mask=operatingSystemMask
+            )
+
+            # Intentionally reusing the operatingSystemMask here. They are both softwareComponents
+            softwareComponents = executor.submit(
+                self.client.call, 'SoftLayer_Hardware_Server', 'getSoftwareComponents',
+                id=hardware_id, mask=operatingSystemMask
+            )
+
+            billingItemMask = (
+                'id,nextInvoiceTotalRecurringAmount,'
+                'nextInvoiceChildren[nextInvoiceTotalRecurringAmount],'
+                'orderItem.order.userRecord[username]'
+            )
+            billingItem = executor.submit(
+                self.client.call, 'SoftLayer_Hardware_Server', 'getBillingItem',
+                id=hardware_id, mask=billingItemMask
+            )
+
+            tagReferences = executor.submit(
+                self.client.call, 'SoftLayer_Hardware_Server', 'getTagReferences',
+                id=hardware_id, mask="id,tag[name,id]"
+            )
+
+            networkVlans = executor.submit(
+                self.client.call, 'SoftLayer_Hardware_Server', 'getNetworkVlans',
+                id=hardware_id, mask="id,vlanNumber,networkSpace,fullyQualifiedName,primarySubnets[ipAddresses]"
+            )
+
+            remoteManagementAccounts = executor.submit(
+                self.client.call, 'SoftLayer_Hardware_Server', 'getRemoteManagementAccounts',
+                id=hardware_id, mask="username,password"
+            )
+
+            server['networkComponents'] = networkComponents.result()
+            server['activeComponents'] = activeComponents.result()
+            server['activeTransaction'] = activeTransaction.result()
+            server['operatingSystem'] = operatingSystem.result()
+            server['softwareComponents'] = softwareComponents.result()
+            server['billingItem'] = billingItem.result()
+            server['networkVlans'] = networkVlans.result()
+            server['remoteManagementAccounts'] = remoteManagementAccounts.result()
+            server['tagReferences'] = tagReferences.result()
+
+        return server
+
     def reload(self, hardware_id, post_uri=None, ssh_keys=None, lvm=False):
         """Perform an OS reload of a server with its current configuration.