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

Hierarchy

  • BaseDAO
    • FlowDAO

Constructors

Accessors

Methods

  • Check if this version of OpenNMS supports enhanced flow API and if not throw an error.

    Returns void

  • Check if this version of OpenNMS supports ToS filtering API and if not throw an error.

    Returns void

  • 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[]>

  • 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

  • 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[]>

  • 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<Model.OnmsFlowExporter>

  • 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<Model.OnmsFlowExporterSummary[]>

  • 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[]>

  • 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<Model.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<Model.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<Model.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<Model.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<Model.OnmsFlowSeries>

  • Get time series data for the top N conversations based on parameters.

    Parameters

    • Optional NOptions: number | DAO.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<Model.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<Model.OnmsFlowSeries>

  • 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<Model.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<Model.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<Model.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<Model.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<Model.OnmsFlowTable>

  • Summarize the top N conversations based on parameters.

    Parameters

    • Optional NOptions: number | DAO.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<Model.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<Model.OnmsFlowTable>

  • Convert the given value to a date, or undefined if it cannot be converted.

    Deprecated

    use Util.toDate instead.

    Parameters

    • from: any

    Returns Moment

  • Convert the given value to a number, or undefined if it cannot be converted.

    Deprecated

    use Util.toNumber instead.

    Parameters

    • from: any

    Returns number

  • Whether or not to use JSON when making ReST requests.

    Returns boolean

Generated using TypeDoc