Page History

...

We can view opCharts Inventory below using these endpoints - http[s]://server/omk/opCharts/v2/inventory

API Routes

Request Modifiers (query parameters)

The properties request modifier tells opCharts which properties you would like listed, query limits the requested resources to only those that match all criteria given. This collection can paginated, it is also limited to 25 results by default (this could be subject to change in future opCharts versions) use the limit query parameter to request more nodes

Not all requests will use all request modifiers.

...

Query Parameter

...

Possible Values

...

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

...

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.

...

1 | -1 : sort the response with id ascending or descending.

...

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

Request Modifiers (query parameters)

The properties request modifier tells opCharts which properties you would like listed, query limits the requested resources to only those that match all criteria given. This collection can paginated, it is also limited to 25 results by default (this could be subject to change in future opCharts versions) use the limit query parameter to request more nodes

Not all requests will use all request modifiers.

Examples of how to use the request modifiers can be found in the response blocks below.  In general, the queries will look something like this: 

GET of opcharts/v2/inventory for List

GET /omk/opCharts/v2/inventory

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

Examples of how to use the request modifiers can be found in the response blocks below.  In general, the queries will look something like this: 

GET of opcharts/v2/inventory for List

GET /omk/opCharts/v2/inventory

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

Successful Response

...

Unsuccessful Response

...

GET of

...

opCharts/v2/inventory/id 

GET /omk/opCharts/v2/inventory/id

...

Properties

Example

Similar requests and descriptions with inventory id

Example

Similar requests and descriptions with inventory id

GET of opCharts/v2/nodes/node_uuid/inventory for List

GET /omk/opCharts/v2/nodes/node_uuid/inventory

You will get a list of all the Inventory subconcepts for the node with node_uuid.

Successful Response

Unsuccessful Response

GET HTTP://server/omk/opCharts/v2/nodes/08098577-5d8c-11e9-9614-8a6323fe4840/inventory.json

Output:- List of all the distinct subconcepts present in inventory
[
"Cisco_CBQoS",
"Memory-cpm",
"addressTable",
"bgpPeer",
"cempMemPool",
"ciscoMemoryPool",
"ciscoNormalizedCPUMem",
"cpu_cpm",
"entityMib",
"env-temp",
"interface",
"pkts",
"pkts_hc",
"ospfNbr",
"powerSupply"
]

GET of opCharts/v2/nodes/node_uuid/inventory/subconcept for List

GET /omk/opCharts/v2/nodes/node_uuid/inventory/subconcept

You will get a list of all the Inventory records with the node with node_uuid and the subconcept subconcept.

Successful Response

Unsuccessful Response

GET HTTP://server/omk/opCharts/v2/nodes/08098577-5d8c-11e9-9614-8a6323fe4840/inventory/interface.json

Output:- List of first 25 node inventory objects ("id" and "node_uuid") sorted by id inside given subconcept.  
[
	{
		"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"
	},
	{
		"id": "63195a0341073d2dd339ced0",
		"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
	}
]

Similar requests and descriptions with node and subconcept