Add more documentation and update install for changes in EQM 7.3+ (#4)

fix update #3
pokornyIt · May 17, 2023 · cfab778 · cfab778
1 parent 7d2595b
commit cfab778
Show file tree

Hide file tree

Showing 4 changed files with 239 additions and 116 deletions.
diff --git a/.gitignore b/.gitignore
@@ -60,6 +60,7 @@ atlassian-ide-plugin.xml
 
 # Cursive Clojure plugin
 .idea/replstate.xml
+.idea/
 
 # Crashlytics plugin (for Android Studio and IntelliJ)
 com_crashlytics_export_strings.xml

diff --git a/README.md b/README.md
@@ -60,3 +60,112 @@ System support configuration file in JSON or YAML format. Options are same in bo
 ```
 
 Detailed documentation is in the [PDF](CUCM_User_import_into_QM.pdf) file.
+
+# Troubleshooting AXL DB 
+
+During the run program o some CUCM systems, the program doesn't read the AXL DB version. In this case, we can manually investigate the problem.
+
+First, you must prepare an authentication string. The username replaces your valid CUCM user and the password with the user's valid password.
+```shell
+echo -n "username:password" | base64
+# output is (dXNlcm5hbWU6cGFzc3dvcmQ=)
+```
+
+In the next command, replace this:
+* SERVER your CUCM IP address or server FQDN, 
+* VERSION with CUCM major version (9, 10, 11, 12, 14)
+* PASSWORD with the token collected with the above command.
+Response from the server is stored in file response.xml.
+
+```shell
+curl --location 'https://SERVER:8443/axl/' \
+--insecure \
+--header 'Content-Type: text/plain' \
+--header 'Authorization: Basic PASSWORD' \
+--data '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/VERSION.0">
+   <soapenv:Header/>
+   <soapenv:Body>
+      <ns:getCCMVersion sequence="">
+      </ns:getCCMVersion>
+   </soapenv:Body>
+</soapenv:Envelope>' \
+-o response.xml
+```
+
+Example of valid response.xml file where identification the AXL DB version 11
+```xml
+<?xml version='1.0' encoding='UTF-8'?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
+    <soapenv:Body>
+        <ns:getCCMVersionResponse xmlns:ns="http://www.cisco.com/AXL/API/10.0">
+            <return>
+                <componentVersion>
+                    <version>11.5.1.14900(11)</version>
+                </componentVersion>
+            </return>
+        </ns:getCCMVersionResponse>
+    </soapenv:Body>
+</soapenv:Envelope>
+```
+
+Invalid response.xml file, when testing the AXL DB version newer than the server has
+```html
+<!-- custom Cisco error page -->
+<html>
+    <head>
+        <title>Cisco System - Error report</title>
+        <style type="text/css">a { color: #316984; text-decoration: none; } a:hover { color: #316984; text-decoration: underline; } a:visted { color: #316984; text-decoration: none; } body { background-attachment: fixed; background-color: #ffffff; background-repeat: no-repeat; color: #316984; font-family: arial,helvetica,sans-serif; } #content { border: 1px solid #d6d7d6; font-size: 93.5%; margin: 0px 10% 30px 10%; } #content-header { background-color: #eeeeee; border-bottom: 1px solid #666666; color: #666666; font-size: 124.5%; padding: 5px 15px 5px 15px; } #copyright { font-size: 75%; margin: 0px 10% 0px 10%; padding: 3px 0px 0px 0px; text-align: right; } img { display: block; margin: 0px 0px 20px 0px; } #logo { margin: 30px 10% 0px 10%; } p { padding: 5px 15px 5px 15px; } pre { padding: 5px 15px 5px 30px; }</style>
+    </head>
+    <body>
+        <div id="logo">
+            <img src="/ciscologo.gif" alt="Cisco Systems, Inc."/>
+        </div>
+        <div id="content">
+            <div id="content-header">HTTP Status 599 -</div>
+            <p>
+                <b>type:</b>
+                Status report
+            </p>
+            <p>
+                <b>message:</b>
+            </p>
+            <p>
+                <b>description:</b>
+                http.599
+            </p>
+        </div>
+    </body>
+</html>
+```
+
+Invalid response.xml file, when the tested DB version is too old than the server supports.
+```html
+<!-- custom Cisco error page -->
+<html>
+    <head>
+        <title>Cisco System - Error report</title>
+        <style type="text/css">a { color: #316984; text-decoration: none; } a:hover { color: #316984; text-decoration: underline; } a:visted { color: #316984; text-decoration: none; } body { background-attachment: fixed; background-color: #ffffff; background-repeat: no-repeat; color: #316984; font-family: arial,helvetica,sans-serif; } #content { border: 1px solid #d6d7d6; font-size: 93.5%; margin: 0px 10% 30px 10%; } #content-header { background-color: #eeeeee; border-bottom: 1px solid #666666; color: #666666; font-size: 124.5%; padding: 5px 15px 5px 15px; } #copyright { font-size: 75%; margin: 0px 10% 0px 10%; padding: 3px 0px 0px 0px; text-align: right; } img { display: block; margin: 0px 0px 20px 0px; } #logo { margin: 30px 10% 0px 10%; } p { padding: 5px 15px 5px 15px; } pre { padding: 5px 15px 5px 30px; }</style>
+    </head>
+    <body>
+        <div id="logo">
+            <img src="/ciscologo.gif" alt="Cisco Systems, Inc."/>
+        </div>
+        <div id="content">
+            <div id="content-header">HTTP Status 599 - Wrong axl version, supported versions are 9.x,10.x and 11.0</div>
+            <p>
+                <b>type:</b>
+                Status report
+            </p>
+            <p>
+                <b>message:</b>
+                Wrong axl version, supported versions are 9.x,10.x and 11.0
+            </p>
+            <p>
+                <b>description:</b>
+                http.599
+            </p>
+        </div>
+    </body>
+</html>
+```
+All response examples are formatted for better readability.