The REST API allows users to query the iQSonar results directly using the web client protocol. The results are returned in JSON format.
This worked example uses Python to produce a CSV file containing details of devices directly from the scan results. We look for the host name, the total installed RAM and the CPU type. The device name will be listed in the "device" results. For the CPU Type and the installed RAM we need to then go to the details page for the device.
Other documents in the Knowlede Base showing how to produce equivalent results have been written for PHP 7 (which produces HTML output), PERL and for PowerShell
Pre-requsites
The "requests" module in Python handles web requests very nicely. If this is not installed on your system you can install it as follows:
On Linux or macOS:
pip install -U pip requests
On Windows:
python -m pip install -U pip requests
Step One - Connect to the host
The RestAPI uses HTML basic authentication - for this example we will use the default user name of admin and a password of password. In a production environment you should always change the default credentials.
The requests module handles the HTTP details for us.
import requests
r = requests.get('http://vm-mike-2012b/api/v1/devices',auth=('admin','password'))
max = r.headers['X-fetch-count']
data = r.json()
count = len(data)
By default the REST API "/api/v1/devices" page will return 200 devices at a time. We can increase or decrease this using the "fetch_size" parameter. The variable max contains the total number of devices. If this is more than 200 we would need to fetch a second batch - see other worked examples in this series for more details on that. In this example we will print at most 200. data holds the RestAPI data converted into a Python data structure, count is the number of devices returned.
Step Two - print out Hostname, RAM and CPU details for each device
i = 0
print ('Host,RAM,CPU Type')
while (i < count):
row = data[i]
if ( 'host_name' in row ):
hostname = row['host_name']
else:
hostname = '(no hostname)'
The JSON to Python converter does not create empty key-value pairs for missing data, so we need to test for the key's existence each time when we're using it in a script (hence all the if..else statements)
For each device, we get the host_name (which can be empty) and the self (which is always set) values. 'self' contains a URL pointing to detailed information on the device which we then fetch to get the RAM and CPU information.
url2 = row['self']
r2 = requests.get(url2,auth=('admin','password'))
device = r2.json()
if ('total_memory_mb' in device):
ram = device['total_memory_mb']
else:
ram = '(unknown ram)'
if ('cpu' in device):
cpu = device['cpu'][0]['cpu_model']
cpu = cpu.replace(',','')
else:
cpu = '(unknown cpu)'
print (hostname,',',ram,',',cpu,sep='')
i+=1
The CPU information if present is an array. In almost all architectures CPUs in a multi-cpu motherboard are identical, so for the putposes of this example, we just save the results for the first CPU.
We then print off the hostname, ram and cpu info seperated by commas. Unlike in the PowerShell example linked above - we simply send the output to the screen/standard output rather than to a file
Completed Code
Related articles