This is the second in a series of articles giving extended example of how to use the RestAPI. This article will demonstrate how to generate a report equivalent to the Version 3 "OutputApplications" view using PowerShell. For a shorter example that returns a simpler dataset, you can see the article Use RestAPI and PHP to generate a list of Applications.
You can download the latest version of the file: OutputApplications-v1.ps1, and simply customise the $user, $pass and $sonar values and it should run in your environment
| Table of Contents |
|---|
Fields in the original report
| Field Name | V3 Description | V4 Comment |
|---|---|---|
| Hostname | The hostname of the device the application is running on | Get this from the Applications endpoint. |
| FQDN | Fully Qualified Domain Name of the device | Get this from the Applications endpoint. . Note - without making additional RestAPI calls this is not always available. |
| SoftwareName | SoftwareName Enterprise application name | Get this from the Applications endpoint. |
| SoftwareVersion | Version | Get this from the Applications endpoint. |
| SoftwareVendor | Software vendor name | Get this from the Applications endpoint. |
| SoftwareEdition | Software Edition (Enterprise, Web, etc) | Get this from the Applications endpoint where applicable. |
| InstanceIdentifier | Unique application name | Use the name field in the Applications endpoint. For database applications, this is in the "instance" name. For VMWare clusters it is the node name, etc. |
| ClusterInformation | The cluster that the physical machine is part of. | See clusters and/or parent_cluster in the Applications endpoint. IN V3 this contained the cluster name and list of nodes separated by ";" for some cluster types, but not all |
| UserCount | Number of users (where applicable) | Get this from the Applications/Application_ID endpoint |
| LastScanDate | Timestamp of last scan | Get this from the Applications endpoint. |
| Location | Location of the application (user defined, inherited from the device location) | Get this from the Applications endpoint device section for non-clustered applications. |
| Language | SQL Server instance language (SQL Server only) | Not exposed via V4 RestAPI |
| ApplicationID | Unique Identifier for the application | Get this from the Applications endpoint. |
| DeviceID | Unique Identifier for the device. Can be used to map to OutputDevices | Get this from the Applications endpoint device section for non-clustered applications. Certain cluster applications don't have devices. |
| DNSHostname | The hostname for the device as reported by DNS | Get this from the Applications endpoint device section for non-clustered applications. |
| DNSFQDN | The FQDN for the device as reported from DNS | Get this from the Applications endpoint device section for non-clustered applications.Note - without making additional RestAPI calls this is not always available. |
| Evidence | This column not available in V4 | Not exposed via V4 RestAPI |
...
Build the CSV file header row
PowerShell has a number of built in libraries for handling output to various file formats. For this example we will be saving the results in a CSV file that can be viewed directly in EXCEL or imported into other databases.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
# Build the CSV File header row $csv = @() $row = New-Object System.Object $row | Add-Member -MemberType NoteProperty -Name "Hostname" -Value $null $row | Add-Member -MemberType NoteProperty -Name "FQDN" -Value $null $row | Add-Member -MemberType NoteProperty -Name "SoftwareName" -Value $null $row | Add-Member -MemberType NoteProperty -Name "SoftwareVersion" -Value $null $row | Add-Member -MemberType NoteProperty -Name "SoftwareVendor" -Value $null $row | Add-Member -MemberType NoteProperty -Name "SoftwareEdition" -Value $null $row | Add-Member -MemberType NoteProperty -Name "InstanceIdentifier" -Value $null $row | Add-Member -MemberType NoteProperty -Name "ClusterInformation" -Value $null $row | Add-Member -MemberType NoteProperty -Name "UserCount" -Value $null $row | Add-Member -MemberType NoteProperty -Name "LastScanDate" -Value $null $row | Add-Member -MemberType NoteProperty -Name "Location" -Value $null $row | Add-Member -MemberType NoteProperty -Name "Language" -Value $null $row | Add-Member -MemberType NoteProperty -Name "ApplicationID" -Value $null $row | Add-Member -MemberType NoteProperty -Name "DeviceID" -Value $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 "Evidence" -Value $null |
...
Process each application
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
$thisApplication = $applications[$i]
$currDevice = Invoke-RestMethod $thisApplication.self -Credential $credential
$row = New-Object System.Object
# Hostname, FQDN and DeviceID are defined by the devices subsection if present.
if ( $thisApplication.devices.count -eq 0)
{
# If we have no devices, we do not have this info
$row | Add-Member -MemberType NoteProperty -Name "Hostname" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "FQDN" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "DeviceID" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "DNSHostname" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "DNSFQDN" -Value $null
}
else
{
# one or more devices. So we will list the details for devices[0] - other devices will get listed in the cluster info section
$row | Add-Member -MemberType NoteProperty -Name "Hostname" -Value $thisApplication.devices[0].host_name
$row | Add-Member -MemberType NoteProperty -Name "DeviceID" -Value $thisApplication.devices[0].device_id
$row | Add-Member -MemberType NoteProperty -Name "DNSHostname" -Value $thisApplication.devices[0].host_name
$k=0
while ($k -lt $thisApplication.devices[0].qualified_name.count)
{
if ($thisApplication.devices[0].qualified_name[$k].name_type -eq "DNSFQDN")
{
$row | Add-Member -MemberType NoteProperty -Name "FQDN" -Value $null
$row | Add-Member -MemberType NoteProperty -Name "DNSFQDN" -Value $null
}
$k = $k + 1
}
}
# Device name was complicated. Software details are more simple
$row | Add-Member -MemberType NoteProperty -Name "SoftwareName" -Value $thisApplication.product.name
$row | Add-Member -MemberType NoteProperty -Name "SoftwareVersion" -Value $thisApplication.version
$row | Add-Member -MemberType NoteProperty -Name "SoftwareVendor" -Value $thisApplication.product.vendor
$row | Add-Member -MemberType NoteProperty -Name "SoftwareEdition" -Value $thisApplication.edition
$row | Add-Member -MemberType NoteProperty -Name "InstanceIdentifier" -Value $thisApplication.name
# UserCount is optional
if ( $currDevice.users.count -gt 0 )
{
$row | Add-Member -MemberType NoteProperty -Name "UserCount" -Value $currDevice.users.count
}
$row | Add-Member -MemberType NoteProperty -Name "LastScanDate" -Value $thisApplication.last_scan
$row | Add-Member -MemberType NoteProperty -Name "ApplicationID" -Value $thisApplication.application_id |
...
- A VMWare cluster reports ESX Nodes and ESX Clusters as distinct entries in the Applications output.
- ESX Node has "product.name" set to "VMware VSphere Hypervisor", In this case we don't populate the "clusterinformation" column.
The parent_cluster information (if present) points to the cluster this node is part of. - ESX Cluster entry has "type" set to "VMWare Cluster", no edition, "name" is name of cluster
Links to cluster nodes, link to cluster parent (self), node id given, need to generate and follow link to device ID for node names
- ESX Node has "product.name" set to "VMware VSphere Hypervisor", In this case we don't populate the "clusterinformation" column.
- Veritas Cluster Server,
Links to clusters gives list of nodes, same as in devices. node names in devices. - Windows Server Cluster
Links to two or more devices
No "cluster" or "parent_cluster" entry - Oracle Database Cluster Server
Multiple devices
No "clusters" or "parent_cluster" entry - SQL Server Cluster
No cluster info available - Websphere AS Cluster
Multiple devices
No "clusters" or "parent_cluster" entry
...