Class ServerMetadata

Hierarchy

ServerMetadata

Index

Constructors

constructor

Properties

type
version

Methods

Constructors

constructor

new ServerMetadata(version?: string | OnmsVersion, type?: ServerType): ServerMetadata

- Defined in api/ServerMetadata.ts:13
Construct a ServerMetadata object.

constructor

Parameters
- Optional version: string | OnmsVersion
  
  the version of the server
- Optional type: ServerType
  
  the type of server (Horizon, Meridian)
Returns ServerMetadata

Properties

type

type: ServerType

the type of server (Horizon, Meridian)

version

version: OnmsVersion

the version of the server

Methods

ackAlarms

ackAlarms(): any

- Defined in api/ServerMetadata.ts:31
can you ack alarms through ReST

Returns any

apiVersion

apiVersion(): 1 | 2

- Defined in api/ServerMetadata.ts:55
what version of the ReST API does this server support

Returns 1 | 2

capabilities

capabilities(): object

- Defined in api/ServerMetadata.ts:64
a convenient data structure with all capabilities listed

Returns object
- ackAlarms: any
- apiVersion: number
- graphs: any
- outageSummaries: any
- setNodeLocation: any
- type: string

clone

clone(): ServerMetadata

- Defined in api/ServerMetadata.ts:90
Create a new ServerMetadata object from this existing one.

Returns ServerMetadata

graphs

graphs(): any

- Defined in api/ServerMetadata.ts:36
does this server support graphs (ie, the measurements API)

Returns any

outageSummaries

outageSummaries(): any

- Defined in api/ServerMetadata.ts:45
does this server support outage summaries

Returns any

setNodeLocation

setNodeLocation(): any

- Defined in api/ServerMetadata.ts:50
does this server support setting the location on a node

Returns any

toString

toString(): string

- Defined in api/ServerMetadata.ts:76
a human-readable representation of this version

Returns string

Generated using TypeDoc