86. Orion SDK 101: Intro to PowerShell and the Orion API

In this 100-level class, Kevin M. Sparenberg, Technical Content Manager for THWACK©, presents a simple introduction to the SolarWinds© Orion© Software Development Kit (SDK). Instructions include how to download the SDK, installing the PowerShell module, and performing basic read operations within the API. No previous PowerShell or Orion API experience is necessary. Kevin discusses when, how, and why to use the API. Be sure to register for the live cast because Kevin will be answering audience questions during the episode.

https://play.vidyard.com/YoiqyC2oKbQhr6g5PJs5fe

Additional Resources

PowerShell Basic Cheat Sheet:
http://ramblingcookiemonster.github.io/images/Cheat-Sheets/powershell-basic-cheat-sheet2.pdf

The Curious Case of the "Dead" Nodes
https://thwack.solarwinds.com/t5/Product-Blog/The-Curious-Case-of-the-quot-Dead-quot-Nodes/ba-p/451211

Find more posts tagged with

SolarWinds Lab

Comments

stuartd

I missed this.

Bookmarking to comeback and listen to when more time allows as I absolutely need to get into this.

KMSigma.SWI

As long as you don't judge my loud typing, we'll call it even.

stuartd

Clacky keyboards are the best.

So, I'm running with the native Powershell ISE as we don't really want to install anything more. But we do have the SDK installed, so it has made the connection to SWIS.

So, in trying to understand better, I have just been trying to replicate your example but everytime I try to run the script (within PS) I get:

At line:18 char:1
+ FROM Orion.Nodes
+ ~~~~
The 'from' keyword is not supported in this version of the language.
+ CategoryInfo : ParserError: (:) [], ParentContainsErrorRecordException
+ FullyQualifiedErrorId : ReservedKeywordNotAllowed

So presumably I'm missing something?

So I next tried (because I don't think you addressed this for Powershell in the vid) Preempting the query with $SwqlQuery = " insert query " and I get yet more errors.

Clearly I'm missing a step and perhaps I'd be better asking thos over in the OrionSDK forum...

KMSigma.SWI

Do me a favor and post your complete script in the Orion SDK area with whatever you have for edits.

ecklerwr1

Nice big Microphone you've got there Kevin!

dc4networks

Great SolarWinds Lab Kevin.

prashantsingh

Thanks @KMSigma.SWI for the much needed tutorial.

I would also like to know how can I use verbs in SWQL for multiple nodes.

Like if I have to add multiple nodes in NCM I can use it for one node at a time from the SWQL studio like below, but how to give multiple nodeid to perform the same operation in one go.

KMSigma.SWI

@prashantsingh , that verb doesn't appear to take an array as a parameter, so that means you need to do some other type of loop and send the coreNodeId for the individual devices one at a time.

prashantsingh

Thanks @KMSigma.SWI

j1mruby

@KMSigma.SWI:

Any advice on getting the SWIS module to work with Powershell 7? Install-Module returns without any errors, but the commands aren't available. I tried an Import-Module SwisPowerShell and it errored on being unable to load the type from the assembly.

Thanks for any advice. Not critical since PS 5 is available everythere, I was just trying to migrate my default environment to PS 7.

KMSigma.SWI

Nothing yet - the PowerShell module currently only supports PowerShell 5.x. There is a current issue on GitHub about the compatibility. It originally stemmed from a missing requirement in .NET Core. I think it would be useful to make a note on this issue or create another issue specifically to PowerShell 7.

The above issue tracker is something that I think should possibly get bumped up so that we can support the SWIS calls on non-Windows PowerShell installations.

The PowerShell Module (not Snap-In) now supports PowerShell 7+.

KMSigma.SWI

Not sure if you saw this @j1mruby:

SolarWinds PowerShell Module 3.0.309 – Now Supporting PowerShell 7 - Newsroom - The Orion Platform - THWACK,

gadbekr

How do i take the below script and make the status have the down.gif on a Custom Widget?

SELECT DisplayName
, IPAddress
, Status
FROM Orion.Wireless.AccessPoints
WHERE Status = '0'

rcbarr

Around 10:00 in Kevin you mention how SWQL handles orphaned interfaces, volumes and assigned applications when you delete a node, and SQL Server Studio (or other query editor, any) does not. Question, does not out-of-the-box Database Maintenance attempt to delete the orphaned records associated with a deleted node?

JBoogie

Is this video still working? I came across it while looking into the API documentation, but I'm getting an error message. I'd love to check it out. Thanks!

JBoogie

I just want to say if anyone else is here experiencing the same problem, the video is also available on YouTube.
https://www.youtube.com/watch?v=8pTQo8Oqk8c

ImNishat

Video is not available and showing video is not found.

donrobert5

Video not found