Class FlowDAO

DAO for accessing flow (Netflow/IPFIX/sFlow) data.

Hierarchy

BaseDAO
- FlowDAO

Constructors

constructor

new FlowDAO(impl): FlowDAO
Construct a DAO instance.
Parameters
- impl: IOnmsHTTP | IHasHTTP
  The HTTP implementation to use. It is also legal to pass any object conforming to the [[IHasHTTP]] interface (like a [[Client]]).
Returns FlowDAO
Inherited from BaseDAO.constructor
- Defined in src/dao/BaseDAO.ts:45

Accessors

http

get http(): IOnmsHTTP
The HTTP implementation to use internally when making DAO requests.

Returns IOnmsHTTP
Inherited from BaseDAO.http
- Defined in src/dao/BaseDAO.ts:56
set http(impl): void
Parameters
- impl: IOnmsHTTP
Returns void
Inherited from BaseDAO.http
- Defined in src/dao/BaseDAO.ts:61

server

get server(): OnmsServer
The [[OnmsServer]] being connected to by this DAO.

Returns OnmsServer
Inherited from BaseDAO.server
- Defined in src/dao/BaseDAO.ts:68
set server(s): void
Parameters
- s: OnmsServer
Returns void
Inherited from BaseDAO.server
- Defined in src/dao/BaseDAO.ts:76

Methods

`Private` checkForEnhancedFlows

checkForEnhancedFlows(): void
Check if this version of OpenNMS supports enhanced flow API and if not throw an error.

Returns void
- Defined in src/dao/FlowDAO.ts:659

`Private` checkForToSSupport

checkForToSSupport(): void
Check if this version of OpenNMS supports ToS filtering API and if not throw an error.

Returns void
- Defined in src/dao/FlowDAO.ts:670

getApplications

getApplications(prefix?, start?, end?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<string[]>
Enumerate the applications matching the given prefix and filters.
Parameters
- Optional prefix: string
  the prefix to match
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<string[]>
- Defined in src/dao/FlowDAO.ts:144

`Protected` getCount

getCount(data, status?): number
A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.
Parameters
- data: any
- Optional status: number
Returns number
Inherited from BaseDAO.getCount
- Defined in src/dao/BaseDAO.ts:139

getDscpValues

getDscpValues(exporterNodeCriteria?, ifIndex?, start?, end?): Promise<number[]>
Get used Dscp values for a specific interface
Parameters
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  the SNMP interface
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
Returns Promise<number[]>
- Defined in src/dao/FlowDAO.ts:73

getExporter

getExporter(criteria, limit, start?, end?): Promise<OnmsFlowExporter>
Get detailed information about a specific node.
Parameters
- criteria: string
  the node ID or foreignSource:foreignId tuple
- limit: number
  maximum number of interfaces to return (those with the most flows will be returned if the results are truncated)
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
Returns Promise<OnmsFlowExporter>
- Defined in src/dao/FlowDAO.ts:57

getExporters

getExporters(limit, start?, end?): Promise<OnmsFlowExporterSummary[]>
Get a summary of the nodes that have exported flows.
Parameters
- limit: number
  maximum number of exporters to return (those with the most flows will be returned if the results are truncated)
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
Returns Promise<OnmsFlowExporterSummary[]>
- Defined in src/dao/FlowDAO.ts:28

getHosts

getHosts(pattern?, start?, end?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<string[]>
Enumerate all the hosts matching the given pattern and filters.
Parameters
- Optional pattern: string
  the regex pattern to match
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<string[]>
- Defined in src/dao/FlowDAO.ts:414

`Protected` getOptions

getOptions(): OnmsHTTPOptionsBuilder
Create an [[OnmsHTTPOptions]] object for DAO calls.

Returns OnmsHTTPOptionsBuilder
- Defined in src/dao/FlowDAO.ts:644

getSeriesForApplications

getSeriesForApplications(applications?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>
Get time series data for the top N applications/protocols based on parameters.
Parameters
- Optional applications: string[]
  the applications to include
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional step: number
  the requested time interval between rows
- Optional includeOther: boolean
  include an additional "other" result that represents everything that does not match the given applications
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<OnmsFlowSeries>
- Defined in src/dao/FlowDAO.ts:257

getSeriesForConversations

getSeriesForConversations(conversations?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?, ecn?): Promise<OnmsFlowSeries>
Get time series data for the given conversations based on parameters.
Parameters
- Optional conversations: string[]
  how many conversations' series to return
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional step: number
  the requested time interval between rows
- Optional includeOther: boolean
  include an additional "other" result that represents everything that does not match the given conversations
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
- Optional ecn: string[]
Returns Promise<OnmsFlowSeries>
- Defined in src/dao/FlowDAO.ts:384

getSeriesForDscps

getSeriesForDscps(start?, end?, step?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>
Get time series data for DSCP based on parameters.
Parameters
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional step: number
  the requested time interval between rows
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<OnmsFlowSeries>
- Defined in src/dao/FlowDAO.ts:119

getSeriesForHosts

getSeriesForHosts(hosts?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>
Get time series data for the given hosts based on parameters.
Parameters
- Optional hosts: string[]
  the hosts to include
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional step: number
  the requested time interval between rows
- Optional includeOther: boolean
  include an additional "other" result that represents everything that does not match the given hosts
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<OnmsFlowSeries>
- Defined in src/dao/FlowDAO.ts:529

getSeriesForTopNApplications

getSeriesForTopNApplications(N?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>
Get time series data for the top N applications/protocols based on parameters.
Parameters
- Optional N: number
  how many applications' series to return
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional step: number
  the requested time interval between rows
- Optional includeOther: boolean
  include an additional "other" result that represents everything that does not match the top N
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<OnmsFlowSeries>
- Defined in src/dao/FlowDAO.ts:228

getSeriesForTopNConversations

getSeriesForTopNConversations(NOptions?, start?, end?, step?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>
Get time series data for the top N conversations based on parameters.
Parameters
- Optional NOptions: number | ITopNOptions
  how many conversations to return or an object that includes all of the parameters to be set on the API call
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional step: number
  the requested time interval between rows
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<OnmsFlowSeries>
- Defined in src/dao/FlowDAO.ts:351

getSeriesForTopNHosts

getSeriesForTopNHosts(N?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>
Get time series data for the top N hosts based on parameters.
Parameters
- Optional N: number
  how many applications' series to return
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional step: number
  the requested time interval between rows
- Optional includeOther: boolean
  include an additional "other" result that represents everything that does not match the top N
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<OnmsFlowSeries>
- Defined in src/dao/FlowDAO.ts:499

getSummaryForApplications

getSummaryForApplications(applications?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>
Summarize the given applications/protocols based on parameters.
Parameters
- Optional applications: string[]
  the applications to include
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional includeOther: boolean
  include an additional "other" result that represents everything that does not match the given applications
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<OnmsFlowTable>
- Defined in src/dao/FlowDAO.ts:195

getSummaryForConversations

getSummaryForConversations(conversations?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>
Summarize the given conversations based on parameters.
Parameters
- Optional conversations: string[]
  how many conversations to return
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional includeOther: boolean
  include an additional "other" result that represents everything that does not match the given conversations
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<OnmsFlowTable>
- Defined in src/dao/FlowDAO.ts:320

getSummaryForDscps

getSummaryForDscps(start?, end?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>
Summarize the the dscp values based on parameters.
Parameters
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<OnmsFlowTable>
- Defined in src/dao/FlowDAO.ts:94

getSummaryForHosts

getSummaryForHosts(hosts?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>
Summarize the given hosts based on parameters.
Parameters
- Optional hosts: string[]
  the hosts to include
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional includeOther: boolean
  include an additional "other" result that represents everything that does not match the given hosts
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<OnmsFlowTable>
- Defined in src/dao/FlowDAO.ts:439

getSummaryForTopNApplications

getSummaryForTopNApplications(N?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>
Summarize the top N applications/protocols based on parameters.
Parameters
- Optional N: number
  how many applications to return
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional includeOther: boolean
  include an additional "other" result that represents everything that does not match the top N
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<OnmsFlowTable>
- Defined in src/dao/FlowDAO.ts:169

getSummaryForTopNConversations

getSummaryForTopNConversations(NOptions?, start?, end?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>
Summarize the top N conversations based on parameters.
Parameters
- Optional NOptions: number | ITopNOptions
  how many conversations to return or an object that includes all of the parameters to be set on the API call
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<OnmsFlowTable>
- Defined in src/dao/FlowDAO.ts:289

getSummaryForTopNHosts

getSummaryForTopNHosts(N?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>
Summarize the top N hosts based on parameters.
Parameters
- Optional N: number
  how many conversations to return
- Optional start: number
  the start of the timespan to query (defaults to 4 hours ago)
- Optional end: number
  the end of the timespan to query (defaults to now)
- Optional includeOther: boolean
  include an additional "other" result that represents everything that does not match the top N
- Optional exporterNodeCriteria: string
  the node ID or foreignSource:foreignId tuple
- Optional ifIndex: number
  filter for flows that came through this SNMP interface
- Optional dscp: string[]
  filter for flows with this Dscp value
Returns Promise<OnmsFlowTable>
- Defined in src/dao/FlowDAO.ts:471

`Protected` onSetServer

onSetServer(server?): void
Called whenever the OpenNMS server has changed.
Parameters
- Optional server: OnmsServer
  the new server
Returns void
Inherited from BaseDAO.onSetServer
- Defined in src/dao/BaseDAO.ts:121

`Protected` toDate

toDate(from): Moment
Convert the given value to a date, or undefined if it cannot be converted.
Parameters
- from: any
Returns Moment
Deprecated
use Util.toDate instead.
Inherited from BaseDAO.toDate
- Defined in src/dao/BaseDAO.ts:161

`Protected` toNumber

toNumber(from): number
Convert the given value to a number, or undefined if it cannot be converted.
Parameters
- from: any
Returns number
Deprecated
use Util.toNumber instead.
Inherited from BaseDAO.toNumber
- Defined in src/dao/BaseDAO.ts:169

`Protected` useJson

useJson(): boolean
Whether or not to use JSON when making ReST requests.

Returns boolean
Inherited from BaseDAO.useJson
- Defined in src/dao/BaseDAO.ts:128

Class FlowDAO

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns FlowDAO

Accessors

http

Returns IOnmsHTTP

Parameters

Returns void

server

Returns OnmsServer

Parameters

Returns void

Methods

Private checkForEnhancedFlows

Returns void

Private checkForToSSupport

Returns void

getApplications

Parameters

Returns Promise<string[]>

Protected getCount

Parameters

Returns number

getDscpValues

Parameters

Returns Promise<number[]>

getExporter

Parameters

Returns Promise<OnmsFlowExporter>

getExporters

Parameters

Returns Promise<OnmsFlowExporterSummary[]>

getHosts

Parameters

Returns Promise<string[]>

Protected getOptions

Returns OnmsHTTPOptionsBuilder

getSeriesForApplications

Parameters

Returns Promise<OnmsFlowSeries>

getSeriesForConversations

Parameters

Returns Promise<OnmsFlowSeries>

getSeriesForDscps

Parameters

Returns Promise<OnmsFlowSeries>

getSeriesForHosts

Parameters

Returns Promise<OnmsFlowSeries>

getSeriesForTopNApplications

Parameters

Returns Promise<OnmsFlowSeries>

getSeriesForTopNConversations

Parameters

Returns Promise<OnmsFlowSeries>

getSeriesForTopNHosts

Parameters

Returns Promise<OnmsFlowSeries>

getSummaryForApplications

Parameters

Returns Promise<OnmsFlowTable>

getSummaryForConversations

Parameters

Returns Promise<OnmsFlowTable>

getSummaryForDscps

Parameters

Returns Promise<OnmsFlowTable>

getSummaryForHosts

Parameters

Returns Promise<OnmsFlowTable>

getSummaryForTopNApplications

Parameters

Returns Promise<OnmsFlowTable>

`Private` checkForEnhancedFlows

`Private` checkForToSSupport

`Protected` getCount

`Protected` getOptions

`Protected` onSetServer

`Protected` toDate

`Protected` toNumber

`Protected` useJson