SolarWinds & Python – Extracting Custom Data from the Orion.Nodes and Orion.NodesCustomProperties tables via the SolarWinds Information Service (SWIS) API

By 22nd May 2019SolarWinds, SWIS, SWQL, Uncategorised

The SolarWinds Information Service (SWIS) is a data access layer for the Orion product family that provides a hybrid of object-oriented and relational features. It has its own SQL-like language called SolarWinds Query Language (SWQL).

The purpose of this post if demonstrate the data that can be extracted using SWIS and SWQL with the orionsdk for Python, as a quick and easy way to obtain granular data on your estate.

Solarwinds Orion SDK Schema – http://solarwinds.github.io/OrionSDK/schema/index.html

Full Code
 
  2. import requests
  3. from orionsdk import SwisClient
  4. from requests.packages.urllib3.exceptions import InsecureRequestWarning
  5. import csv
  7. # Disable Insecure HTTPS Certificate Warnings
  8. requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
  10. server = "solarwindsHost"
  11. user = "apiuser"
  12. pwd = "apipassword"
  14. # Build our SWQl Query
  15. cisco_nodes_query = """
  16. SELECT
  17. n.Vendor,n.MachineType, n.NodeDescription,
  18. n.IPAddress, n.Caption, n.Status,
  19. c.Building, c.City, c.Call_network_support_on_call
  20. FROM Orion.Nodes n
  21. JOIN Orion.NodesCustomProperties c ON n.NodeID = c.NodeID
  22. WHERE n.Vendor = 'Cisco'
  23. ORDER BY n.IPAddress
  24. """
  27. def query_nodes(query, file_name):
  29.     # Create our SwisClient Object
  30.     swis = SwisClient(server, user, pwd)
  32.     # Initiate our Query and store the results
  33.     node_results = swis.query(query)["results"]
  35.     # Create a file object
  36.     file = open(file_name + ".csv", "w", newline='')
  38.     # Create our CSV Fields
  39.     fields = node_results[0].keys()
  41.     # Create our CSV.Dictwriter Object
  42.     writer = csv.DictWriter(file, fieldnames=fields)
  44.     # Write the headers to the csv file
  45.     writer.writeheader()
  47.     # Write the results to the csv file
  48.     writer.writerows(node_results)
  50.     # Optionally Print out the results to the terminal.
  51.     for node in node_results:
  52.         print("*" * 100)
  53.         for k, v in node.items():
  54.             print(k, "==", v)
  57. query_nodes(cisco_nodes_query, "cisco_nodes")
  58.  



Example Output

Output
 
  2. ****************************************************************************************************
  3. Vendor == Cisco
  4. MachineType == Cisco 4431 ISR
  5. NodeDescription == Cisco IOS Software, ISR Software (X86_64_LINUX_IOSD-UNIVERSALK9-M), Version 15.4(3)S4, RELEASE SOFTWARE (fc3)
  6. Technical Support: http://www.cisco.com/techsupport
  7. Copyright (c) 1986-2015 by Cisco Systems, Inc.
  8. Compiled Mon 05-Oct-15 11:24 by mcpre
  9. IPAddress == 10.10.10.1
  10. Caption == dr-ir4431.net
  11. Status == 1
  12. Building == 1201 State Street, Richardson, TX 75082
  13. City == Richardson
  14. Call_network_support_on_call == True
  15.  
Mitch

Author Mitch

I am an independent IT Consultant with specialities in Software Development, Enterprise Unified Communication, Network and Security platforms. In addition to my day to day work, I develop bespoke applications and I hope that through ucdevops.com I can build relationships with clients, business partners and fellow engineers by providing solutions to complex problems through the use of programming.

More posts by Mitch
"