- splunkversioncontrol_utility.py - additional logging for errors

- `splunkversioncontrol_backup.py`
- `splunkversioncontrol_backup_class.py`
- `splunkversioncontrol_restore.py`
- `splunkversioncontrol_rest_restore.py`
- `splunkversioncontrol_restore_class.py`

Modified to use the REST API search/jobs v2 endpoint

Author: gjanders

README.md

@@ -326,6 +326,18 @@ As of October 2022, there are still no signs of version control within the Splun
 - [Search Head Backup](https://splunkbase.splunk.com/app/6438) - backup to an index, works in Splunk Cloud
 
 ## Release Notes
+### 1.2.14
+- `splunkversioncontrol_utility.py` - additional logging for errors
+
+- `splunkversioncontrol_backup.py`
+- `splunkversioncontrol_backup_class.py`
+- `splunkversioncontrol_restore.py`
+- `splunkversioncontrol_rest_restore.py`
+- `splunkversioncontrol_restore_class.py`
+
+Modified to use the REST API search/jobs v2 endpoint
+
+
 ### 1.2.13
 - `splunkversioncontrol_restore_class.py` - updated to show a message if the app in question does not exist
 

bin/splunkversioncontrol_backup.py

@@ -312,7 +312,7 @@ def validate_arguments():
 
     #Run a sanity check and make sure we can connect into the remote Splunk instance
     if not useLocalAuth:
-        url = val_data['srcURL'] + "/servicesNS/nobody/%s/search/jobs/export?search=makeresults" % (appName)
+        url = val_data['srcURL'] + "/servicesNS/nobody/%s/search/v2/jobs/export" % (appName)
         srcUsername = val_data['srcUsername']
         srcPassword = val_data['srcPassword']
         if srcPassword.find("password:") == 0:
@@ -330,7 +330,7 @@ def validate_arguments():
 
         try:
             logger.debug("Running query against URL %s with username %s proxies_length=%s sslVerify=%s" % (url, srcUsername, len(proxies), sslVerify))
-            res = requests.get(url, auth=(srcUsername, srcPassword), verify=sslVerify, proxies=proxies)
+            res = requests.post(url, auth=(srcUsername, srcPassword), verify=sslVerify, proxies=proxies, data={"search": "| makeresults"})
             logger.debug("End query against URL %s with username %s" % (url, srcUsername))
 
             if (res.status_code != requests.codes.ok):

bin/splunkversioncontrol_backup_class.py

@@ -1094,11 +1094,11 @@ def logStats(self, successList, type, app):
     def without_keys(self, d, keys):
         return {x: d[x] for x in d if x not in keys}
 
-    #Run a Splunk query via the search/jobs endpoint
+    #Run a Splunk query via the search/v2/jobs endpoint
     def runSearchJob(self, query, app_context=None, earliest=None, latest=None):
         if not app_context:
             app_context = self.appName
-        url = self.splunk_rest + "/servicesNS/-/%s/search/jobs" % (app_context)
+        url = self.splunk_rest + "/servicesNS/-/%s/search/v2/jobs" % (app_context)
         logger.debug("i=\"%s\" Running requests.post() on url=%s with user=%s query=\"%s\", proxies_length=%s, sslVerify=%s, earliest=%s, latest=%s" % (self.stanzaName, url, self.srcUsername, query, len(self.proxies), self.sslVerify, earliest, latest))
         data = { "search" : query, "output_mode" : "json", "exec_mode" : "oneshot" }
 

bin/splunkversioncontrol_rest_restore.py

@@ -278,9 +278,9 @@ def handle_POST(self):
 
             self.runHttpRequest(url, headers, None, 'delete', 'wiping kvstore splunkversioncontrol_rest_restore_status after completed run', sslVerify=sslVerify)
 
-    #Run a Splunk query via the search/jobs endpoint
+    #Run a Splunk query via the search/v2/jobs endpoint
     def runSearchJob(self, url, appname, headers, auth, username, earliest_time, sslVerify=False):
-        url = url + "/servicesNS/-/%s/search/jobs" % (appname)
+        url = url + "/servicesNS/-/%s/search/v2/jobs" % (appname)
         query = "savedsearch \"Splunk Version Control Audit Query POST\" username=\"%s\" | stats count | where count>0" % (username)
         logger.debug("Running requests.post() on url=%s query=\"%s\"" % (url, query))
         data = { "search" : query, "output_mode" : "json", "exec_mode" : "oneshot", "earliest_time" : earliest_time }

bin/splunkversioncontrol_restore.py

@@ -237,7 +237,7 @@ def validate_arguments():
 
     #Run a sanity check and make sure we can connect into the remote Splunk instance
     if not useLocalAuth:
-        url = val_data['destURL'] + "/servicesNS/nobody/%s/search/jobs/export?search=makeresults" % (appName)
+        url = val_data['destURL'] + "/servicesNS/nobody/%s/search/v2/jobs/export?search=makeresults" % (appName)
         destUsername = val_data['destUsername']
         destPassword = val_data['destPassword']
 

bin/splunkversioncontrol_restore_class.py

@@ -1228,9 +1228,9 @@ def automaticLookups(self, app, name, scope, username, restore_as_user, admin_le
     def without_keys(self, d, keys):
         return {x: d[x] for x in d if x not in keys}
 
-    #Run a Splunk query via the search/jobs endpoint
+    #Run a Splunk query via the search/v2/jobs endpoint
     def runSearchJob(self, query, earliest_time="-1h"):
-        url = self.splunk_rest + "/servicesNS/-/%s/search/jobs" % (self.appName)
+        url = self.splunk_rest + "/servicesNS/-/%s/search/v2/jobs" % (self.appName)
         logger.debug("i=\"%s\" Running requests.post() on url=%s with user=%s query=\"%s\" proxies_length=%s" % (self.stanza_name, url, self.destUsername, query, len(self.proxies)))
         data = { "search" : query, "output_mode" : "json", "exec_mode" : "oneshot", "earliest_time" : earliest_time }
 

bin/splunkversioncontrol_utility.py

@@ -43,7 +43,7 @@ def runOSProcess(command, logger, timeout=60, shell=True):
         return "", "timeout after %s seconds" % (timeout), False
     else:
         if proc.returncode != 0:
-            logger.debug("OS process exited with non-zero code of %s, for command %s" % (proc.returncode, command))
+            logger.debug("OS process exited with non-zero code of %s, for command %s, stdout %s, stderr %s" % (proc.returncode, command, stdout, stderr))
             res = False
         else:
             logger.debug("OS process exited with zero code, for command %s" % (command))

default/app.conf

@@ -12,7 +12,7 @@ label = SplunkVersionControl
 [launcher]
 author = Gareth Anderson
 description = Version Control software for Splunk instances (backup/restore from git)
-version = 1.2.13
+version = 1.2.14
 
 [package]
 id = SplunkVersionControl