#1862 added some basic search functionality for vs list

Author: allmightyspiff

SoftLayer/CLI/virt/list.py

@@ -45,6 +45,12 @@
     'action',
 ]
 
+def search_callback(ctx, param, value):
+    print(f"SEARCH_CALLBACK: value: {value}")
+    if not value:
+        print("Value is true now")
+        value = True
+    return value
 
 @click.command(cls=SLCommand, short_help="List virtual servers.")
 @click.option('--cpu', '-c', help='Number of CPU cores', type=click.INT)
@@ -56,67 +62,41 @@
 @click.option('--hourly', is_flag=True, help='Show only hourly instances')
 @click.option('--monthly', is_flag=True, help='Show only monthly instances')
 @click.option('--transient', help='Filter by transient instances', type=click.BOOL)
-@click.option('--hardware', is_flag=True, default=False, help='Show the all VSI related to hardware')
-@click.option('--all-guests', is_flag=True, default=False, help='Show the all VSI and hardware VSIs')
+@click.option('--search', is_flag=False, flag_value="", default=None, 
+              help="Use the more flexible Search API to list instances. See `slcli search --types` for list " +
+              "of searchable fields.")
 @helpers.multi_option('--tag', help='Filter by tags')
-@click.option('--sortby',
-              help='Column to sort by',
-              default='hostname',
-              show_default=True)
+@click.option('--sortby', default='hostname', show_default=True, help='Column to sort by')
 @click.option('--columns',
               callback=column_helper.get_formatter(COLUMNS),
               help='Columns to display. [options: %s]'
               % ', '.join(column.name for column in COLUMNS),
               default=','.join(DEFAULT_COLUMNS),
               show_default=True)
-@click.option('--limit', '-l',
-              help='How many results to get in one api call, default is 100',
-              default=100,
-              show_default=True)
+@click.option('--limit', '-l', default=100, show_default=True,
+              help='How many results to get in one api call, default is 100')
 @environment.pass_env
 def cli(env, sortby, cpu, domain, datacenter, hostname, memory, network,
-        hourly, monthly, tag, columns, limit, transient, hardware, all_guests):
+        hourly, monthly, tag, columns, limit, transient, search):
     """List virtual servers."""
 
-    vsi = SoftLayer.VSManager(env.client)
-    guests = vsi.list_instances(hourly=hourly,
-                                monthly=monthly,
-                                hostname=hostname,
-                                domain=domain,
-                                cpus=cpu,
-                                memory=memory,
-                                datacenter=datacenter,
-                                nic_speed=network,
-                                transient=transient,
-                                tags=tag,
-                                mask=columns.mask(),
-                                limit=limit)
+    guests = []
+    if search is not None:
+        sm = SoftLayer.SearchManager(env.client)
+        guests = sm.search_instances(hostname=hostname, domain=domain, datacenter=datacenter,
+                                     tags=tag, search_string=search, mask=columns.mask())
+    else:
+        vsi = SoftLayer.VSManager(env.client)
+        guests = vsi.list_instances(hourly=hourly, monthly=monthly, hostname=hostname, domain=domain,
+                                    cpus=cpu, memory=memory, datacenter=datacenter, nic_speed=network,
+                                    transient=transient, tags=tag, mask=columns.mask(), limit=limit)
 
     table = formatting.Table(columns.columns)
     table.sortby = sortby
-    if not hardware or all_guests:
-        for guest in guests:
-            table.add_row([value or formatting.blank()
-                           for value in columns.row(guest)])
 
-        env.fout(table)
+    for guest in guests:
+        table.add_row([value or formatting.blank()
+                       for value in columns.row(guest)])
+
+    env.fout(table)
 
-    if hardware or all_guests:
-        hardware_guests = vsi.get_hardware_guests()
-        for hd_guest in hardware_guests:
-            if hd_guest['virtualHost']['guests']:
-                title = "Hardware(id = {hardwareId}) guests associated".format(hardwareId=hd_guest['id'])
-                table_hardware_guest = formatting.Table(['id', 'hostname', 'CPU', 'Memory', 'Start Date', 'Status',
-                                                         'powerState'], title=title)
-                table_hardware_guest.sortby = 'hostname'
-                for guest in hd_guest['virtualHost']['guests']:
-                    table_hardware_guest.add_row([
-                        guest['id'],
-                        guest['hostname'],
-                        '%i %s' % (guest['maxCpu'], guest['maxCpuUnits']),
-                        guest['maxMemory'],
-                        utils.clean_time(guest['createDate']),
-                        guest['status']['keyName'],
-                        guest['powerState']['keyName']
-                    ])
-                env.fout(table_hardware_guest)

SoftLayer/managers/__init__.py

@@ -24,6 +24,7 @@
 from SoftLayer.managers.network import NetworkManager
 from SoftLayer.managers.object_storage import ObjectStorageManager
 from SoftLayer.managers.ordering import OrderingManager
+from SoftLayer.managers.search import SearchManager
 from SoftLayer.managers.sshkey import SshKeyManager
 from SoftLayer.managers.ssl import SSLManager
 from SoftLayer.managers.tags import TagManager
@@ -53,6 +54,7 @@
     'ObjectStorageManager',
     'OrderingManager',
     'PlacementManager',
+    'SearchManager',
     'SshKeyManager',
     'SSLManager',
     'TagManager',

SoftLayer/managers/search.py

@@ -34,3 +34,31 @@ def advanced(self, search_string):
 
         """
         return self.search_manager.advancedSearch(search_string)
+
+    def search_instances(self, search_string, mask=None, **kwargs):
+        """Lists VSIs based in the search_string.
+
+        Also takes in a few search terms as **kwargs. such as hostname, datacenter, domain and tags
+        """
+
+        # This forces the Search API to do a fuzzy search on our term, kinda. Not sure why the ** are 
+        # Required but it will do an exact search without them.
+        if search_string:
+            search_string = f"*{search_string}*"
+        search_string = f"_objectType:SoftLayer_Virtual_Guest {search_string}"
+        if kwargs.get('hostname'):
+            search_string = f"{search_string} hostname: *{kwargs.get('hostname')}*"
+        if kwargs.get('domain'):
+            search_string = f"{search_string} domain: *{kwargs.get('domain')}*"
+        if kwargs.get('datacenter'):
+            search_string = f"{search_string} datacenter.longName: *{kwargs.get('datacenter')}*"
+        if kwargs.get('tags'):
+            tags = " ".join(kwargs.get("tags", []))
+            search_string = f"{search_string} internalTagReferences.tag.name: {kwargs.get('tags')}"
+        result = self.search_manager.advancedSearch(search_string)
+        guests = []
+        for x in result:
+            guests.append(x.get('resource'))
+
+        return guests
+

SoftLayer/managers/vs.py

@@ -1441,15 +1441,6 @@ def migrate_dedicated(self, instance_id, host_id):
         """
         return self.guest.migrateDedicatedHost(host_id, id=instance_id)
 
-    def get_hardware_guests(self):
-        """Returns all virtualHost capable hardware objects and their guests.
-
-        :return SoftLayer_Hardware[].
-        """
-        object_filter = {"hardware": {"virtualHost": {"id": {"operation": "not null"}}}}
-        mask = "mask[virtualHost[guests[powerState]]]"
-        return self.client.call('SoftLayer_Account', 'getHardware', mask=mask, filter=object_filter)
-
     def authorize_storage(self, vs_id, username_storage):
         """Authorize File or Block Storage to a Virtual Server.