Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServerMetadata

A class that represents the capabilities an OpenNMS server has and other information about it.

Hierarchy

  • ServerMetadata

Index

Constructors

Properties

Methods

Constructors

constructor

  • 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

  • Can you ack alarms through ReST?

    Returns any

apiVersion

  • apiVersion(): 1 | 2

  • What version of the ReST API does this server support?

    Returns 1 | 2

capabilities

  • capabilities(): object

  • Returs a convenient data structure with all capabilities listed.

    Returns object

    • ackAlarms: any
    • apiVersion: number
    • graphs: any
    • outageSummaries: any
    • setNodeLocation: any
    • type: string

clone

  • Create a new metadata object from this existing one.

    Returns ServerMetadata

graphs

  • graphs(): any

  • Does this server support graphs? (ie, the measurements API)

    Returns any

outageSummaries

  • outageSummaries(): any

  • Does this server support outage summaries?

    Returns any

setNodeLocation

  • setNodeLocation(): any

  • Does this server support setting the location on a node?

    Returns any

toString

  • toString(): string

  • A human-readable representation of the metadata.

    Returns string

Generated using TypeDoc