Page History

...

Query Parameter	Possible Values
`properties`	Array of property names. If provided only the properties specified will be returned (instead of the whole document). eg: `properties=["configuration.customer", "configuration.group"]` By default the nodes UUID is returned by default if no properties are given
`page`	(int) Which page of the requested document to returned, from 1 .. n
`limit`	(int) How many results are returned, defaults to 25
`filter`	Array of key=value pairs, but coded in an array. Applied to the list of results in the order they are given. If an application key is provided that will be applied first. eg: `filter={"configuration.group":"NMIS8","data.index": "196609"}` (which is "configuration.group"="NMIS8" AND "data.index"="196609" ) for a string, if it starts with regex: or iregex: then a case-sensitive or case-insensitive regular expression match is used. eg: `filter={"node_name":"iregex:Switch"}` to find all the nodes with switch or SWITCH in their name.
`sort`	1 \| -1 : sort the response with id ascending or descending.
`redact`	0 \| 1 : redact the information in configuration. ** works only if you have MongoDB 4.2 and above and set db_use_v42_features => 1 in opCommon.json

...

You will get a list of all the Inventory subconcepts in your database.

Successful Response

HTTP Status	Body	Description
200 OK	Possibly empty JSON array of strings	Each array element is a JSON string object with the subconcept name

Unsuccessful Response

HTTP Status	Body	Description
401 Unauthorized	JSON object with an `error` property	You are not authenticated.
403 Forbidden	JSON object with an `error` property	You are not authorized.

Example

Code Block

GET HTTP://server/omk/opCharts/v2/inventory.json

Output:- List of all the distinct subconcepts present in inventory
[ 
"health",
"Host_Health",
"laload",
"mib2ip",
"systemStats",
"tcp",
  . . .
"WindowsProcessor",
"hrwin",
"nodehealth",
"NetFlowStats",
"RouteNumber",
"Buffers"
]

...

You can use Request Modifiers (see above) for filtering, pagination, and selecting properties.

Successful Response

HTTP Status	Body	Description
200 OK	Possibly empty JSON array of strings	Each array element is a JSON string object with the subconcept name

Unsuccessful Response

HTTP Status	Body	Description
400 Bad Request	JSON object with an `error` property
401 Unauthorized	JSON object with an `error` property	You are not authenticated.
403 Forbidden	JSON object with an `error` property	You are not authorized.
404 Not Found	JSON object with an `error` property	You are authenticated but not authorised to view this object.
404 Not Found	JSON object with an `error` property	The `error` property contains an explanation of what went wrong with your request, e.g. if you request a non-existent object.

Example

Code Block

GET HTTP://server/omk/opCharts/v2/inventory/interface.json

Output :- List of first 25 interface inventory objects ("id" and "node_uuid") sorted by node_name in ascending order. 
[
	{
		"id": "63195a0341073d2dd339ce47",
		"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
	},
	{
		"id": "63195a0341073d2dd339ce5d",
		"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
	},
	{
		"id": "63195a0341073d2dd339ce74",
		"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
	},
	{
		"id": "63195a0341073d2dd339ce82",
		"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
	},
	{
		"id": "63195a0341073d2dd339ce90",
		"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
	},
	{
		"id": "63195a0341073d2dd339ceba",
		"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
	},

Similar requests and descriptions with subconcepts

Request	Response
GET http://server/omk/opCharts/v2/inventory/interface.json?limit=50	First 50 elements sorted by node_name ("id" and "node_uuid")
GET http://server/omk/opCharts/v2/inventory/interface.json?limit=50&page=2	Next 50 elements sorted by node_name ("id" and "node_uuid")
GET http://server/omk/opCharts/v2/inventory/interface.json?limit=50&properties=["node_name"]	First 50 elements sorted by node_name ("id" , "node_uuid", "node_name")
GET http://server/omk/opCharts/v2/inventory/interface.json?limit=50&page=2&properties=["data"]	Next 50 elements sorted by node_name ("id" , "node_uuid", "data")
GET http://server/omk/opCharts/v2/inventory/interface.json?limit=50&properties=["node_name"]&filter={"data.ifIndex":3}	First 50 elements sorted by node_name, filtered by inventory.data.ifIndex => 3 ("id" , "node_uuid", "node_name")
GET http://server/en/omk/opCharts/v2/inventory/interface.json?properties=["data.ifIndex","data.ifDescr","node_name","description"]&filter={"data.ifIndex":1}	First 25 interfaces sorted by node_name displaying 6 properties [ { "data": { "ifDescr": "lo", "ifIndex": 1 }, "description": "lo", "id": "64250e8ef82d4b6e59e888d9", "node_name": "lab-primary1", "node_uuid": "f2163325-a2b6-4d9a-8705-0dc0397ee7e3" }, { "data": { "ifDescr": "LOOPBACK", "ifIndex": 1 }, "description": "LOOPBACK", "id": "64cc4b8a5e13cceca7d030f7", "node_name": "SASINTEL_MARINA_PARK_P5_UPS01", "node_uuid": "9ac2e0ec-db2c-455a-9917-0471acaae231" }, . . . ]

GET of opcharts/v2/inventory/id

...

HTTP Status	Body	Description
401 Unauthorized	JSON object with an `error` property	You are not authenticated.
403 Forbidden	JSON object with an `error` property	You are not authorized.

Properties

Property	Description	Example
`id`	A globally unique ID	`65a5b8b843c6b8c138bc9cab`
`concept`	The concept for this inventory	`"device"`
`cluster_id`	The `id` of the NMIS poller server for the associated node	`"660f29ae-f150-4119-bf04-cd9296852449"`
`configuration`
`data`		`{` `"hrCpuLoad": 100,` `"hrDeviceDescr": "GenuineIntel: Intel(R) Xeon(R) CPU @ 2.20GHz",` `"hrDeviceType": "1.3.6.1.2.1.25.3.1.3",` `"index": "196609"` `}`
`data_info`
`description`		`"GenuineIntel: Intel(R) Xeon(R) CPU @ 2.20GHz"`
`enabled`		0 or 1
`expire_at`
`historic`		0 or 1
`lastupdate`	The unix timestamp that this inventory record was last updated.	`705359544.17113`
`node_name`	The `uuid` of the associated node	`"vrouter_host"`
`node_uuid`	The `uuid` of the associated node	`"a8ac3d79-aa7c-496f-ae19-f6df04c58a21"`
`path`	array	`response`
`server_name`	The `name` of the NMIS poller server for the associated node	`lab_poller1`
`subconcepts`	An array of the subconcepts for this inventory record	`[ "hrsmpcpu" ]`
`storage`

Example

Panel

http://server/omk/opCharts/v2/inventory/65a5b8b843c6b8c138bc9cab.json
{
"cluster_id": "660f29ae-f150-4119-bf04-cd9296852449",
"concept": "device",
"configuration": {
"group": "Lab_Servers"
},
"data": {
"hrCpuLoad": 100,
"hrDeviceDescr": "GenuineIntel: Intel(R) Xeon(R) CPU @ 2.20GHz",
"hrDeviceType": "1.3.6.1.2.1.25.3.1.3",
"index": "196609"
},
"data_info": [
{
"display_keys": [],
"enabled": 0,
"subconcept": "hrsmpcpu"
}
],
"dataset_info": [
{
"datasets": [
"hrCpuLoad"
],
"subconcept": "hrsmpcpu"
}
],
"description": "GenuineIntel: Intel(R) Xeon(R) CPU @ 2.20GHz",
"enabled": 1,
"expire_at": "2024-03-27T02:25:01.445Z",
"historic": 0,
"id": "65a5b8b843c6b8c138bc9cab",
"lastupdate": 1705359544.17113,
"node_name": "vrouter_host",
"node_uuid": "a8ac3d79-aa7c-496f-ae19-f6df04c58a21",
"path": [
"660f29ae-f150-4119-bf04-cd9296852449",
"a8ac3d79-aa7c-496f-ae19-f6df04c58a21",
"device",
196609
],
"path_keys": [
"index"
],
"server_name": "localhost",
"storage": {
"hrsmpcpu": {
"rrd": "/nodes/vrouter_host/health/hrsmpcpu196609.rrd"
}
},
"subconcepts": [
"hrsmpcpu"
]
}

...

Similar requests and descriptions with inventory id

Request

Response

GET HTTP://server/omk/opCharts/v2/inventory/63195a0341073d2dd339ce82.json

Raw inventory element with given id

GET HTTP://server/omk/opCharts/v2/inventory/63195a0341073d2dd339ce82.json?properties=["data"]

Raw inventory element with given id

("id", "inventory.data" and "node_uuid")

Space shortcuts

Page tree

Versions Compared

Old Version 19

New Version 20

Key

Successful Response

Unsuccessful Response

Example

Successful Response

Unsuccessful Response

Example

GET of opcharts/v2/inventory/id

Properties

Example