Administering NetIM : Launching NetIM from an external application
  
Launching NetIM from an external application
Using a model or metrics query, you can search NetIM and launch to results from an external application. The root NetIM search URL used for this call is:
/vnes/Home.html#/vnes/search
You can further parameterize the search URL to do a model or top-N metrics query as described in the sections below.
• Model query
• Top-N metrics query
The default ports are 9190 and 8543 for HTTP and HTTPS, respectively. NetIM is configured to use HTTPS by default.
Model query
To do a model query, use the parameters shown in the following table. The syntax for a model query is as follows.
http://<NetIM_server>:8543/vnes/Home.html#/vnes/search?query=<string>
Parameters for a model query are described in the following table.
Name
Required?
Description
Values
Default value
query
Yes
Query string
<query string>
None
type
No
Limits the search to the specified object type(s).
Comma-separated list of object types: device, site, group, interface, host, archive.
All object types
autoForward
No
Specifies whether to go to the search result’s object view, if the query returns a single result.
true | false
false
Model query example
The following query returns results for device and interface objects containing the string beth:
http://MyNetIMserver.any.com:8543/vnes/Home.html#/vnes/search?type=DEVICE,INTERFACE&query=beth
Top-N metrics query
To do a top-N metrics query, use the parameters shown in the following table. The syntax for a top-N metrics query is as follows.
http://<NetIM_server>:8543/vnes/Home.html#/vnes/search?searchType=topbottomn&type=DEVICE&top=true&n=10&metricClass=IFC_UTIL&metric=throughputIn&timeWindowAlgo=avg&filterOperator=%3E&filterValue=5&rollupAlgo=aggregateAvgRollup&startTime=148727 3666050&endTime=1487277266050
Parameters for a top-N metrics query are described in the following tables.
Name
Required?
Description
Values
Default value
Search type
Yes
Indicates that this is a top/bottom-n metrics query
topbottomn
None
type
Yes
Limits the search to the specified object type(s)
device | group | interface
device
top
Yes
Specifies a top/bottom-n search
true | false
true
n
Yes
Defines the variant for number of results
<number>
10
metricClass
Yes
Queried metric class
See
None
timeWindowAlgo
Yes
The operation applied when rolling up the metric sample data to larger time windows
avg | min | max | sum
None
startTime
Yes
Start timestamp
<number>
Current timestamp
endTime
Yes
End timestamp
<number>
Current timestamp
filterOperator
No
Operator used to evaluate metric values
> (%3E), >=(%3E=), =, !=, < (%3C), <= (%3C=)
None
filterValue
No
Use in conjunction with filterOperator
<number>
None
rollupAlgo
No
The algorithm applied when rolling up metric sample data to larger time windows
See
None
autoForward
No
Specifies whether to forward the search result’s object view if the query returns a single result.
true | false
false
Metric classes
Object
SERVER_SYSTEM_STATS
Device
SERVER_SW_RUN_PERF
Device
DOM_CTL
Device
SHAREPOINT_ASP_NET
Device
SQL_SERVER
Device
MGTSYS_SERVER
Device
MSMQ_QUEUE
Device
SP_SQL_DATABASES
Device
DEV_STATUS
Device
CPU_UTIL
Device
SERVER_DEVICE_STAT
Device
SP_SQL_STATISTICS
Device
SERVER_DISK_USAGE
Device
TCP_CONN
Device
WIN_SERVICE
Device
IIS_WEB
Device
SP_SEARCH_INDEXER
Device
SP_SEARCH
Device
LSP_UTIL
Device
SP_SQL_LATCHES
Device
SYS_STATS
Device
LSN_PRTS
Device
DEV_AVL
Device
MEMORY_USAGE
Device
SP_SQL_PLAN_CACHE
Device
WIN_SYS
Device
DEV_EVENT_COUNT
Device
EVENTS_DETAIL
Device
DEV_CHANGES
Device
SP_SQL_LOCKS
Device
COS_UTIL
Interface
IFC_UTIL
Interface
IFC_ERRORS
Interface
UTILS
Interface
IFC_AVAILABILITY
Interface
IFC_MEDIA_CALLS
Interface
ATM_UTIL
Interface
COS_DROPS
Interface
ETHER_STATS
Interface
IFC_STATUS
Interface
FR_UTIL
Interface
IFC_EVENT_COUNT
Interface
GRP_STATUS
Group
GRP_EVENT_COUNT
Group
Rollup algorithm
aggregateMinRollup
aggregateMaxRollup
aggregateAvgRollup
aggregateSumRollup
durationWeightedRollup
aggregatePercentileRollup
aggregatePctl95RateRollup
aggregatePctl98RateRollup