Information on APIs

[Shwetanjali]

Hi,

I want information on the APIs which can give me certain information about the endpoints which I get after entering the IP Range through Platform-Boundary-Networks ribbon on admin console.For ex: the GET API- http://localhost:52707/ocp/config/client/MyDesktop gives me about the configuration of my client machine (MyDesktop in my case). Similarly I want following information about other endpoints which I see via ribbon Data-Content-Simple Queries-Find endpoints
1)Device Name
2)Device Type- ex: Desktop/Laptop/Server
3)Device IP Address-ex: 192.168.0.1
4)Device OS- ex: Windows 10, Windows server 2019
5)Device Model- ex: Dell Optiplex, HP 440s
6)Device Purchase Date
7)Warranty Start Date/Warranty Expiry Date
8)Device Processor/MFG
9)No. of Processor
10)No. of cores
11)CPU Clock Speed
12)Physical Memory
13)Memory Assigned
14)OS Version
15)Network Cards
16)MAC Address
17)DNS

[codingadvocate]

Hi Shwetanjali,

You can walk through the REST API by starting with the top and continuing down.

If you are looking for additional help with creating queries/reports/integrations for your use cases, I’d direct you towards CMS Construct (professional service provider for OCP). They provide a starter guide for the REST API under the downloads section of their ITDM page: https://cmsconstruct.com/itdm

[Shwetanjali]

Hi,

I could get the maximum information from the CMS Construct REST API page. However, I cannot get configuration info about the various nodes which I get through find jobs (eg: nodes within the Realmscope: 192.168.0.1 – 192.168.0.254).
By configuration info I mean, the info which we get about the client machine through GET API- “http://localhost:52707/ocp/config/client/MyDesktop”. The response to this API gives following info about client machine- platformType, platformMachine, platformVersion, cpuType, cpuCount, memoryTotal
I require similar information for the other nodes also. Is there any payload that I can use with API- “/query/this” to get the required information.
Could you please guide me through it.

[codingadvocate]

Hi Shwetanjali,

Clients:
OCP clients are instances of the OCP client software. If you walk through the REST API, you will find that a GET on ocp/config describes a GET on ocp/config/client as the following: “Report all server endpoints running one or more OCP service clients.”

As such, the ocp/config/client/MyDesktop works if MyDesktop is running one of the OCP clients (e.g. contentGathering, universalJob, resultsProcessing). This is showing you runtime information tracked by instances of the client, for the purpose of system health, logging, self-restarts, etc. That shows OCP clients, not the discovered endpoints.

If you want to see data on all discovered objects, then use a different REST endpoint. For just Node context, you can do a GET on ocp/data/Node… or ocp/data/Windows or ocp/data/Linux, etc. Yes, a custom query in /query/this will do it, so you get related objects to the Nodes. But to see what the Find jobs gather, there is a view already packaged… called “Find endpoints” (GET on “ocp/query/simple/Find endpoints”). Although that looks more suited for a graphical view via admin console, since it’s not pulling all data on the Node objects.

Sticking with this idea: a GET on “ocp/query/config/simple/Find endpoints” shows you the query definition, where specific attributes are listed. You can save that as a new version, or send that definition through /query/this for an add-hoc query. I’d suggest removing the named attributes from those sections (leaving the list empty) so it pulls all attributes, and I think that will get you closer to your goal.

Discovery:
The packaged Find jobs pull high level OS/HW data like platform, version, hardware. Those connected objects are shown by the Find endpoints query just mentioned. If you want to get CPU/Memory/Disk info from all discovered endpoints, I don’t remember seeing anything specific to CPU/Memory type data. So you may need to create a job to go after your specific data points. Obviously that’s something the platform is enables.

There are a variety of pre-packaged jobs to exemplify the types of directions you can go with the product. This is especially true with the dynamic discovery jobs. I haven’t seen another vendor product (paid or free) come close in comparison to the dynamic software discovery, which finds software mapped across servers – without any agents or software signatures. That one really helps with discovery efforts that feed Software Asset Management (SAM) projects.

[Shwetanjali]

Thanks for your response.
Yes, I actually need CPU/Memory/Disk type information for all discovered endpoints other than just client. As you mentioned, I may need to create a job- my question is- Isn’t there any job already which can get CPU/Memory type for all discovered points? If not, is there any doc available that I can study to create required job because I am new to ITSM work.

[codingadvocate]

Have you watched the screen captured videos on the website? The last video listed on the discovery page (https://www.opencontentplatform.org/discovery) provides a detailed walk through with how discovery works. Maximize the window and set the playback to high… about 20 minutes and you will have a good start.

I’m not aware of docs to describe how to create and deploy new jobs, but I can attest that the code is there.

If you want help with new job development/training/etc, talk to CMS Construct or others for paid services. The OSS side is for platform support.

[Author]

Posts