SolarWinds SWIS API Cheat Sheet

A Programming › Programming cheat sheet in English by ernest

SolarWinds exposes Information Service (SWIS) to customers. The service is accessible from PowerShell and this cheat sheet aims to simplify using it. Information within this cheat sheet is based on SolarWinds Orion SDK 1.5.

Development Solarwinds Powershell Swql

58,352 views 8,990 downloads 13 Feb 2013 History

PRs

Download

3.7 avg · 0 ratings

Query SWIS with PowerShell

Add-PSSnapin SwisSnapin

Get-Credential

Connect-Swis -Credential $creds -Hostname localhost

Get-SwisData $swis 'SELECT nodeID, Caption FROM Orion.Nodes Where Vendor=@v' @{v='Cisco'}

Invoke-SwisVerb $swis Orion.Nodes Unmanage @("N:1",$now,$later,"false")

The Invoke-SwisVerb cmdlet argument lists support XmlElement objects from Orion SDK 1.5. If your scripts rely on the original behavior, update them to use the InnerText property of the returned element.

Installing SWIS PowerShell

choco install orionsdk -y

C:\Windows\Microsoft.NET\Framework\v4.0.30319\InstallUtil.exe 'C:\Program Files\SolarWinds\Orion SDK\SWQL Studio\SwisPowerShell.dll'

C:\Windows\Microsoft.NET\Framework64\v4.0.30319\InstallUtil.exe 'C:\Program Files (x86)\SolarWinds\Orion SDK\SWQL Studio\SwisPowerShell.dll'

If you installed the Orion SDK to a different folder, adjust the path to SwisPowerShell.dll accordingly.
The same DLL works in both 32- and 64-bit shells, but you have to register it separately for each context.
Don't forget that you need to run the Powershell as Administrator.

SWQL supported constructs

SELECT ... FROM ...

WHERE

GROUP BY ... HAVING ...

ORDER BY

INNER JOIN

LEFT/RIGHT OUTER JOIN

UNION

UNION ALL

SELECT TOP n

SELECT DISTINCT

Subqueries in SELECT

Subqueries in FROM/JOIN

Aggregates SUM, MAX, MIN, AVG, COUNT

Functions ISNULL, ABS

Credit

The cheat sheet was created in conformity with SolarWinds Orion SDK 1.5.

SWQL unique

Navigation Properties

SELECT I.Caption, I.Node.Contact FROM Orion.NPM.Interfaces I WHERE I.TypeName='ieee80211'

Row Windows

SELECT NodeID, Caption, IPAddress, Status FROM Orion.Nodes ORDER BY Caption WITH ROWS 100 TO 199

SWQL - NOT SUPPORTED

SELECT * FROM	You must list the actual properties you want to select.
UPDATE, INSERT, DELETE	You can only use SWQL to read data

You must use CRUD operations to create, read, update, or delete entities.

Badges

Useful Cheat Sheet Nice Cheat Sheet Good Cheat Sheet Downloaded from Unusual Locations × 1

Comments (3)

Mark Roberts 15:35 11 Jan 2016

I would suggest you install the SWQL Studio application, which has just been upgraded to v2. This will allow you to view all of the SWQL column names for all of the supported entities in Orion. SolarWinds have created a GitHub site for the SDK so new versions will be available via that resource - https://github.com/solarwinds/OrionSDK

Brian McMahon 09:53 18 Oct 2015

Yes, a major short coming of the SW PowerShell "integration" is the lack of metadata information for valid properties for a given node. This will give you a full listing of properties, but about half of the returned list are invalid for a Windows node: $allProps = Get-SwisData $swis "SELECT Name FROM Metadata.Property where EntityName = 'Orion.Nodes'" It appears that depending on the node type, certain properties are valid, others aren't. I don't know if there is a way to return only the valid properties for a node type without trial and error. This means you end up with a select statement like this: $nodeInfo = Get-SwisData $swis "SELECT NodeID, ObjectSubType, IPAddress, IPAddressType, DynamicIP, Caption, NodeDescription, Description, DNS, SysName, Vendor, SysObjectID, Location, Contact, VendorIcon, Icon, IOSImage, IOSVersion, GroupStatus, StatusIcon, LastBoot, SystemUpTime, ResponseTime, PercentLoss, AvgResponseTime, MinResponseTime, MaxResponseTime, CPULoad, MemoryUsed, MemoryAvailable, PercentMemoryUsed, PercentMemoryAvailable, LastSync, LastSystemUpTimePollUtc, MachineType, Severity, ChildStatus, Allow64BitCounters, AgentPort, TotalMemory, CMTS, CustomPollerLastStatisticsPoll, CustomPollerLastStatisticsPollSuccess, SNMPVersion, PollInterval, EngineID, RediscoveryInterval, NextPoll, NextRediscovery, StatCollection, External, Community, RWCommunity, IP, IP_Address, IPAddressGUID, NodeName, BlockUntil, BufferNoMemThisHour, BufferNoMemToday, BufferSmMissThisHour, BufferSmMissToday, BufferMdMissThisHour, BufferMdMissToday, BufferBgMissThisHour, BufferBgMissToday, BufferLgMissThisHour, BufferLgMissToday, BufferHgMissThisHour, BufferHgMissToday, OrionIdPrefix, OrionIdColumn, MinutesSinceLastSync, EntityType, DetailsUrl FROM Orion.Nodes order by nodeid" Pretty ridiculous, huh?

AK 13:50 30 Sep 2015

SWQL - NOT SUPPORTED says You must list the actual properties you want to select. How do you get a list of all available properties? Apparently, not all table column names work.