Check if this version of OpenNMS supports enhanced flow API and if not throw an error.
Enumerate the applications matching the given prefix and filters.
the prefix to match
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
the node ID or foreignSource:foreignId tuple
filter for flows that came through this SNMP interface
A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.
Get detailed information about a specific node.
the node ID or foreignSource:foreignId tuple
maximum number of interfaces to return (those with the most flows will be returned if the results are truncated)
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
Get a summary of the nodes that have exported flows.
maximum number of exporters to return (those with the most flows will be returned if the results are truncated)
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
Enumerate all the hosts matching the given pattern and filters.
the regex pattern to match
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
the node ID or foreignSource:foreignId tuple
filter for flows that came through this SNMP interface
Get time series data for the top N applications/protocols based on parameters.
the applications to include
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
the requested time interval between rows
include an additional "other" result that represents everything that does not match the given applications
the node ID or foreignSource:foreignId tuple
filter for flows that came through this SNMP interface
Get time series data for the given conversations based on parameters.
how many conversations' series to return
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
the requested time interval between rows
include an additional "other" result that represents everything that does not match the given conversations
the node ID or foreignSource:foreignId tuple
filter for flows that came through this SNMP interface
Get time series data for the given hosts based on parameters.
the hosts to include
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
the requested time interval between rows
include an additional "other" result that represents everything that does not match the given hosts
the node ID or foreignSource:foreignId tuple
filter for flows that came through this SNMP interface
Get time series data for the top N applications/protocols based on parameters.
how many applications' series to return
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
the requested time interval between rows
include an additional "other" result that represents everything that does not match the top N
the node ID or foreignSource:foreignId tuple
filter for flows that came through this SNMP interface
Get time series data for the top N conversations based on parameters.
how many conversations to return or an object that includes all of the parameters to be set on the API call
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
the requested time interval between rows
the node ID or foreignSource:foreignId tuple
filter for flows that came through this SNMP interface
Get time series data for the top N hosts based on parameters.
how many applications' series to return
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
the requested time interval between rows
include an additional "other" result that represents everything that does not match the top N
the node ID or foreignSource:foreignId tuple
filter for flows that came through this SNMP interface
Summarize the given applications/protocols based on parameters.
the applications to include
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
include an additional "other" result that represents everything that does not match the given applications
the node ID or foreignSource:foreignId tuple
filter for flows that came through this SNMP interface
Summarize the given conversations based on parameters.
how many conversations to return
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
include an additional "other" result that represents everything that does not match the given conversations
the node ID or foreignSource:foreignId tuple
filter for flows that came through this SNMP interface
Summarize the given hosts based on parameters.
the hosts to include
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
include an additional "other" result that represents everything that does not match the given hosts
the node ID or foreignSource:foreignId tuple
filter for flows that came through this SNMP interface
Summarize the top N applications/protocols based on parameters.
how many applications to return
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
include an additional "other" result that represents everything that does not match the top N
the node ID or foreignSource:foreignId tuple
filter for flows that came through this SNMP interface
Summarize the top N conversations based on parameters.
how many conversations to return or an object that includes all of the parameters to be set on the API call
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
the node ID or foreignSource:foreignId tuple
filter for flows that came through this SNMP interface
Summarize the top N hosts based on parameters.
how many conversations to return
the start of the timespan to query (defaults to 4 hours ago)
the end of the timespan to query (defaults to now)
include an additional "other" result that represents everything that does not match the top N
the node ID or foreignSource:foreignId tuple
filter for flows that came through this SNMP interface
Convert the given value to a date, or undefined if it cannot be converted.
Convert the given value to a number, or undefined if it cannot be converted.
Whether or not to use JSON when making ReST requests.
Create an OnmsHTTPOptions object for DAO calls.
Generated using TypeDoc
DAO for accessing flow (Netflow/IPFIX/sFlow) data.