UNPKG

opennms

Version:

Client API for the OpenNMS network monitoring platform

2 lines (1 loc) 14.4 kB
<!DOCTYPE html><html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OpenNMS.js - v2.5.11</title><meta name="description" content="Documentation for OpenNMS.js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><script async src="assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">OpenNMS.js - v2.5.11</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>OpenNMS.js - v2.5.11</h1></div><h2>Hierarchy Summary</h2><ul class="tsd-full-hierarchy"><li data-refl="2"><a id="API.IFilterProcessor" class="tsd-anchor"></a><a href="interfaces/API.IFilterProcessor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>IFilterProcessor</a><ul><li data-refl="1551"><a id="DAO.V1FilterProcessor" class="tsd-anchor"></a><a href="classes/DAO.V1FilterProcessor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>V1FilterProcessor</a></li><li data-refl="1557"><a id="DAO.V2FilterProcessor" class="tsd-anchor"></a><a href="classes/DAO.V2FilterProcessor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>V2FilterProcessor</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="28"><a id="API.IHasHTTP" class="tsd-anchor"></a><a href="interfaces/API.IHasHTTP.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>IHasHTTP</a><ul><li data-refl="2592"><a id="Client" class="tsd-anchor"></a><a href="classes/Client.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>Client</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="30"><a id="API.IHasUrlValue" class="tsd-anchor"></a><a href="interfaces/API.IHasUrlValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>IHasUrlValue</a><ul><li data-refl="1587"><a id="Model.OnmsAlarm" class="tsd-anchor"></a><a href="classes/Model.OnmsAlarm.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsAlarm</a></li><li data-refl="1629"><a id="Model.OnmsAlarmSummary" class="tsd-anchor"></a><a href="classes/Model.OnmsAlarmSummary.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsAlarmSummary</a></li><li data-refl="1641"><a id="Model.OnmsAlarmType" class="tsd-anchor"></a><a href="classes/Model.OnmsAlarmType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsAlarmType</a></li><li data-refl="1675"><a id="Model.OnmsCategory" class="tsd-anchor"></a><a href="classes/Model.OnmsCategory.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsCategory</a></li><li data-refl="1688"><a id="Model.OnmsCollectType" class="tsd-anchor"></a><a href="classes/Model.OnmsCollectType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsCollectType</a></li><li data-refl="1724"><a id="Model.OnmsEvent" class="tsd-anchor"></a><a href="classes/Model.OnmsEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsEvent</a></li><li data-refl="1795"><a id="Model.OnmsIpInterface" class="tsd-anchor"></a><a href="classes/Model.OnmsIpInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsIpInterface</a></li><li data-refl="1821"><a id="Model.OnmsManagedType" class="tsd-anchor"></a><a href="classes/Model.OnmsManagedType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsManagedType</a></li><li data-refl="1868"><a id="Model.OnmsMonitoredService" class="tsd-anchor"></a><a href="classes/Model.OnmsMonitoredService.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsMonitoredService</a></li><li data-refl="1888"><a id="Model.OnmsNode" class="tsd-anchor"></a><a href="classes/Model.OnmsNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsNode</a></li><li data-refl="1919"><a id="Model.OnmsNodeLabelSource" class="tsd-anchor"></a><a href="classes/Model.OnmsNodeLabelSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsNodeLabelSource</a></li><li data-refl="1955"><a id="Model.OnmsNodeType" class="tsd-anchor"></a><a href="classes/Model.OnmsNodeType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsNodeType</a></li><li data-refl="1988"><a id="Model.OnmsOutage" class="tsd-anchor"></a><a href="classes/Model.OnmsOutage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsOutage</a></li><li data-refl="2010"><a id="Model.OnmsParm" class="tsd-anchor"></a><a href="classes/Model.OnmsParm.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsParm</a></li><li data-refl="2025"><a id="Model.OnmsPrimaryType" class="tsd-anchor"></a><a href="classes/Model.OnmsPrimaryType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsPrimaryType</a></li><li data-refl="2060"><a id="Model.OnmsServiceStatusType" class="tsd-anchor"></a><a href="classes/Model.OnmsServiceStatusType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsServiceStatusType</a></li><li data-refl="2104"><a id="Model.OnmsServiceType" class="tsd-anchor"></a><a href="classes/Model.OnmsServiceType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsServiceType</a></li><li data-refl="2117"><a id="Model.OnmsSeverity" class="tsd-anchor"></a><a href="classes/Model.OnmsSeverity.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsSeverity</a></li><li data-refl="2154"><a id="Model.OnmsSituationFeedback" class="tsd-anchor"></a><a href="classes/Model.OnmsSituationFeedback.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsSituationFeedback</a></li><li data-refl="2168"><a id="Model.OnmsSituationFeedbackType" class="tsd-anchor"></a><a href="classes/Model.OnmsSituationFeedbackType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsSituationFeedbackType</a></li><li data-refl="2202"><a id="Model.OnmsSnmpInterface" class="tsd-anchor"></a><a href="classes/Model.OnmsSnmpInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsSnmpInterface</a></li><li data-refl="2253"><a id="Model.OnmsSnmpStatusType" class="tsd-anchor"></a><a href="classes/Model.OnmsSnmpStatusType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsSnmpStatusType</a></li><li data-refl="2286"><a id="Model.OnmsTroubleTicketState" class="tsd-anchor"></a><a href="classes/Model.OnmsTroubleTicketState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsTroubleTicketState</a></li><li data-refl="2330"><a id="Model.PhysAddr" class="tsd-anchor"></a><a href="classes/Model.PhysAddr.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>PhysAddr</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="32"><a id="API.IOnmsHTTP" class="tsd-anchor"></a><a href="interfaces/API.IOnmsHTTP.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>IOnmsHTTP</a><ul><li data-refl="2341"><a id="Rest.AbstractHTTP" class="tsd-anchor"></a><a href="classes/Rest.AbstractHTTP.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>AbstractHTTP</a><ul><li data-refl="2409"><a id="Rest.AxiosHTTP" class="tsd-anchor"></a><a href="classes/Rest.AxiosHTTP.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>AxiosHTTP</a></li><li data-refl="2484"><a id="Rest.GrafanaHTTP" class="tsd-anchor"></a><a href="classes/Rest.GrafanaHTTP.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>GrafanaHTTP</a></li></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="155"><a id="API.NestedRestriction" class="tsd-anchor"></a><a href="classes/API.NestedRestriction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>NestedRestriction</a><ul><li data-refl="97"><a id="API.Filter" class="tsd-anchor"></a><a href="classes/API.Filter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>Filter</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="184"><a id="API.OnmsError" class="tsd-anchor"></a><a href="classes/API.OnmsError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsError</a><ul><li data-refl="2567"><a id="Rest.GrafanaError" class="tsd-anchor"></a><a href="classes/Rest.GrafanaError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>GrafanaError</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="1773"><a id="Model.OnmsFlowExporterSummary" class="tsd-anchor"></a><a href="classes/Model.OnmsFlowExporterSummary.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsFlowExporterSummary</a><ul><li data-refl="1764"><a id="Model.OnmsFlowExporter" class="tsd-anchor"></a><a href="classes/Model.OnmsFlowExporter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OnmsFlowExporter</a></li></ul></li></ul></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">OpenNMS.js - v2.5.11</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>