Class NodeDAO

Hierarchy

AbstractDAO<number, OnmsNode>
- NodeDAO

Index

Constructors

constructor

Properties

http

Methods

Constructors

constructor

new NodeDAO(impl: IHasHTTP | IOnmsHTTP): NodeDAO

Overrides AbstractDAO.constructor
- Defined in dao/NodeDAO.ts:35
Parameters
- impl: IHasHTTP | IOnmsHTTP
Returns NodeDAO

Properties

Protected http

http: IOnmsHTTP

the HTTP implementation to use

Methods

fetch

fetch(node: OnmsNode): Promise<OnmsNode>

- Defined in dao/NodeDAO.ts:198
given a node, fetch all the sub-model objects for that node (ipInterfaces, snmpInterfaces, etc.)

Parameters
- node: OnmsNode
Returns Promise<OnmsNode>

find

find(filter?: Filter): Promise<OnmsNode[]>

Overrides AbstractDAO.find
- Defined in dao/NodeDAO.ts:177
search for nodes, given a filter

Parameters
- Optional filter: Filter
Returns Promise<OnmsNode[]>

get

get(id: number, recurse?: boolean): Promise<OnmsNode>

Overrides AbstractDAO.get
- Defined in dao/NodeDAO.ts:162
get an node, given the node's ID

Parameters
- id: number
  
  the node's ID
- Default value recurse: boolean = false
  
  optionally fetch all sub-model objects (ipInterface, etc.)
Returns Promise<OnmsNode>

Protected getApiVersion

getApiVersion(): 1 | 2

Inherited from AbstractDAO.getApiVersion
- Defined in dao/AbstractDAO.ts:86
retrieve the API version from the underlying server

Returns 1 | 2

Protected getCount

getCount(data: any): number

Inherited from AbstractDAO.getCount
- Defined in dao/AbstractDAO.ts:48
extract the count or totalCount values from response data

Parameters
- data: any
Returns number

Protected getFilterProcessor

getFilterProcessor(): any

Inherited from AbstractDAO.getFilterProcessor
- Defined in dao/AbstractDAO.ts:94
retrieve filter processor for the current API version

Returns any

Protected getOptions

getOptions(filter?: Filter): OnmsHTTPOptions

Inherited from AbstractDAO.getOptions
- Defined in dao/AbstractDAO.ts:61
given an optional filter, generate an OnmsHTTPOptions object for DAO calls

Parameters
- Optional filter: Filter
Returns OnmsHTTPOptions

ipInterfaces

ipInterfaces(node: number | OnmsNode, filter?: Filter): Promise<OnmsIpInterface[]>

- Defined in dao/NodeDAO.ts:225
given a node, get the IP interfaces for that node

Parameters
- node: number | OnmsNode
- Optional filter: Filter
Returns Promise<OnmsIpInterface[]>

services

services(node: number | OnmsNode, ipInterface: string | OnmsIpInterface, filter?: Filter): Promise<OnmsMonitoredService[]>

- Defined in dao/NodeDAO.ts:273
given a node, get the IP interfaces for that node

Parameters
- node: number | OnmsNode
- ipInterface: string | OnmsIpInterface
- Optional filter: Filter
Returns Promise<OnmsMonitoredService[]>

snmpInterfaces

snmpInterfaces(node: number | OnmsNode, filter?: Filter): Promise<OnmsSnmpInterface[]>

- Defined in dao/NodeDAO.ts:249
given a node, get the SNMP interfaces for that node

Parameters
- node: number | OnmsNode
- Optional filter: Filter
Returns Promise<OnmsSnmpInterface[]>

Protected toDate

toDate(from: any): any

Inherited from AbstractDAO.toDate
- Defined in dao/AbstractDAO.ts:72
convert the given value to a date, or undefined if it cannot be converted

Parameters
- from: any
Returns any

Protected toNumber

toNumber(from: any): number

Inherited from AbstractDAO.toNumber
- Defined in dao/AbstractDAO.ts:80
convert the given value to a number, or undefined if it cannot be converted

Parameters
- from: any
Returns number

Generated using TypeDoc