Added support for logging SM clients

Author: mpapazog

offline_logging/config.yaml

@@ -50,7 +50,7 @@ endpoints:
         # requires getNetworkClients
         # This can be very slow in large environments, since every client needs to be fetched individually
         # and log entries on long-running networks can be huge, even hitting the MongoDB 16MB/document limit
-        enabled: true
+        enabled: false
         # Splits large traffic history arrays to multiple pages to be able to write them into the database. 
         # Lower this value if you are getting "document too large" errors, or increase to have fewer documents
         # per client
@@ -66,4 +66,12 @@ endpoints:
     getOrganizationAdmins:
         enabled: true
         collection: organizationAdmins
-        mode: update
+        mode: update
+    getNetworkSmDevices:
+        enabled: true
+        collection: networkSmDevices
+        mode: update
+        # Set "filter_by_device_tag_enabled" to true to only log devices with a specific device tag
+        # Set the device tag to be matched in "target_device_tag"
+        filter_by_device_tag_enabled: false
+        target_device_tag: logging

offline_logging/offline_logging.py

@@ -65,7 +65,7 @@ def merakiRequest(p_apiKey, p_httpVerb, p_endpoint, p_additionalHeaders=None, p_
 
     query = ""
     if not p_queryItems is None:
-        query = "?" + urlencode(p_queryItems)
+        query = "?" + urlencode(p_queryItems, True)
     url = API_BASE_URL + p_endpoint + query
 
     verb = p_httpVerb.upper()
@@ -192,6 +192,17 @@ def getNetworkMerakiAuthUsers(p_apiKey, p_networkId):
     success, errors, headers, response = merakiRequest(p_apiKey, "GET", endpoint, p_verbose=FLAG_REQUEST_VERBOSE)    
     return success, errors, headers, response
 
+
+def getNetworkSmDevices(p_apiKey, p_networkId):
+    endpoint = "/networks/%s/sm/devices" % p_networkId
+    query = {"fields[]": ['ip', 'systemType', 'lastConnected', 'location', 'lastUser', 
+        'ownerEmail', 'ownerUsername', 'imei', 'simCarrierNetwork']}
+    
+    success, errors, headers, response = merakiRequest(p_apiKey, "GET", endpoint, p_queryItems=query,
+        p_verbose=FLAG_REQUEST_VERBOSE)    
+        
+    return success, errors, headers, response
+    
 
 def getOrganizationAdmins(p_apiKey, p_organizationId):
     endpoint = "/organizations/%s/admins" % p_organizationId
@@ -462,8 +473,29 @@ def perform_scan(config):
                         log_to_database(db, document, config['endpoints']['getNetworkMerakiAuthUsers']['collection'],
                             config['endpoints']['getNetworkMerakiAuthUsers']['mode'], 
                             keyValuePair={'id': user['id'], 'networkId': network['id']})
+            if 'getNetworkSmDevices' in config['endpoints'] and config['endpoints']['getNetworkSmDevices']['enabled']:
+                if 'systemsManager' in network['productTypes']:
+                    success, errors, headers, sm_devices = getNetworkSmDevices(api_key, network['id'])
+                    if not sm_devices is None:
+                        tag_disabled = not config['endpoints']['getNetworkSmDevices']['filter_by_device_tag_enabled']
+                        tag_filter = config['endpoints']['getNetworkSmDevices']['target_device_tag']
+                        scan_time = datetime.datetime.now()  
+                        for device in sm_devices:
+                            if tag_disabled or tag_filter in device['tags']:
+                                document = {
+                                    'scanTime': scan_time,
+                                    'scanIntervalMinutes': config['scan_interval_minutes'],
+                                    'networkId': network['id'],
+                                    'networkName': network['name']
+                                }
+                                for key in device:
+                                    document[key] = device[key]
+                                
+                                log_to_database(db, document, 
+                                    config['endpoints']['getNetworkSmDevices']['collection'],
+                                    config['endpoints']['getNetworkSmDevices']['mode'], 
+                                    keyValuePair={'id': device['id']})                              
 
-                    
     print(str(datetime.datetime.now()) + " -- Scan complete")