Class OnmsServer

constructor

• new OnmsServer(serverBuilder: API.OnmsServerBuilder): API.OnmsServer

• Construct a new OnmsServer object representing a remote server.

  Parameters

  • serverBuilder: API.OnmsServerBuilder

  Returns API.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(): API.OnmsServer

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

  Returns API.OnmsServer

equals

• equals(that?: API.OnmsServer): boolean

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

  Parameters

  • Optionalthat: API.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

  Returns any

  A complete URL.

  Parm

  withQuery - Query parameters to be appended to the URL.

toString

• toString(): string

• A string representation of this server suitable for display.

  Returns string

StaticnewBuilder

• newBuilder(url?: string): API.OnmsServerBuilder

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

  Parameters

  • Optionalurl: string

  Returns API.OnmsServerBuilder