Community
- Command Central
- MVP Program
- Monthly Mission
- Blogs
- Groups
- Events
- Media Vault
Products
- Observability
- Network Management
- Application Management
- IT Security
- IT Service Management
- System Management
- Database Management
Content Exchange
- SolarWinds Platform
- Server & Application Monitor
- Database Performance Analyzer
- Server Configuration Monitor
- Network Performance Monitor
- Network Configuration Manager
- SQL Sentry
- Web Help Desk
Free Tools & Trials
Store

Create/Modify Maps using the REST API

I have hundreds of atlas maps and thousands of devices.

I'm evaluating the possibilities to create Orion.Maps using the REST API.

I know how to create a Nodes or other objects, for example using curl (but I use a java backend in prod) :

curl -k -X POST -H "Content-Type: application/json" -H "Authorization: Basic basicloginpassword" https://myserver.domain.net:17778/SolarWinds/InformationService/v3/Json/Create/Orion.Nodes --data '{"Caption":"node.domain.net","IPAddress":"10.1.2.3","MachineType":"net-snmp - Linux","DynamicIP":false,"EngineID":1, "ObjectSubType":"ICMP"}"

Same, I know how to modify CustomProperties :

curl -k -X POST -H "Content-Type: application/json" -H "Authorization: Basic basicloginpass" https://myserver.domain.net:17778/SolarWinds/InformationService/v3/Json/swis://myserver.domain.net/Orion/Orion.Nodes/NodeID=6/CustomProperties --data '{ "City":"Paris"}'

But it's not working for a Orion Maps and I didn't find anything in the doc about this. I'm not sure what need to be created, a Orion.Maps.Projects ? But how do I get the required ProjectId ? How do I modify GraphDefinition to add Node in the maps ?

Find more posts tagged with

Accepted answers

All comments

mesverrum

In general terms this is the documentation you would want to be looking at

https://github.com/solarwinds/OrionSDK/wiki/REST#create-request

You don't pass in a projectID, if you send in a properly put together payload then it should respond with the projectid that the system creates. You can see that in your example where you create a node, you arent passing in a nodeID there either.

As far as what exactly you need to pass in, I don't know of anyone who has done the legwork to script maps. The relevant tables all support the necessary CRUD operations, so it definitely could be done but you are going to have to reverse engineer exactly how to do that on your own. SW isn't going to provide documentation for it and from what I have seen it'll be a fairly complex bit of trial and error to learn how it all works. Whenever I've attacked one of those kinds of scripts I start by just going through all the steps in the GUI and seeing what happens in the DB so I could manually recreate that. Something like first create a blank map and see what those populate in the db. Then add a single object, check the db, add more objects, check the db, move things around, check the db, etc.

Good luck to you, as soon as I saw the DB structures of the new maps I knew it would be possible for someone to automate but I haven't had the need so I wasn't going to put in the hours myself.

kowalsky

Thanks for your answer.

In general terms this is the documentation you would want to be looking at

https://github.com/solarwinds/OrionSDK/wiki/REST#create-request

You don't pass in a projectID, if you send in a properly put together payload then it should respond with the projectid that the system creates. You can see that in your example where you create a node, you arent passing in a nodeID there either.

That's why I ask, because I did a lot of what you describe, tried inserting, modifying and empty maps. I thought the ProjectID would be returned with the swis path, but I had this error instead :

"Cannot insert the value NULL into column 'ProjectID', table 'automap.dbo.Maps_Projects',

I created a ProjectID manually and the project is visible in DB in the table Orion.Maps.Projects but now in the GUI. When a project is created from the GUI, an entry is made in the table Orion.Maps.Graphs, let's try to add an entry in this table.

In the table Orion.Maps.Graphs, I found a field Container in the swis URI of a Map added in GUI : swis://myserver.domain.net/Orion/Orion.Maps.Graphs/ContainerID=2

It looks like it's related to an abstract entity Orion.Container, I found a method to create it : Orion.Maps.Graphs.CreateContainer

I have been able to create a container, but it's still not displaying in the GUI and I'm still not able change the field GraphDefinition in the Project. I think GraphDefinition and Data is where the map data is stored :

GraphDefinition content is this :

{
"ContainerOpid":"0_Orion.Maps.Graphs_17",
"ProjectId":"MAPS-longString",
"NodeRules":[{"Type":0,"Opid":"0_Orion.Nodes_25","Filter":null},{"Type":0,"Opid":"0_Orion.Nodes_1317","Filter":null},{"Type":0,"Opid":"0_Orion.Nodes_5632","Filter":null},{"Type":0,"Opid":"0_Orion.Nodes_5633","Filter":null}],
"EdgeRules":[{"Type":3,"Opids":[],"Filter":null},{"Type":4,"Opids":[],"Filter":null},{"Type":2,"Opids":[],"Filter":null},{"Type":1,"Opids":[],"Filter":null}]
}

NodeRule is a list of Orion.Node

The Data field appears to be storing the position and other properties.

SW isn't going to provide documentation for it and from what I have seen it'll be a fairly complex bit of trial and error to learn how it all works.

What make you think SW will not document this ? I'm new to SW, never did anything outside of the easy CRUD NPM/NCM.

But it should be documented, in 2023, we are in an era of DevOps, NetOps, SDN and automation, it should be possible to make Maps by automation.

sum_giais

[quote userid="305422" url="~/products/network-performance-monitor-npm/f/forum/100891/create-modify-maps-using-the-rest-api/316430"]What make you think SW will not document this ? I'm new to SW, never did anything outside of the easy CRUD NPM/NCM.[/quote]

SolarWinds has a blanket response to the SDK and API of "we don't support that... you're on your own". Yes there's the schema documentation, github, swaggerui and SWQL studio so we have breadcrumbs and tools to aid in figuring it out but that's the reality of it - you're ultimately left to your own merits and the user community in these regards.

For the ProjectID, it looks like its just MAPS-UniqueUUID, so you might be able to generate a UUID and prepend MAPS- and maybe give that a go.

kowalsky

Thanks for your answer.

SolarWinds has a blanket response to the SDK and API of "we don't support that... you're on your own".

Let's see, I requested a meeting with a SW rep to discuss this. Maybe they have a training course about this.

For the ProjectID, it looks like its just MAPS-UniqueUUID, so you might be able to generate a UUID and prepend MAPS- and maybe give that a go.

It looks like anything starting with MAPS- is working, but you have to run 'Orion.Maps.Graphs.CreateContainer' , I run it in SWQL studio :

Once it is finished, the MAPS is visible in the GUI, but for some time, I suspect something is happening in the background, the MAPS GUI is broken, then after a reload, the MAPS is editable.

I see a line have been added in the table Orion.Maps.Graphs, probably because of Orion.Maps.Graphs.CreateContainer

How do we run Orion.Maps.Graphs.CreateContainer from a REST call ?