cancel
Showing results for 
Search instead for 
Did you mean: 
Create Post
Product Manager
Product Manager

Orion SDK Information

Please go here for the most updated Orion SDK information.

Thank you for your interest in the SDK.

You can download the SDK 1.10 here (SDK 1.9 here / SDK 1.8 here / SDK 1.7 here / SDK 1.6 here / v1.5 here / SDK v1.4 here)

What's new in SDK v1.9?

  • New chapter added documenting the new NTA 4.0 Entity Model with typical query examples.
  • New sample script for adding a Windows node for monitoring using WMI.
  • Bugfixes to SWQL Studio and the PowerShell cmdlets.

What’s new in SDK v1.8?

  • New sample PowerShell script:
    • CopyNodes
  • Additional documentation:
    • list of functions supported by SWQL
    • the RETURN XML RAW/AUTO clause
  • Schema reference docs for updated for product releases

What’s new in SDK v1.7?

  • Update documentation reflecting technical changes made in Orion Platform 2013.1, NPM 10.5, SAM 5.5, and IPAM 4.0 (summarized in a new "What is new" chapter in Technical Reference document instal
  • Documentation for the REST/JSON endpoint for the Information Service
  • Improvements and bug fixes in SDK tools
  • New sample scripts demonstrating:
    • Using UDT to shut down a switch port
    • Connecting to the Information Service from Python

What’s new in SDK v1.6?

  • Updated documentation reflecting technical changes made in Orion Platform 2012.2, NPM 10.4, and SAM 5.0 (summarized in a new "What is new" chapter in Technical Reference document installed)
  • Improvements in SDK tools, including bulk update and bulk delete capability for SwisPowerShell.
  • New sample scripts demonstrating:
    • Downloading a network device configuration file using NCM
    • Management of SAM application monitoring

What's new in SDK v1.5?

  • Updated documentation reflecting technical changes made in Orion Platform 2012.1, NPM 10.3 (summarized in a new "What is new" chapter in Technical Reference document installed)
  • Improvements in SDK tools
  • New samples demonstrating the other SWIS API use. in particular, PowerShell samples demonstrating:

Adding a node

Adding an interface

Discovering interfaces

Setting a custom property

Configuring Orion Groups

This package contains:

  • SWQL Studio: An application for browsing the Information Service schema and running queries.             
  • Orion SDK.pdf: The documentation for the SDK. Includes an explanation of the purpose of the SolarWinds Information Service, a description of its query language, SWQL, and walkthroughs of the VBClient and JavaClient sample applications.             
  • VBClient:A sample application written in Visual Basic.NET that connects to SWIS over HTTPS, finds the most-recently-triggered unacknowledged alert, and acknowledges it. A project file is provided for building this sample in Visual Studio 2008.
  • JavaClient: A sample application written in Java that connects to SWIS over HTTPS, finds the most-recently-triggered unacknowledged alert, and acknowledges it. A project file is provided for loading this sample in Eclipse. There is also a build.xml file for building the sample with Ant.
  • PerlClient: A sample application written in Perl that connects to SWIS over HTTPS, and contains example calls of SWIS API.
  • PowerShell samples: A set of PowerShell sample scripts containing example calls of SWIS API.
  • SwisInvoke.exe: A tool for invoking SWIS verbs (commands) from the Windows command line.
  • Reference documentation for the SWIS schema: In HTML format.         
  • SWIS Snapin for Windows PowerShell:A component that provides cmdlets you can use to access SWIS from Windows PowerShell, including querying data and invoking verbs. This requires a manual installation step to use. See the Orion SDK.pdf document for details on this

A couple of notes regarding the SDK.

  1. All support will be handled via the thwack SDK forum, which can be found here.
  2. If you call customer service regarding an SDK issue or question you will be directed to thwack, so please do not call customer support.

SolarWinds Orion SDK Team

137 Replies
Level 8

Hi,

I will like to send Status Group Nodes to a external website with icons status. I read Oiron SDK informations but i'm loose

Example i would send that :

Capture.JPG

0 Kudos
Level 8

SolarWinds to Service-Now we’re trying to do the following (option 1 is our preferred while option 2 is a fallback): 1) A) SolarWinds generates alert B) SolarWinds uses a “webservice/api/sdk/other tool” to “communicate with/connect to” with the appropriate information so ServiceNow can open a ticket with the appropriate categorization, priority, whether it is internally or externally managed (ticket assignment changes depending), etc. C) ServiceNow will communicate to the “response team” that there is a new ticket that must be addressed D) ServiceNow will “communicate with/connect to” SolarWinds to acknowledge the alert and to record the ServiceNow ticket in to the acknowledgement notes E) SolarWinds will register alert and set alert to acknowledged status and will include the ServiceNow ticket number *END* 2) A) SolarWinds generates alert B) SolarWinds sends email notification to ServiceNow – email will need to be in appropriate form to be “absorbed” C) ServiceNow “absorbs” email and generates a ticket with the appropriate categorization, priority, whether it is internally or externally managed (ticket assignment changes depending), etc. D) ServiceNow “responds” to email with acknowledgement and ticket number E) SolarWinds registers the response and sets the alert to acknowledged status and will include the ServiceNow ticket number *END* At this time, we’re looking for foundational materials to help us get started and determine the easiest/best way to perform one of these options and we’re hoping SolarWinds support can give us some pointers on where to researching documentation and what documentation may exist. Our hope is this is a relatively straight forward activity since it seems like it would be fairly standard that companies would want their monitoring and ticketing systems to interact. We have been rather ineffectually researching SolarWinds documentation and Thwack for roughly a week and have been unable to find the “start here” materials. We understand that the referenced SDK is not supported and we will have to use Thwack as support, however, at this point, we don’t have enough information to understand whether the SDK is our best/only option. We see in the release notes that there is the VBClient, etc. however it is unclear if this is the proscribed technique or just *A* technique.

Level 8

Duplicating the post.

Looking for some help with the powershell add, as the CRUD.addnode samples for SDK v1.7 fail with NPM 10.6.3

SolarWinds Support recommended posting in this SDK as the blog has not gotten a response in 8 days.

Using Powershell to add nodes with Custom Properties for Device Type

The goal is to automate the add/removes without any user intervention ruling out discovery.

This worked with with SDK v1.6 and NPM 10.5.4

Unfortunately this is an urgent matter for us to use the product.

Please have someone from the Development team or Product Manager to give me a call

Thanks,

Kevin

0 Kudos
Level 11

I have an idea about supporting custompollerassignment, maybe it is available for the next version.

http://thwack.solarwinds.com/ideas/2929

0 Kudos
Level 7

Hi All,

Can anyone help me with my query below

We have an interface that connects to our client database though VPN to fetch information for our application . We often lose connection to their db. The interface programs tries to reconnect for a stipulated iterations and if fails the interface program hangs. We are not sure of what caused the disconnection, whether it is network or DB unavailable.

Is there any tool that alerts us root cause of the disconnection?

Your valuable comments are most appreciated.

Thanks,

Sunil

0 Kudos

Can you monitor the VPN interface using NPM?

0 Kudos
Level 20

Will there be a new SDK now that NPM10.6 and SAM6.0 are being released?

0 Kudos

Yes, there will. No significant changes to the SDK are planned, just some general updates and fixes.

0 Kudos

The ToLocal function is in NPM 10.5. It doesn't matter what version of the SDK you use.

Ah my mistake, I was unaware that function existed in NPM previously.  Is there documentation on the list of SWQL functions available within NPM?  My searches are coming up empty, and I'd like to have such a list as a reference now that I am diving into reporting.

0 Kudos

Currently the list of functions is buried in this other thread: http://thwack.solarwinds.com/message/198138#198138. SDK 1.8 will include it in the official docs.

0 Kudos

Should ToLocal() work in SWQL Studio talking to NPM 10.6?    The name of the function seems to be correct (If I tweak the name by adding a character, I get an "invalid function" error back.) but I just keep getting 'socket closed' dialog back when I try it.  Can you provide a working example for a query in SWQL Studio that uses this function?

0 Kudos

Here's one that works:

SELECT ObjectName, AlertMessage, TriggerTimeStamp, Hour(TriggerTimeStamp) AS UtcHour, Hour(ToLocal(TriggerTimeStamp)) AS LocalHour

FROM Orion.AlertStatus

Ah ha!  This ToLocal() function only works with a SWIS v3 connection.  In a V2 connection I get an error, 'The socket connection was aborted...' error, as if the query timed out, but it fails instantly after submitting the query.  If I do this in V3 it works okay.

Do you think you could add a note to the SDK documentation indicating which version of connections are required for which functions to work?

Are there any plans to make V2 and V3 truly compatible?  Having to use V2 to access NCM data while switching to V3 to access other things like certain custom pollers and new SWQL features is turning into a nightmare for scripting.

0 Kudos

Adding a "SWIS version supported" column to the function table is a good idea. I'll get that in for the next SDK release.

There are no plans to add features to SWISv2. I recognize that it is painful to deal with some features only being available in one service (it's annoying for our developers too), but our direction is to move everything to SWISv3. There will never be a SWISv4 if I can help it, so we should not have to go through a transition like this again.

As for NCM data, we have already moved NCM support to SWISv3 in development. I'm not in a position to make commitments about version numbers or release dates (try ), but this distinction will not be with us too much longer.

Anyone aware of a release date for SDK 1.8 release?

Does SDK 1.8 support NPM 10.6.x?

0 Kudos

We're working on finishing up the 1.8 SDK update, but I don't have a date for you.

In general the tools in the SDK 1.7 should connect to NPM 10.6 just fine.

0 Kudos

Looking for some help with the powershell add, as the CRUD.addnode samples for SDK v1.7 fail with NPM 10.6.3

SolarWinds Support recommended posting in this SDK as the blog has not gotten a response in 8 days.

Using Powershell to add nodes with Custom Properties for Device Type

The goal is to automate the add/removes without any user intervention ruling out discovery.

This worked with with SDK v1.6 and NPM 10.5.4

Unfortunately this is an urgent matter for us to use the product.

Please have someone from the Development team or Product Manager to give me a call

Thanks,

Kevin

0 Kudos
Level 11

I'm still missing a database model, so I'll just use this opportunity to advertise for my two feature requests for documenting the database model in NPM and NCM:

NPM: http://thwack.solarwinds.com/ideas/2360

NCM: http://thwack.solarwinds.com/ideas/2361

Level 9

Do you know if is it possible to add users on Orion via API with Orion SDK. If positive, can you gently help us on the methods and parameters we have to use on our development to accomplish it.

0 Kudos