$csv | Select-Object Hostname, FQDN, OS, OS-Install-Date, Location, Serial-Number, PhysicalCPUCount, PhysicalCoreCount, PhysicalCoresPerCPU, `
   PhysicalCPUManufacturer, PhysicalCPUModel, PhysicalCPUSpeed, PhysicalRAM, VirtualCPUCount, VirtualCoreCount, VirtualRAM,  DeviceModel, `
   PhysicalModelSocketCount, PhysicalModelCoreCount, PhysicalDeviceManufacturer, PhysicalHostname, PhysicalFQDN, IP-Address, `
   PhysicalMACAddress, VirtualMACAddress, ClusterInformation, ClusterName, PartitioningMethod, DerivedCPU, DerivedCoresPerCPU, `
   Bios, LastScanDate, DeviceID, PhysicalDeviceID, PhysicalCPUNotes, Notes, ExternalLink, DNSHostname, DNSFQDN, PhysicalDNSHostname, `
   PhysicalDNSFQDN, MeasurementComment  | Export-csv OutputDevices.csv -NoTypeInformation

#
# PowerShell Worked Examples
#
# Generate OutputDevices equivalent report via RestAPI
#

# The RestAPI uses HTTP authentication. Set $user and $pass to the username and password needed for your iQSonar instance
# set the $host to the IPAddress, name or FQDN of the iQSonar server
$user    = "admin"
$pass    = "password"
$sonar	 = "iQSonar Host"

$secpass = ConvertTo-SecureString $pass -AsPlainText -Force
$credential = New-Object System.Management.Automation.PSCredential($user,$secpass)

 
#
# To find out how many devices there are, ask for the first device and look at the header for the device count
# offset=1 means start with first device. fetch_size=1 means only return one record.
$uri     = -join ("http://", $sonar, "/api/v1/devices/?offset=1&fetch_size=1")
$r = Invoke-WebRequest $uri -Credential $credential
 
# $r.headers has HTML headers, $r.content has text content
$deviceCount = $r.headers.'X-fetch-count'

# Let the user know how many devices we can see
$output = -join ( "There are: ", $deviceCount, " devices in total")
write-host $output

# Build the CSV File header row
$csv = @()
$row = New-Object System.Object
$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUCountHostname" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalCoreCountFQDN" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalCoresPerCPUOS" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUManufacturerOS-Install-Date" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUModelLocation" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUSpeedSerial-Number" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalRAMPhysicalCPUCount" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "VirtualCPUCountPhysicalCoreCount" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "VirtualCoreCountPhysicalCoresPerCPU" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "VirtualRAMPhysicalCPUManufacturer" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "DeviceModelPhysicalCPUModel" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalModelSocketCountPhysicalCPUSpeed" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalModelCoreCountPhysicalRAM" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalDeviceManufacturerVirtualCPUCount" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalHostnameVirtualCoreCount" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalFQDNVirtualRAM" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "IP-AddressDeviceModel" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalMACAddressPhysicalModelSocketCount" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "VirtualMACAddressPhysicalModelCoreCount" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "ClusterInformationPhysicalDeviceManufacturer" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "ClusterNamePhysicalHostname" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PartitioningMethodPhysicalFQDN" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "DerivedCPUIP-Address" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "DerivedCoresPerCPUPhysicalMACAddress" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "BiosVirtualMACAddress" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "LastScanDateClusterInformation" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "DeviceIDClusterName" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalDeviceIDPartitioningMethod" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUNotesDerivedCPU" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "NotesDerivedCoresPerCPU" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "ExternalLinkBios" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "DNSHostnameLastScanDate" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "DNSFQDNDeviceID" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalDNSHostnamePhysicalDeviceID" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalDNSFQDNPhysicalCPUNotes" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "MeasurementCommentNotes" -Value $null
$row | $fsAdd-Member -MemberType NoteProperty -Name "ExternalLink" -Value = 100			# fetch_size
$offset = 1				# offset
$seen   = 1;			# first offset is 1, not 0
while ( $seen -lt $devicecount)
{
	# Outer loop, grab a batch (defined by fetch_size) of devices
	$url = -join ("http://", $sonar, "/api/v1/devices/?offset=", $offset,  "&fetch_size=", $fs)
	$devices = Invoke-RestMethod $url -Credential $credential
	$i = 1
	while ($i -lt $devices.count)
	{
		# inner loop - process individual devices $null
$row | Add-Member -MemberType NoteProperty -Name "DNSHostname" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "DNSFQDN" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalDNSHostname" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "PhysicalDNSFQDN" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "MeasurementComment" -Value $null


$fs     = 100			# fetch_size
$offset = 1				# offset
$seen   = 1;			# first offset is 1, not 0
while ( $seen -lt $devicecount)
{
	# Outer loop, grab a batch (defined by fetch_size) of devices
	$url = -join ("http://", $sonar, "/api/v1/devices/?offset=", $offset,  "&fetch_size=", $fs)
	$devices = Invoke-RestMethod $url -Credential $credential
	$i = 1
	while ($i -lt $devices.count)
	{
		# inner loop - process individual devices in this batch
		# We want to populate some of the data fields in the CSV file - what can we fill in just from the DEVICES end point
		$row = New-Object System.Object		
		$row | Add-Member -MemberType NoteProperty -Name "DeviceID" -Value $devices[$i].device_id
		
		# If the path was only partly successful we might not have a serial number. However we can safely store the empty string.
		# if you are processing RestAPI using PHP or a different scripting language that is stricter about handling undefined variables,
		# you need error handling code around here too.
		$row | Add-Member -MemberType NoteProperty -Name "Serial-Number" -Value $devices[$i].serial_number
		
		# For certain devices, for example some SNMP devices, or for storage devices we might not get a hostname! Explicitly call out a device with no hostname. 
		# Also if hostname is not defined, there will be no qualified name(s)
		if (!$devices[$i].host_name)
		{
			# Hostname is not defined
			$row | Add-Member -MemberType NoteProperty -Name "Hostname" -Value "(undefined)"
			$row | Add-Member -MemberType NoteProperty -Name "FQDN" -Value "(undefined)"
			$row | Add-Member -MemberType NoteProperty -Name "DNSFQDN" -Value "(undefined)"
		}
		else {
			# Hostname is defined
			$row | Add-Member -MemberType NoteProperty -Name "Hostname" -Value $devices[$i].host_name
			# If the array is not present, $num gets value 0, and so the inner loop will not fire
			# we have already set FQDN and DNSFQDN to "(undefined)" where there is no hostname, but we can sometimes have a hostname but no FQDN
			$num = $devices[$i].qualified_name.count
			if ($num -eq 0)
			{
				$row | Add-Member -MemberType NoteProperty -Name "FQDN" -Value "(undefined)"
				$row | Add-Member -MemberType NoteProperty -Name "DNSFQDN" -Value "(undefined)"
			}
			else
			{
				$j   = 0
				$fqdn = "(No FQDN)"
				while ($j -lt $num)
				{
					if ($devices[$i].qualified_name[$j].name_type -eq "DNSFQDN")
					{
						# DNSFQDN can also be used for FQDN.
						$fqdn = $devices[$i].qualified_name[$j].name
						$row | Add-Member -MemberType NoteProperty -Name "DNSFQDN" -Value $devices[$i].qualified_name[$j].name
						$row | Add-Member -MemberType NoteProperty -Name "FQDN" -Value $devices[$i].qualified_name[$j].name
						if ($currDevice.is_virtual -eq "false")
						{
							$row | Add-Member -MemberType NoteProperty -Name "PhysicalDNSHostname" -Value $null
							$row | Add-Member -MemberType NoteProperty -Name "PhysicalDNSFQDN" -Value $devices[$i].qualified_name[$j].name
						}
					}
					elseif ($devices[$i].qualified_name[$j].name_type -eq "FQDN")
					{
						$row | Add-Member -MemberType NoteProperty -Name "PhysicalDNSHostname" -Value $null
						$row | Add-Member -MemberType NoteProperty -Name "FQDN" -Value $devices[$i].qualified_name[$j].name
					}
					$j = $j + 1
				}
			}		
		}
		# Locations is an array containing one or more locations. We can store locations[0].name as the location
		$row | Add-Member -MemberType NoteProperty -Name "Location" -Value $devices[$i].locations[0].name
		
		# The Last Scan Date should always be there, but if absent PowerShell will happily record a NULL value for us.
		$row | Add-Member -MemberType NoteProperty -Name "LastScanDate" -Value $devices[$i].last_scan
		
		# Get extra data about the host
		$currDevice = Invoke-RestMethod $devices[$i].self -Credential $credential
		$row | Add-Member -MemberType NoteProperty -Name "OS" -Value $currDevice.operating_system.name
		if (!$currDevice.os_install_date)
		{
			$row | Add-Member -MemberType NoteProperty -Name "OS-Install-Date" -Value "(not available)"
		}
		else
		{
			$row | Add-Member -MemberType NoteProperty -Name "OS-Install-Date" -Value $currDevice.os_install_date
		}
		if (!$currDevice.bios.name)
		{
			$row | Add-Member -MemberType NoteProperty -Name "Bios" -Value $null
		}
		else 
		{
			$row | Add-Member -MemberType NoteProperty -Name "Bios" -Value $currDevice.bios.name
		}		
		# IP Address is an array of 0 or more IP Addresses. We might not have any, or we might have LOTS.
		$num = $currDevice.ip_address.count
		if ($num -eq 0)
		{
			$row | Add-Member -MemberType NoteProperty -Name "IP-Address" -Value "(no IP address)"
		}
		else 
		{
			if ($num -eq 1)
			{
				$row | Add-Member -MemberType NoteProperty -Name "IP-Address" -Value $currDevice.ip_address[0].ip_address
			}
			else {
				# list of addresses, needs to be separated by semi-colons
				$addresslist = ""
				$j = 0
				while ($j -lt $num)
				{
					$addresslist = -join($addresslist, $currDevice.ip_address[$j].ip_address)
					if ($j -lt $num)
					{
						$addresslist = -join($addresslist, ";")
					}
					$j = $j + 1
				}
				$row | Add-Member -MemberType NoteProperty -Name "IP-Address" -Value $addresslist
			}
		}
		
		# Is this device physical or virtual
		if ($currDevice.is_virtual -eq "false")
		{
			# This is a physical target
			# We can fill in physical hardware details directly, and leave the entries for virtual hardware blank
			
			# Physical device RAM
			$row | Add-Member -MemberType NoteProperty -Name "PhysicalRAM" -Value $currDevice.total_memory_mb
			
			# Physical Device CPU Info
			# Sometimes we don't get CPU Information
			if ( (!$currDevice.cpu_count) -or ($currDevice.cpu_count -eq 0) )
			{
				# Physical CPU info not avialble
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUCount" -Value "n/a"
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCoreCount" -Value "n/a"
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCoresPerCPU" -Value "n/a"
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUManufacturer" -Value "n/a"
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUModel" -Value "n/a"
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUSpeed" -Value "n/a"
			}
			else
			{
				# we have at least some CPU info
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUCount" -Value $currDevice.cpu_count
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCoreCount" -Value $currDevice.core_count
				# Further details will be derived from cpu[0] if present
				if (!$currDevice.cpu[0].manufacturer)
				{
					# additional info missing
					$row | Add-Member -MemberType NoteProperty -Name "PhysicalCoresPerCPU" -Value "n/a"
					$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUManufacturer" -Value "n/a"
					$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUModel" -Value "n/a"
					$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUSpeed" -Value "n/a"
				}
				else
				{
					$row | Add-Member -MemberType NoteProperty -Name "PhysicalCoresPerCPU" -Value $currDevice.cpu[0].core_count
					$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUManufacturer" -Value $currDevice.cpu[0].manufacturer
					$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUModel" -Value $currDevice.cpu[0].cpu_model
					$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUSpeed" -Value $currDevice.cpu[0].cpu_speed
				}
			}
			$row | Add-Member -MemberType NoteProperty -Name "PhysicalModelSocketCount" -Value "n/a" # not exposed in V4 RestAPI
			$row | Add-Member -MemberType NoteProperty -Name "PhysicalModelCoreCount" -Value "n/a" # not exposed in V4 RestAPI
			$row | Add-Member -MemberType NoteProperty -Name "PhysicalDeviceManufacturer" -Value $currDevice.manufacturer

			$row | Add-Member -MemberType NoteProperty -Name "PhysicalHostname" -Value $devices[$i].host_name			
			# 
			# Add this later
			# $row | Add-Member -MemberType NoteProperty -Name "PhysicalMACAddress" -Value $null
			
		}
		else 
		{
			# This is a virtual target
			if (($currDevice.cpu_count -eq 0) -or (!$currDevice.cpu_count))
			{
				# Physical CPU info not avialble
				$row | Add-Member -MemberType NoteProperty -Name "VirtualCPUCount" -Value "n/a"
				$row | Add-Member -MemberType NoteProperty -Name "VirtualCoreCount" -Value "n/a"
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCoresPerCPU" -Value "n/a"
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUManufacturer" -Value "n/a"
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUModel" -Value "n/a"
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUSpeed" -Value "n/a"
			}
			else {			
				$row | Add-Member -MemberType NoteProperty -Name "VirtualCPUCount" -Value $currDevice.cpu_count
				$row | Add-Member -MemberType NoteProperty -Name "VirtualCoreCount" -Value $currDevice.core_count
			}
			$row | Add-Member -MemberType NoteProperty -Name "VirtualRAM" -Value $currDevice.total_memory_mb
			$row | Add-Member -MemberType NoteProperty -Name "DeviceModel" -Value $currDevice.model
			
			# Do something with MAC addresses for VMs
			
			# Now, if the VM host we're running on was scanned, we can do something with the following:
			if (!$currDevice.virtual_host.device_id)
			{
				# host not scanned, record an error by putting "n/a" in physical hostname, leave everything else blank
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalHostname" -Value "n/a"
			}
			else 
			{
				# host was scanned, so let's populate as many details as possible about the physical host
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUCount" -Value $currDevice.virtual_host.cpu_count
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCoreCount" -Value $currDevice.virtual_host.core_count
				if ( ($currDevice.virtual_host.cpu_count -ne 0) -and ($currDevice.virtual_host.core_count -ne 0) )
				{
					$cpcpu = $currDevice.virtual_host.core_count / $currDevice.virtual_host.cpu_count
					$row | Add-Member -MemberType NoteProperty -Name "PhysicalCoresPerCPU" -Value $cpcpu
				}
				# In order to get the CPU Manufacturer information, you need to follow the link to 
				# $currDevice.virtual_host.self and parse the CPU info there. This is left as an exercise to the user
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUModel" -Value "n/a"
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalCPUSpeed" -Value "n/a"
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalRAM" -Value $currDevice.virtual_host.total_memory_mb
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalDeviceManufacturer" -Value $currDevice.virtual_host.manufacturer
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalHostname" -Value $currDevice.virtual_host.host_name
				
				# In order to get the MAC Address for the physical host, you need to follow the link to 
				# $currDevice.virtual_host.self and parse the MAC info there. This is left as an exercise to the user
				$row | Add-Member -MemberType NoteProperty -Name "PhysicalMACAddress" -Value "n/a"
			}
		}
		$csv += $row
		$i = $i + 1;		# keep track for inner loop
		$seen = $seen + 1;  # keep track for outer loop
		if ( $seen % 10 -eq 0) {
			# progress indicator - display a "." every 10 devices
			write-host "." -nonewline
		}
	}
	# Finished this batch
	$offset = $seen
}
# Save the output to a file
write-host " Done. Saving output to OutputDevices.csv now."
$csv | ExportSelect-csv OutputDevices.csv -NoTypeInformation