Class OnmsServer

constructor

• new OnmsServer(serverBuilder: OnmsServerBuilder): OnmsServer

  Construct a new OnmsServer object representing a remote server.

  Parameters

  • serverBuilder: OnmsServerBuilder

    A builder for the server params, see [[OnmsServerBuilder]]

  Returns OnmsServer

  Example

  provide a pre-existing [[OnmsAuthConfig]] for auth ```javascript const server = new OnmsServer('Test', 'https://myserver/opennms/', auth); ```

Readonlyauth

Readonlyid

Readonlymetadata

Optional Readonlyname

Readonlyurl

host

• get host(): any

  Get the hostname portion of the URL associated with this server.

  Returns any

clone

• clone(): OnmsServer

  Create a new server object from this existing one, with the same ID.

  Returns OnmsServer

equals

• equals(that?: OnmsServer): boolean

  Check whether the provided server has the same settings as this one.

  Parameters

  • Optionalthat: OnmsServer

  Returns boolean

resolveURL

• resolveURL(forFragment?: string, withQuery?: any): any

  Given a relative URL fragment, construct a URL for that fragment on the server.

  Parameters

  • OptionalforFragment: string

    The URL fragment to append to the server URL.

  • OptionalwithQuery: any

    Query parameters to be appended to the URL.

  Returns any

  A complete URL.

toString

• toString(): string

  A string representation of this server suitable for display.

  Returns string

StaticnewBuilder

• newBuilder(url?: string): OnmsServerBuilder

  Create a new builder for an [[OnmsServer]] object.

  Parameters

  • Optionalurl: string

  Returns OnmsServerBuilder