OpManager REST API | OpManager Help

<!doctype html> <html> <head> <title> OpManager REST API | OpManager Help </title> <meta name="description" content="OpManager offers REST APIs for adding and fetching data from OpManager. Using these APIs, you can integrate OpManager with 3rd party IT management/service desk software. Learn more about OpManager REST APIs | OpManager Help "> <meta name="keywords" content="OpManager REST API "> <link rel="canonical" href="https://www.manageengine.com/network-monitoring/help/rest-api-opmanager.html "> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> <meta name="author" content="ManageEngine, communications@manageengine.com"> <meta name="distribution" content="Global"> <meta name="HandheldFriendly" content="True"> <meta name="MobileOptimized" content="320"> <meta name="apple-touch-fullscreen" content="yes"> <meta name="apple-mobile-web-app-capable" content="yes"> <link rel="icon" href="https://www.manageengine.com/favicon.ico"> <link rel="shortcut icon" href="https://www.manageengine.com/favicon.ico"> <link rel="dns-prefetch" href="https://www.manageengine.com/"> <link rel="apple-touch-icon-precomposed" sizes="144x144" href="https://www.manageengine.com/images/v1/apple-touch-icon-144-precomposed.png"> <link rel="apple-touch-icon-precomposed" sizes="114x114" href="https://www.manageengine.com/images/v1/apple-touch-icon-114-precomposed.png"> <link rel="apple-touch-icon-precomposed" sizes="72x72" href="https://www.manageengine.com/images/v1/apple-touch-icon-72-precomposed.png"> <link rel="apple-touch-icon-precomposed" href="https://www.manageengine.com/images/v1/apple-touch-icon-57-precomposed.png">  <link rel="preload" as="style" href="https://www.manageengine.com/css/me-new-v1.css?v2"> <link rel="stylesheet" type="text/css" href="https://www.manageengine.com/css/me-new-v1.css?v2"> <script type="text/javascript" src="https://www.manageengine.com/js/ipcallback-new.js"></script> <link rel="stylesheet" type="text/css" href="/network-monitoring/style/prd-new-style.css"> <link rel="stylesheet" type="text/css" href="/network-monitoring/style/prd-new-style-help.css"> <style> .bcs-container-searchbox {background-color: #e5e5e5; border:0px !important; width:30%;} .srch-div input {background-color: #fff !important;} /* code*/ .head-container label{float: left;margin:5px 10px} .head-container input{width:30%} .bcs-host-div{float: left;width: 83%;background-color: #e5e5e5 !important;height:25px;} .bcs-container-searchbox{position: relative;top: -7px;} .bcs-searchbox{width:400px !important;} .bcs-searchbox-submit{position: relative;right: 43px;transform: scale(0.55);border-radius: 6px;} #bcs-results-div{background-color:#fff;position:relative;} .bcs-searchbox-btn{background-image: url(https://www.manageengine.com/images/me-sprite-new.png);background-position: -224px 480px;width: 15px;background-color: white;height: 16px;cursor: pointer;padding: 0;border: none;transform: scale(1);right:30px;position: relative;vertical-align:middle;} @media screen and (max-width: 760px){ .rel-b10{display:none} } </style> <style> .fed_op { margin-top: 24px; } .fed_op h6 { font-weight: 500; font-size: 16px; margin-bottom: 12px; } .fed_op .input-group { margin-bottom: 16px; } .doc_feedback { border-top: 1px solid #DEDEDF; border-bottom: 1px solid #DEDEDF; padding: 15px 0; box-sizing: border-box; } .doc_feedback * { box-sizing: border-box; } .reporter_details { margin-top: 32px; } .reporter_details input::placeholder { color: #333333; } .reporter_details input:focus, .reporter_details select:focus { outline: unset; -webkit-box-shadow: 0 0 1.5px -0.25px #0090E0; box-shadow: 0 0 1.5px -0.25px #0090E0; border: 1px solid #0090E0; } .input-group.country.select { display: flex; flex-direction: column; } .reporter_details input, .reporter_details select, .doc_feedback .form-fields textarea { border: 1px solid #DEDEDF; outline: none; border-radius: 4px; font-size: 15px; display: inline-block; max-width: 380px; width: 100%; height: 40px; font-weight: 300; padding: 0px 12px; line-height: 1.25; font-family: inherit; -moz-appearance: none; -webkit-appearance: none; appearance: none; margin-bottom: 16px; } .reporter_details select { --form-bg-img: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16'%3e%3cpath fill='none' stroke='%23adb5bd' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='m2 5 6 6 6-6'/%3e%3c/svg%3e"); background-image: var(--form-bg-img), var(--form-bg-icon, none); background-repeat: no-repeat; background-position: right 0.75rem center; background-size: 16px 12px; } .doc_feedback input[type='checkbox'] { margin: 0 8px 0 0; -webkit-appearance: none; -moz-appearance: none; appearance: none; width: 24px; height: 24px; border: 1px solid #c7c7c7; border-radius: 4px; display: -webkit-box; display: -ms-flexbox; display: inline-flex; -webkit-box-align: center; -ms-flex-align: center; align-items: center; -webkit-box-pack: center; -ms-flex-pack: center; justify-content: center; background: #ffffff; } .doc_feedback input[type='checkbox']::before { content: ""; left: -1px; top: -1.5px; position: relative; width: 4.5px; height: 11px; border-style: solid; border-width: 0 2px 2px 0; -webkit-transform: rotate(45deg) scale(0); transform: rotate(45deg) scale(0); -webkit-transition: 120ms -webkit-transform ease-out; transition: 120ms -webkit-transform ease-out; transition: 120ms transform ease-out; transition: 120ms transform ease-out, 120ms -webkit-transform ease-out; } .doc_feedback input[type='checkbox']:checked { background: #0090E0; border-color: #0090E0; color: #ffffff; } .doc_feedback input[type='checkbox']:checked::before { -webkit-transform: rotate(45deg) scale(1); transform: rotate(45deg) scale(1); } .doc_feedback .input-group label { display: inline-block; user-select: none; font-size: 1rem; vertical-align: middle; } .doc_feedback input[type='radio'] { margin: 0 8px 0 0; -webkit-appearance: none; -moz-appearance: none; appearance: none; width: 24px; height: 24px; border: 1px solid #DEDEDF; border-radius: 32px; display: -webkit-box; display: -ms-flexbox; display: inline-flex; -webkit-box-align: center; -ms-flex-align: center; align-items: center; -webkit-box-pack: center; -ms-flex-pack: center; justify-content: center; } .doc_feedback input[type='radio']::before { content: ""; width: 15px; height: 15px; border-radius: 32px; -webkit-transform: scale(0); transform: scale(0); -webkit-transition: 120ms -webkit-transform ease-out; transition: 120ms -webkit-transform ease-out; transition: 120ms transform ease-out; transition: 120ms transform ease-out, 120ms -webkit-transform ease-out; -webkit-box-shadow: inset 15px 15px #0090E0; box-shadow: inset 15px 15px #0090E0; } .doc_feedback input[type='radio']:checked::before { -webkit-transform: scale(1); transform: scale(1); border-color: #0090E0; } .doc_feedback input[type='radio']:checked { border-color: #0090E0; } .doc_feedback .feed_dec label { margin-right: 18px; } .doc_feedback .form-fields input[type="checkbox"]~label { transform: none; pointer-events: all; } #meGDPRMessage label, div#formCTAgdpr, div[data-clickgdpr="formCTAgdpr"] { max-width: 380px !important; text-align: left; color: #333; font-size: 12.5px; line-height: 1.5; } #meGDPRMessage { width: 100%; margin: 0; text-align: left; } #meGDPRMessage .checkmarkgdpr { height: 18px !important; width: 18px !important; border: 1px solid #ddd; margin-right: 5px !important; border-radius: 4px !important; bottom: -4px; } #meGDPRMessage .checkmarkgdpr.enableCheckgdpr:before { width: 4px !important; height: 8px !important; top: 2px !important; left: 5px !important; } .doc_feedback .form-fields textarea { border: 1px solid #ccc; padding: 12px; height: auto; margin: 0; } .doc_feedback .useful p, .doc_feedback .not-useful p, .quest { font-weight: 500; font-size: 18px; margin-bottom: 16px; display: block; } .doc_feedback input[type="submit"] { display: inline-block; background-color: #E80E19; -webkit-appearance: none; appearance: none; padding: 12px 24px; border: 0; color: #fff; border-radius: 4px; cursor: pointer; font-weight: 500; font-size: 16px; font-family: inherit; margin: 24px 0; } .doc_feedback .useful p { color: #000 !important; } .doc_feedback .useful p:before { content: ''; display: inline-block; width: 23px; height: 23px; margin-right: 10px; background-image: url('https://www.manageengine.com/products/desktop-central/help/images/like-icon.png'); background-size: contain; vertical-align: top; } .doc_feedback .not-useful p:before { content: ''; display: inline-block; width: 23px; height: 23px; margin-right: 10px; background-image: url('https://www.manageengine.com/products/desktop-central/help/images/sad-icon.png'); background-size: contain; vertical-align: top; } .doc_feedback .ans { margin: 8px 0; } .doc_feedback .ans input { display: inline-block; -webkit-appearance: none; appearance: none; width: 100px; border: 0; background-color: #eaeaea; line-height: 40px; border-radius: 4px; font-size: 14px; cursor: pointer; font-size: 16px; margin-right: 8px; } .doc_feedback .ans input:focus { outline: none; } .doc_feedback .ans input:hover { background-color: #006DEB; color: #fff; } .doc_feedback .input-group.fed_op label { transform: none !important; color: #000 !important; pointer-events: all; } .doc_feedback .input-group.fed_op .input-group { display: flex; align-items: baseline; } .doc_feedback .input-group.fed_op .input-group input { max-width: 20px; margin: 10px 5px 10px 0 !important; } .doc_feedback .input-group.fed_op .input-group label { font-size: 14px !important; } .doc_feedback .input-group.fed_op .input-group.feed_dec { display: none; border-top: 1px dashed #eee; border-bottom: 1px dashed #eee; margin: 14px 0; padding: 12px 0; } .doc_feedback .feed_dec { margin-top: 32px; } .doc_feedback .input-group.fed_op .input-group.feed_dec.active { display: block; } .doc_feedback .input-group.fed_op .input-group.feed_dec .flex { display: flex; align-items: center; } .doc_feedback .input-group.fed_op .input-group.feed_dec .flex label { transform: none !important; width: auto; margin: 0 10px 0 0; } .doc_feedback .input-group.fed_op .input-group.feed_dec .flex input { width: auto !important; display: inline-block; vertical-align: top; } </style> <link rel="stylesheet" href="/network-monitoring/style/opm-api.css"> <style> .new-container{max-width:1400px} .divTableCell{word-break:break-all} .scroll-parent, .scroll-topic{display:none} ul.api-tree li > ul li a:after, ul.api-tree li > ul li a:hover:after, ul.api-tree li > ul li a.active:after { content: ""; background: #fff; } ul.api-tree li a, ul.api-tree li a:hover{border-left:none} .yellow-box1 code{vertical-align: middle;} .yellow-box1{ overflow: scroll; height: 120px; background: #F0F2DA; border: 1px solid #ddd; padding: 2%; margin: 20px 0; font-size: 12px; word-break:break-all } .mod-title {margin:0 !important;padding-top:15px;} .div-ct code {font-family:'ZohoPuvi',sans-serif;} .div-ct h1 {margin:0;border-bottom:1px solid #eaeaea;} .wrap-txt{ word-break:unset;width:auto} .showAPIdiv {padding: 5px 0;color: #2571bf;cursor: pointer;text-decoration:underline;margin-top:15px;font-size:16px;font-weight:700;float:left;display:none;} ul.api-tree li a.active {font-size:15px;pointer-events:none} .ct-small {height: 45px;overflow:hidden;} .ct-small h1 {margin:0;} .api-content-main{ width:98%;margin:0;} /*.api-content-main p{ width:90%}*/ .divTable{ width:100%} .heading-menu{ display:block} /*h1{ margin-top:20px}*/ #VideosAndLogos, .opmRelPrd{ display:none !important} .div-tree{ margin-top: 0;height: auto;margin-bottom: 40px; top:0;position:relative;border-right:1px dashed #DDD;padding-right:20px;} /*div#api-content{ width:90%}*/ .divTableCell:nth-child(2){ width:60%} .rhs-cont ul{ padding:0; list-style-type:none} .rhs-cont ul li{ padding:0; list-style-type:none} .rhs-cont{} .rhs-cont{ width:100%; border:none; border-left:solid 1px #fff; padding:30px 0 0px 0} .lhs-tree{ display:none} .rhs-cont{ width:100%} .tb_button{ padding:1px; cursor:pointer; border-right:1px solid #8b8b8b; border-left:1px solid #FFF; border-bottom:1px solid #fff} .tb_button.hover{ border:2px outset #def; background-color:#f8f8f8 !important} .ws_toolbar{ z-index:100000} .ws_toolbar .ws_tb_btn{ cursor:pointer; border:1px solid #555; padding:3px} .tb_highlight{ background-color:yellow} .tb_hide{ visibility:hidden} .ws_toolbar img{ padding:2px; margin:0px} header+section{ display:none; margin:0; padding:0} ul.api-tree li>ul li{ padding-top:0; padding-bottom:0;border-bottom:1px solid #efefef;} ul.api-tree li>ul li:first-child{ padding-top:5px} /*New CSS */ ul.api-tree li a{cursor: pointer;user-select: none;font-size:14px;} /*ul.api-tree > li > a{display: block;background-color: #f2f2f2;padding: 4px 24px 4px 16px;border-radius: 4px;border-left: 4px solid transparent;transition:all .3s ease-in-out;}*/ ul.api-tree > li > a{display: block;background-color: #fff;padding: 6px 10px;border-radius: 0;transition:all .3s ease-in-out;border-bottom:1px solid #efefef;} ul.api-tree > li > a:hover {color:#119521;background:#f8f8f8;} ul.api-tree > li.active > a{color: #119521;font-weight: bold;background:#f3f3f3;pointer-events:none} ul.api-tree > li.has-child.active > .nav-links,ul.api-tree > li.has-child.open > .nav-links{display: block;} ul.api-tree > li.has-child > .nav-links a {padding: 6px 8px 6px 24px;display: block;position: relative;overflow-wrap: break-word;} ul.api-tree > li.has-child > .nav-links a.active {color: #167d23;font-weight:400;pointer-events: none} ul.api-tree > li.has-child > .nav-links a::before {content: ''; position: absolute;border-radius: 50%;width: 5px;height: 5px;background-color: #e6e6e6;top: 15px;left: 5px;} ul.api-tree > li.has-child > .nav-links a.active::before {content: '';background-color: #167d23;} ul.api-tree > li.has-child{position: relative;} ul.api-tree li > ul li a:hover {color:#167d23;} ul.api-tree > li.has-child::before{position: absolute;content:''; top: 14px;right: 15px;border: 5px solid transparent;border-top-color: #FF8134;} .toggle-menu{content: '';position: absolute;height: auto;width: 30px;top: 4px;right: 0;cursor: pointer;border-radius: 0 4px 4px 0;} /*.toggle-menu:hover {background: #0000001c;z-index: 1;background-blend-mode: multiply;}*/ #api-content > .scroll-parent {display:none;} #api-content > .scroll-parent:nth-child(1){display:block;} @media screen and (max-width:1028px){ .div-ct {position:relative;top:0;height:auto;font-size:14px;word-break: break-word;} } @media screen and (max-width:960px){ .div-tree {display:block;min-width:auto;} } @media screen and (max-width:600px){ .flex-con{display: block} } </style> </head><body> <div class="pop-box"> </div><div class="pop-container"> </div> <header> <div id="commonHeader"> <div id="header-topsec"> </div> <div class="" id="MEmobPanel"> <div id="MEdropPanels"></div> </div> <div id="header-mainsec"> <div class="headerinner"> <div class="clearfix head-container"> <div class="fl prdLogo"> <a class="opmlogosvg fl" href="/network-monitoring/"><img title="Network Monitoring Software - ManageEngine OpManager" alt="Network Monitoring Software - ManageEngine OpManager" src="https://www.manageengine.com/images/logo/opmanager.svg"/></a> <div class="divhelptxt fl"><a href="/network-monitoring/help/">Help</a></div> </div> <div class="fr"> <nav>  <div class="fr pr rel-b10"> <ul class="navul clearfix" itemscope="itemscope" itemtype="http://www.schema.org/SiteNavigationElement"> <li id="demo"><a title="Demo - ManageEngine OpManager" href="https://www.manageengine.com/network-monitoring/demo-form.html?help">Demo</a></li> <li id="quote"><a title="Get Quote - ManageEngine OpManager" href="https://www.manageengine.com/network-monitoring/get-quote.html?help">Get Quote</a></li> </ul> </div> </nav> </div> <div class="menuIcon menu2ResBlk" id="MEmobile"><span class="s-icon icon-s-menu"> </span></div> </div> </div> <div class="srch-div"> <div class="head-container"> <label id="lblHelp">We're here to help</label> <form action="https://www.manageengine.com/network-monitoring/help/search-results.html"> <input class="search-field box" name="query" placeholder="Enter search term" type="text" id="hockey_v1-query"> <button type="button" class="bcs-searchbox-btn"></button> </form> </div> </div> </div> </div> </header> <section> </section>  <div class="promotion-top-banner" id="promotion-top-banner"> <span>ManageEngine recognized in the 2024 Gartner® Magic Quadrant™ for Digital Experience Monitoring.</span> <a target="_blank" href="https://www.manageengine.com/itom/gartner-magic-quadrant-dem.html?mq-opm-help" class="btn-text">Get the full report</a> <span class="promotion-close-btn"></span> </div>  <section> <div class="container clearfix new-container" id="scroll"> <div class="help lhs-tree"> <div id="lefttree" class="lefttree hdltmenus"> <ul id="lhsTree" class="helpTree"> </ul> </div> </div> <div class="rhs-cont"> <div class="clearfix" id="api-con"> <div class="container" id="home"> <div class="flex-con"> <div class="div-tree" id="scroll-nav"> <div class="row"> <ul class="api-tree"> <li><a href="#GettingStarted" rel="#GettingStarted">GettingStarted</a></li> <li class="has-child"><a href="#Alarms" rel="#Alarms">Alarms </a> <div class="toggle-menu"> </div> <ul class="nav-links"> <li><a href="#listAlarms" rel="#listAlarms">listAlarms</a></li> <li><a href="#alarmProperties" rel="#alarmProperties">alarmProperties</a></li> <li><a href="#addNotes" rel="#addNotes">addNotes</a></li> <li><a href="#acknowledgeAlarm" rel="#acknowledgeAlarm">acknowledgeAlarm</a></li> <li><a href="#unAcknowledgeAlarm" rel="#unAcknowledgeAlarm">unAcknowledgeAlarm</a></li> <li><a href="#clearAlarm" rel="#clearAlarm">clearAlarm</a></li> <li><a href="#deleteAlarm" rel="#deleteAlarm">deleteAlarm</a></li> <li><a href="#getTopDevicesByAlarms" rel="#getTopDevicesByAlarms">getTopDevicesByAlarms</a></li> <li><a href="#getAnnotation" rel="#getAnnotation">getAnnotation</a></li> </ul> </li> <li class="has-child"><a href="#Availability" rel="#Availability">Availability </a> <div class="toggle-menu"> </div> <ul class="nav-links"> <li><a href="#getPingResponse" rel="#getPingResponse">getPingResponse</a></li> <li><a href="#getTraceResponse" rel="#getTraceResponse">getTraceResponse</a></li> <li><a href="#getDownDevices" rel="#getDownDevices">getDownDevices</a></li> <li><a href="#getAvailabilityGraphData" rel="#getAvailabilityGraphData">getAvailabilityGraphData</a></li> <li><a href="#listDownTimeSchedules" rel="#listDownTimeSchedules">listDownTimeSchedules</a></li> <li><a href="#addDowntimeSchedule" rel="#addDowntimeSchedule">addDowntimeSchedule</a></li> <li><a href="#updateDowntimeSchedule" rel="#updateDowntimeSchedule">updateDowntimeSchedule</a></li> <li><a href="#getDowntimeSchedule" rel="#getDowntimeSchedule">getDowntimeSchedule</a></li> <li><a href="#setManaged" rel="#setManaged">setManaged</a></li> </ul> </li> <li class="has-child"><a href="#Business-Views" rel="#Business-Views">Business views </a> <div class="toggle-menu"> </div> <ul class="nav-links"> <li><a href="#getBusinessView" rel="#getBusinessView">getBusinessView</a></li> <li><a href="#getBusinessDetailsView" rel="#getBusinessDetailsView">getBusinessDetailsView</a></li> </ul> </li> <li class="has-child"><a href="#Dashboard" rel="#Dashboard">Dashboard </a> <div class="toggle-menu"> </div> <ul class="nav-links"> <li><a href="#getWidgetData" rel="#getWidgetData">getWidgetData</a></li> <li><a href="#getWidgetList" rel="#getWidgetList">getWidgetList</a></li> </ul> </li> <li class="has-child"><a href="#Devices" rel="#Devices">Devices </a> <div class="toggle-menu"> </div> <ul class="nav-links"> <li><a href="#listDevices" rel="#listDevices">listDevices</a></li> <li><a href="#getDeviceInfo" rel="#getDeviceInfo">getDeviceInfo</a></li> <li><a href="#setDeviceInfo" rel="#setDeviceInfo">setDeviceInfo</a></li> <li><a href="#getDeviceNotes" rel="#getDeviceNotes">getDeviceNotes</a></li> <li><a href="#getInfrastructureDetailsView" rel="#getInfrastructureDetailsView">getInfrastructureDetailsView</a></li> <li><a href="#getDeviceSummary" rel="#getDeviceSummary">getDeviceSummary</a></li> <li><a href="#getDeviceCompleteDetails" rel="#getDeviceCompleteDetails">getDeviceCompleteDetails</a></li> <li><a href="#listVirtualDevices" rel="#listVirtualDevices">listVirtualDevices</a></li> <li><a href="#getVMWareHosts" rel="#getVMWareHosts">getVMWareHosts</a></li> <li><a href="#getDataCenterDetails" rel="#getDataCenterDetails">getDataCenterDetails</a></li> <li><a href="#getClusterDetails" rel="#getClusterDetails">getClusterDetails</a></li> <li><a href="#getVMWareVMs" rel="#getVMWareVMs">getVMWareVMs</a></li> <li><a href="#getVMWareDataStores" rel="#getVMWareDataStores">getVMWareDataStores</a></li> <li><a href="#getNutanixVDisks" rel="#getNutanixVDisks">getNutanixVDisks</a></li> <li><a href="#getNutanixDetails" rel="#getNutanixDetails">getNutanixDetails</a></li> </ul> </li> <li><a href="#Discovery" rel="#Discovery">Discovery</a></li> <li><a href="#Enterprise" rel="#Enterprise">Enterprise</a></li> <li class="has-child"><a href="#Events" rel="#Events">Events</a> <div class="toggle-menu"> </div> <ul class="nav-links"> <li><a href="#listEvents" rel="#listEvents">listEvents</a></li> <li><a href="#addEvent" rel="#addEvent">addEvent</a></li> </ul> </li> <li class="has-child"><a href="#Groups" rel="#Groups">Groups </a> <div class="toggle-menu"> </div> <ul class="nav-links"> <li><a href="#listAllLogicalGroups" rel="#listAllLogicalGroups">listAllLogicalGroups</a></li> <li><a href="#getLogicalGroupInfo" rel="#getLogicalGroupInfo">getLogicalGroupInfo</a></li> <li><a href="#getLogicalGroupAlerts" rel="#getLogicalGroupAlerts">getLogicalGroupAlerts</a></li> <li><a href="#listLogicalGroupMembers" rel="#listLogicalGroupMembers">listLogicalGroupMembers</a></li> <li><a href="#addToGroup" rel="#addToGroup">addToGroup</a></li> </ul> </li> <li class="has-child"><a href="#Interfaces" rel="#Interfaces">Interfaces </a> <div class="toggle-menu"> </div> <ul class="nav-links"> <li><a href="#listInterfaces" rel="#listInterfaces">listInterfaces</a></li> <li><a href="#getInterfaceSummary" rel="#getInterfaceSummary">getInterfaceSummary</a></li> <li><a href="#getIntfAtAGlanceReportDetails" rel="#getIntfAtAGlanceReportDetails">getIntfAtAGlanceReportDetails</a></li> <li><a href="#getIntfBWOutageReportDetails" rel="#getIntfBWOutageReportDetails">getIntfBWOutageReportDetails</a></li> <li><a href="#getInterfaces" rel="#getInterfaces">getInterfaces</a></li> <li><a href="#getInterfaceNotes" rel="#getInterfaceNotes">getInterfaceNotes</a></li> <li><a href="#getInterfaceGraphs" rel="#getInterfaceGraphs">getInterfaceGraphs</a></li> </ul> </li> <li class="has-child"><a href="#Monitoring" rel="#Monitoring">Monitoring </a> <div class="toggle-menu"> </div> <ul class="nav-links"> <li><a href="#getDeviceAssociatedMonitors" rel="#getDeviceAssociatedMonitors">getDeviceAssociatedMonitors</a></li> <li><a href="#getPerformanceMonitors" rel="#getPerformanceMonitors">getPerformanceMonitors</a></li> <li><a href="#getPerformanceMonitorDetails" rel="#getPerformanceMonitorDetails">getPerformanceMonitorDetails</a></li> <li><a href="#addPerformanceMonitors" rel="#addPerformanceMonitors">addPerformanceMonitors</a></li> <li><a href="#deletePerformanceMonitors" rel="#deletePerformanceMonitors">deletePerformanceMonitors</a></li> <li><a href="#TestMonitor" rel="#TestMonitor">TestMonitor</a></li> <li><a href="#getAssociatedProcessMonitors" rel="#getAssociatedProcessMonitors">getAssociatedProcessMonitors</a></li> <li><a href="#associateProcessMonitor" rel="#associateProcessMonitor">associateProcessMonitor</a></li> <li><a href="#getAssociatedServiceMonitors" rel="#getAssociatedServiceMonitors">getAssociatedServiceMonitors</a></li> <li><a href="#associateServiceMonitor" rel="#associateServiceMonitor">associateServiceMonitor</a></li> <li><a href="#getDeviceAssociatedWindowsServiceMonitors" rel="#getDeviceAssociatedWindowsServiceMonitors">getDeviceAssociatedWindowsServiceMonitors</a></li> <li><a href="#listURLMonitors" rel="#listURLMonitors">listURLMonitors</a></li> <li><a href="#listAllDevicesSpecificURLs" rel="#listAllDevicesSpecificURLs">listAllDevicesSpecificURLs</a></li> <li><a href="#listScriptMonitors" rel="#listScriptMonitors">listScriptMonitors</a></li> </ul> </li> <li class="has-child"><a href="#Notifications" rel="#Notifications">Notifications </a> <div class="toggle-menu"> </div> <ul class="nav-links"> <li><a href="#listNotificationProfiles" rel="#listNotificationProfiles">listNotificationProfiles</a></li> <li><a href="#associateNotificationProfiles" rel="#associateNotificationProfiles">associateNotificationProfiles</a></li> <li><a href="#updateNotificationProfileStatus" rel="#updateNotificationProfileStatus">updateNotificationProfileStatus</a></li> <li><a href="#getNotificationProfileS" rel="#getNotificationProfileS">getNotificationProfiles</a></li> </ul> </li> <li class="has-child"><a href="#Reports" rel="#Reports">Reports </a> <div class="toggle-menu"> </div> <ul class="nav-links"> <li><a href="#getAdvancedReportData" rel="#getAdvancedReportData">getAdvancedReportData</a></li> <li><a href="#getReportsList" rel="#getReportsList">getReportsList</a></li> <li><a href="#getReportsData" rel="#getReportsData">getReportsData</a></li> <li><a href="#getReportData" rel="#getReportData">getReportData</a></li> <li><a href="#listAllAdvancedReports" rel="#listAllAdvancedReports">listAllAdvancedReports</a></li> </ul> </li> <li class="has-child"><a href="#Settings" rel="#Settings">Settings </a> <div class="toggle-menu"> </div> <ul class="nav-links"> <li><a href="#getCategoryList" rel="#getCategoryList">getCategoryList</a></li> </ul> </li> <li><a href="#Subnets" rel="#Subnets">Subnets</a></li> <li class="has-child"><a href="#Wireless" rel="#Wireless">Wireless </a> <div class="toggle-menu"> </div> <ul class="nav-links"> <li><a href="#getWirelessNetworkDetails" rel="#getWirelessNetworkDetails">getWirelessNetworkDetails</a></li> <li><a href="#getWirelessAPList" rel="#getWirelessAPList">getWirelessAPList</a></li> <li><a href="#getSSIDClientList" rel="#getSSIDClientList">getSSIDClientList</a></li> <li><a href="#getClientDetails" rel="#getClientDetails">getClientDetails</a></li> </ul> </li> </ul> </div> </div> <div class="div-ct"> <div id="api-content"> <div id="GettingStarted" class="scroll-parent"> <div id="Getting-Started" class="scroll-topic"> <h1>OpManager REST API</h1> <div class="api-content-main"> <p>OpManager offers REST APIs for adding and fetching data from OpManager. Using these APIs, you can integrate OpManager with 3rd party IT management/service desk software.</p> <h3>How OpManager REST APIs work?</h3> <p>The APIs work with an API key. The API key is unique for each OpManager account and is mandatory for all API requests. <a href="#enable">Learn how to enable or disable Rest API keys</a></p> <h3>How to view an API Key?</h3> <p>To view or copy an API key, go to Quick links > Rest API Key option in OpManager web client.(The quick link option is the Gear icon on the top right corner)</p> <h3>How to send an apiKey?</h3> <p>The functionality of request parameter-based apiKey authentication has been deprecated. Before version, 128100, the apiKey can be sent via the request parameter. From version 128100, the apiKey can now be sent either in the request header or as a request parameter.</p> <p class="yellowbox"><b>Note: </b>The support for request parameter based apiKey authentication will be ended soon. The following list of URLs should be called with apiKey only via the request header. ApiKey authentication based on request parameters will not work for these URLs.</p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">API</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/alarm/listAlarms</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/admin/addLinuxCredential</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/discovery/addDiscoveryProfile</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/discovery/editDiscoveryProfile</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/v2/discovery/addDiscoveryProfile</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/v2/discovery/editDiscoveryProfile</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/ncmsettings/importSSHKey</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/ncmsettings/importDevices</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/ncmsettings/uploadConfigletFile</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/ncmsettings/uploadConfigletPreView</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/ncmsettings/importConfiglets</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/ncmdevice/updateHostNamefromFileImp</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/ncmdevice/editCustomColfromFileImp</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/ncmdevice/importDG</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/ipam/addSubnet</b></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>/api/json/spm/addSwitch</b></div> </div> </div> </div> <br /> <p><b>A Sample configuration with header:</b> <img src="/network-monitoring/help/images/restapi.png" alt="api_header" /></p> <h2 id="enable">Enable / Disable Rest API access</h2> <p>From version 127131, the option to enable/disable Rest API has been added.</p> <h3>What has changed?</h3> <ul> <li>Rest API access will be disabled by default for the new users created under User Management. An administrator with complete access to all the modules and devices will be able to edit the user under User Management and provide Rest API access if required.</li> <p><img src="/network-monitoring/help/images/enable-api-1.png" alt="enable-api-1" /></p> <li>If the RestApikey access has been enabled for the users, Rest API menu under Quick links will display the RestApikey, and external Rest API calls will be allowed only if the Rest API access has been enabled for the user.</li> <p><img src="/network-monitoring/help/images/enable-api-2.png" alt="enable-api-2" /></p> <li>If the Rest API access has been disabled, the Rest API menu under Quick links will display "Contact the administrator user".</li> <p><img src="/network-monitoring/help/images/enable-api-3.png" alt="enable-api-3" /></p> </ul> <div class="yellowbox"> <p><strong>Note:</strong></p> <p><strong>Enterprise edition user sync:</strong> The Rest API access will not be synced for users from Central to Probe servers. The synced users in Probes will not have permanent Rest API access. Whereas, for the users created in the Probe server, the Rest API access can be updated as required.</p> <p><strong>TFA:</strong> If Two-Factor Authentication has been configured, TFA OTP validation is mandatory to enable Rest API access.</p> <p><strong>Regenerate an API key:</strong>To generate an API key, go to Settings > Basic Settings > REST API in OpManager web client and click on Regenerate Key.</p> </div> </div> </div> </div> <div id="Alarms" class="scroll-parent"> <h1>Alarms</h1> <div id="listAlarms" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">listAlarms</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the alarms generated in OpManager.</p> <p class="yellow-box1"><b>Sample URL: </b><code class="wrap-txt">http://localhost:8060/api/json/alarm/listAlarms?apiKey=********&deviceName=test1.zoho.com&severity=1&category=Device_Category&entity=sample_entity&alertType=ActiveAlarms&fromTime=2022-05-02 08:00:00&toTime=2022-06-02 18:30:00</code></p> <p class="yellow-box1"><b>Sample Response: </b><code> [{"severity":"<img src='/images/devices/status3.gif'> Attention","numericSeverity":3,"severityString":"Attention","statusStr":"Attention","displayName":"opm-server1","message":"CPU Utilization is 0%, threshold value for this monitor is 4%: Top 3 Processes:-MEEDRInferenceEngine - 1.299%;svchost#42 - 0.812%;WmiPrvSE#3 - 0.65%","deviceName":"opm-server1","statusNum":3,"modTimeLong":1709902027793,"modTime":"8 Mar 2024 06:17:07 PM IST","alarmId":"1","category":"Desktop","entity":"3_CPUUSAGE","status":3,"who":"Unacknowledged"},{"severity":"<img alt="" src="/images/devices/status1.gif" /> Critical","numericSeverity":1,"severityString":"Critical","statusStr":"Critical","displayName":"opm-server1","message":"Disk Utilization is 54%, threshold value for this monitor is 6%","deviceName":"opm-server1","statusNum":1,"modTimeLong":1709875112703,"modTime":"8 Mar 2024 10:48:32 AM IST","alarmId":"3","category":"Desktop","entity":"5_DiskUtilization","status":1,"who":"Unacknowledged"},{"severity":"<img src='/images/devices/status2.gif'> Trouble","numericSeverity":2,"severityString":"Trouble","statusStr":"Trouble","displayName":"opm-server1","message":"IO Read and Write Rate is 1258 Operations/Sec, threshold value for this monitor is 5 Operations/Sec","deviceName":"opm-server1","statusNum":2,"modTimeLong":1709875109126,"modTime":"8 Mar 2024 10:48:29 AM IST","alarmId":"2","category":"Desktop","entity":"10","status":2,"who":"Unacknowledged"}] </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName</b></div> <div class="divTableCell">Device Name of the alarm. The device name can be taken from the URL of the device snapshot page.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>severity</b></div> <div class="divTableCell">Severity of the alarm. The severity could range anywhere from 1 to 5. <em>1 = Critical, 2 = Trouble, 3 = Attention, 4 = Service Down, 5 = Clear</em>.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>category</b></div> <div class="divTableCell">Device category of the alarm</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>alertType</b></div> <div class="divTableCell">alertType of the alarm. The alert type can be any of the following: <em>ActiveAlarms, EventLogAlarms, SyslogAlarms, TrapAlarms, NCMAlarms, NFAAlarms, WebAlarms, FWAAlarms, StorageAlarms</em>.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>fromTime</b></div> <div class="divTableCell">Start time for the custom time period range. It could be of the format yyyy-mm-dd or yyyy-mm-dd hh:mm:ss. If no time is specified (i.e, yyyy-mm-dd format), the default time will be set to 12 A.M(start of the day).</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>toTime</b></div> <div class="divTableCell">End time for the custom time period range. It could be of the format yyyy-mm-dd or yyyy-mm-dd hh:mm:ss. If no time is specified (i.e, yyyy-mm-dd format), the default time will be set to 12 A.M(start of the day).</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>probeName</b></div> <div class="divTableCell">The name of the Probe. The probe name could be obtained by executing the <a href="#listProbes">listProbes API</a> , where the parameter name in the response refers to the probeName. [Applicable only for Central Server]</div> </div> </div> </div> </div> </div> <div id="alarmProperties" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">alarmProperties</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>To list alarm properties of the particular alarm</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/alarm/alarmProperties?apiKey=***************&entity=sample_entity</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{ "statusStr": "Critical", "displayName": "opm-server1", "PRIORITY": "0", "workflows": [ { "logSeverity": 5, "moDispName": "opm-server1", "logMessage": "Workflow has been executed successfully.", "rbName": "workflow1", "taskList": [ { "logSeverity": 5, "logMessage": "Ping command used was : C:\\WINDOWS\\System32\\ping -n 4 -w 1000 -l 32 127.0.0.1", "logSeverityStr": "Info", "taskName": "Ping Device", "logTimeLong": "2022-10-26 17:34:18.481", "logTime": "26 Oct 2022 05:34:18 PM IST" }, { "logSeverity": 5, "logMessage": "Ping output : \nPinging 127.0.0.1 with 32 bytes of data:\nReply from 127.0.0.1: bytes=32 time<1ms TTL=128\nReply from 127.0.0.1: bytes=32 time<1ms TTL=128\nReply from 127.0.0.1: bytes=32 time<1ms TTL=128\nReply from 127.0.0.1: bytes=32 time<1ms TTL=128\n\nPing statistics for 127.0.0.1:\n Packets: Sent = 4, Received = 4, Lost = 0 (0% loss),\nApproximate round trip times in milli-seconds:\n Minimum = 0ms, Maximum = 0ms, Average = 0ms\n", "logSeverityStr": "Info", "taskName": "Ping Device", "logTimeLong": "2022-10-26 17:34:18.481", "logTime": "26 Oct 2022 05:34:18 PM IST" }, { "logSeverity": 5, "logMessage": "Ping was successful.", "logSeverityStr": "Info", "taskName": "Ping Device", "logTimeLong": "2022-10-26 17:34:18.481", "logTime": "26 Oct 2022 05:34:18 PM IST" } ], "rbID": 301, "moID": 302, "logTime": "26 Oct 2022 05:34:18 PM IST" } ], "source": "opm-server1", "stringseverity": "Critical", "GROUPNAME": "", "strCreateTime": "26 Oct 2022 05:27:50 PM IST", "id": "5", "events": [ { "severity": "Critical", "statusStr": "Critical", "source": "opm-server1", "id": "5", "time": "26 Oct 2022 05:27:50 PM IST", "text": "Disk Utilization is 44%, threshold value for this monitor is 5%", "category": "Desktop", "imgsrc": "/images/devices/status1.gif", "entity": "37_DiskUtilization", "statusNum": "1" } ], "severity": "/images/devices/status1.gif", "WEBNMS": "", "strModTime": "26 Oct 2022 05:27:50 PM IST", "ALARMCODE": "THRESHOLD-DOWN_WMI-DiskUtilization", "message": "Disk Utilization is 44%, threshold value for this monitor is 5%", "previousSeverity": "-1", "priority": "0", "deviceID": 302, "OWNERNAME": "", "statusNum": "1", "MAPNAME": "", "EVENTTYPE": "Threshold Down", "stage": "0", "modTime": "1666785470844", "createTime": "1666785470844", "pollid": "37", "category": "Desktop", "entity": "37_DiskUtilization", "stringpreviousseverity": "", "who": "Unacknowledge" } </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>entity</b></div> <div class="divTableCell">Entity of the alarm</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceID</b></div> <div class="divTableCell">MOID of the alarm</div> </div> </div> </div> </div> </div> <div id="addNotes" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">addNotes</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>This API is used to add notes to an alarm</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/alarm/addNotes?apiKey=***************&entity=sample_entity</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{ "result": { "message": "Successfully Added" } } </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>entity*</b></div> <div class="divTableCell">Entity of the alarm</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>notes*</b></div> <div class="divTableCell">Notes description to be added</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>type</b></div> <div class="divTableCell">To mention whether single or multiple alarms are selected</div> </div> </div> </div> </div> </div> <div id="acknowledgeAlarm" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">acknowledgeAlarm</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>This API is used to acknowledge an alarm</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/alarm/acknowledgeAlarm?apiKey=***************&entity=sample_entity</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{ "result": { "message": "Alarm has been successfully Acknowledged" } } </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>entity*</b></div> <div class="divTableCell">Entity of the alarm</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>type</b></div> <div class="divTableCell">To mention whether single or multiple alarms are selected</div> </div> </div> </div> </div> </div> <div id="unAcknowledgeAlarm" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">unAcknowledgeAlarm</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>This API is used to unacknowledge an alarm</p> <p><b>Sample URL: </b><code class="wrap-txt">http://localhost:8060/api/json/alarm/unAcknowledgeAlarm?apiKey=********&entity=sample_entity</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{ "result": { "message": "Alarm has been successfully UnAcknowledged" } } </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>entity*</b></div> <div class="divTableCell">Entity of the alarm</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>type</b></div> <div class="divTableCell">To mention whether single or multiple alarms are selected</div> </div> </div> </div> </div> </div> <div id="clearAlarm" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">clearAlarm</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>This API is used to clear an Alarm.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/alarm/clearAlarm?apiKey=***************&entity=sample_entity</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{ "result": { "message": "Alarm has been successfully Cleared!" } } </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>entity*</b></div> <div class="divTableCell">Entity of the alarm</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>type</b></div> <div class="divTableCell">To mention whether single alarm or multiple alarms are selected</div> </div> </div> </div> </div> </div> <div id="deleteAlarm" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">deleteAlarm</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>This API is to delete an alarm</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/alarm/deleteAlarm?apiKey=***************&entity=sample_entity</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{ "result": { "message": "Alarm has been successfully Deleted!" } } </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>entity*</b></div> <div class="divTableCell">Entity of the alarm</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>type</b></div> <div class="divTableCell">To mention whether single or multiple alarm is selected</div> </div> </div> </div> </div> </div> <div id="getTopDevicesByAlarms" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getTopDevicesByAlarms</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>This API is to get alarms based on devices</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/alarm/getTopDevicesByAlarms?apiKey=***************&entity=sample_entity</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[ { "ipaddress": "127.0.0.1", "moname": "opm-server1", "devicename": "opm-server1", "alarmcount": 162, "type": "Windows 10", "category": "Desktop", "mapname": "Desktops_Map.netmap", "status": 1 }, { "ipaddress": "127.0.0.1", "moname": "opm-server2", "devicename": "opm-server2", "alarmcount": 2, "type": "Windows 2019", "category": "Server", "mapname": "Servers_Map.netmap", "status": 1 } ] </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>eventType*</b></div> <div class="divTableCell">Event type of the alarm</div> </div> </div> </div> </div> </div> <div id="getAnnotation" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getAnnotation</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>This API is to get notes of the alarms</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/alarm/getAnnotation?apiKey=***************&entity=sample_entity</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[ { "notes": "This is a test note", "modTime": 1666786020066, "noteID": 1, "modTimeStr": "26 Oct 2022 05:37:00 PM IST", "entity": "37_DiskUtilization", "who": "admin" } ] </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>entity*</b></div> <div class="divTableCell">Entity of the alarm</div> </div> </div> </div> </div> </div> </div> <div id="Availability" class="scroll-parent"> <h1>Availability</h1> <div id="getPingResponse" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getPingResponse</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>ICMP/Ping response for the given device.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getPingResponse?apiKey=***************&deviceName=xxx.xxx.xx.x</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"PingResponse":{"Details":"\nPinging 127.0.0.1 with 32 bytes of data:\nReply from 127.0.0.1: bytes=32 time=21ms TTL=251\n\nPing statistics for 127.0.0.1:\n Packets: Sent = 1, Received = 1, Lost = 0 (0% loss),\nApproximate round trip times in milli-seconds:\n Minimum = 21ms, Maximum = 21ms, Average = 21ms\n"}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName*</b></div> <div class="divTableCell">Name of the device - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.</div> </div> </div> </div> </div> </div> <div id="getTraceResponse" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getTraceResponse</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>Trace route command response for the given device</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getTraceResponse?apiKey=***************&deviceName=xxx.xxx.xx.x</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"TraceResponse":{"Details":"\nTracing route to 127.0.0.1 over a maximum of 30 hops\n\n 1 8 ms 9 ms 3 ms 127.0.0.1 \n 2 1 ms 1 ms 1 ms 127.0.0.1 \n 3 20 ms 20 ms 20 ms 127.0.0.1 \n 4 22 ms 21 ms 22 ms 127.0.0.1 \n 5 21 ms 20 ms 20 ms 127.0.0.1 \n\nTrace complete.\n"}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName*</b></div> <div class="divTableCell">Name of the device - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.</div> </div> </div> </div> </div> </div> <div id="getDownDevices" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getDownDevices</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists the devices that are currently in down state and having device status as 'critical'</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/discovery/getDownDevices?apiKey=******************</code></p> <p class="yellow-box1"><b>Sample Response: </b><code> {"DownDevices":{"Details":[{"name":"127.0.0.1","type":"HPSwitch 3900X","category":"Switch","displayName":"SwitchDevice_SP"},{"name":"127.0.0.2","type":"Windows Server 2018","category":"Server","displayName":"AppServer-04"},{"name":"UserPC_Michael","type":"Linux RedHat","category":"Server","displayName":"127.0.0.3"}]}} </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> </div> </div> </div> </div> <div id="getAvailabilityGraphData" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getAvailabilityGraphData</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Fetches the Availability graphs for the given device or interface.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getAvailabilityGraphData?apiKey=******************&isFluidic=true&name=opmserver.mydomain.com</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"uptimeData":{"Today":100,"This week":100,"Last week":99,"Last 30 days":99,"Last month":0,"This month":99,"Last 24 hours":100,"Yesterday":100,"Last 7 days":99,"Last 12 hours":100},"graphData":[{"seriesname":"Up","data":[["Last 12 hours",100],["Today",100],["Last 24 hours",100],["Yesterday",100],["This week",100],["Last 7 days",99.093],["Last week",98.867],["This month",99.269],["Last 30 days",99.093],["Last month",0]]},{"seriesname":"On Maintenance","data":[["Last 12 hours",0],["Today",0],["Last 24 hours",0],["Yesterday",0],["This week",0],["Last 7 days",0],["Last week",0],["This month",0],["Last 30 days",0],["Last month",0]]},{"seriesname":"Dependent Unavailable","data":[["Last 12 hours",0],["Today",0],["Last 24 hours",0],["Yesterday",0],["This week",0],["Last 7 days",0],["Last week",0],["This month",0],["Last 30 days",0],["Last month",0]]},{"seriesname":"On Hold","data":[["Last 12 hours",0],["Today",0],["Last 24 hours",0],["Yesterday",0],["This week",0],["Last 7 days",0],["Last week",0],["This month",0],["Last 30 days",0],["Last month",0]]},{"seriesname":"Down","data":[["Last 12 hours",0],["Today",0],["Last 24 hours",0],["Yesterday",0],["This week",0],["Last 7 days",0],["Last week",0],["This month",0],["Last 30 days",0],["Last month",0]]},{"seriesname":"Not Monitored","data":[["Last 12 hours",0],["Today",0],["Last 24 hours",0],["Yesterday",0],["This week",0],["Last 7 days",0.907],["Last week",1.133],["This month",0.731],["Last 30 days",0.907],["Last month",100]]}]}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>name*</b></div> <div class="divTableCell">Name of the device or interface - Managed Entity name as seen in the URL of device/interface snapshot page OR 'deviceName' property value of listDevices API or 'interfaceName' property value in the listInterfaces API response [Example: opmserver.mydomain.com or IF-xx.xx.24.223-115]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>instance</b></div> <div class="divTableCell">Set instance=Interface if the Availability graph is requested for the interface. Mandatory field if the interface data is being fetched. This API can also be used to fetch availability of other monitors. [Example: Interface|URL|winService|service|process]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>isFluidic*</b></div> <div class="divTableCell">Set value as TRUE by default (for internal purpose)</div> </div> </div> </div> </div> </div> <div id="listDownTimeSchedules" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">listDownTimeSchedules</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Provides the list of downtime schedules created in OpManager.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/admin/listDownTimeSchedules?apiKey=****************</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"name":"Test","id":"1","type":"Once","nextscheduledtime":"Mon, Nov 28, 2022 13:00:00","statusNum":"1","status":"Enabled"}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> </div> </div> </div> </div> <div id="addDowntimeSchedule" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">addDowntimeSchedule</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>Allows you to schedule downtimes for groups and devices.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/admin/addDowntimeSchedule?apiKey=<apikey>&operation=Add&scheduleName=FirmwareUpgrade&status=Enabled&scheduleDesc= <optional>&recurrence=OnceOnly&selectDevicesMethod=Device&once_startat=2024-07-10 00:00&once_endate=2024-07-11 04:00&selectedDevices=172.21.191.167,30.30.30.6,opm-sql</optional> </apikey></code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"result":{"message":"Downtime Scheduler has been added successfully."}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>operation</b></div> <div class="divTableCell">Add (to create new downtime scheduler)</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>scheduleName</b></div> <div class="divTableCell">Name of the schedule (Strig value)</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>status</b></div> <div class="divTableCell">Enabled/Disabled</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>scheduleDesc</b></div> <div class="divTableCell">Downtime scheduler description (Optional)</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>recurrence</b></div> <div class="divTableCell">OnceOnly/Daily</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>selectDevicesMethod </b></div> <div class="divTableCell">Device</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>once_startat </b></div> <div class="divTableCell">Start date & time (applicable only if recurrence is 'OnceOnly')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>once_endate </b></div> <div class="divTableCell">End date & time (applicable only if recurrence is 'OnceOnly')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>daily_effectfrom </b></div> <div class="divTableCell">Downtime scheduler start date & time (applicable only if recurrence is 'Daily')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>from_time </b></div> <div class="divTableCell">Start date & time (applicable only if recurrence is 'Daily')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>to_time </b></div> <div class="divTableCell">End date & time (applicable only if recurrence is 'Daily')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>selectedDevices </b></div> <div class="divTableCell">Device IP (comma-separated values)</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>selectedLogicalGroups</b></div> <div class="divTableCell">Devices Group name (comma-separated values)</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>mailID </b></div> <div class="divTableCell">Email id to which the report should be sent</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>recurrence</b></div> <div class="divTableCell">Once | Daily | Weekly | Monthly</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>selectDevicesMethod</b></div> <div class="divTableCell">Device | Category | BV | URL</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>selectedCateg</b></div> <div class="divTableCell">Device category (applicable only if selectDevicesMethod is 'Category')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>selectedBV</b></div> <div class="divTableCell">Business view name suffixed with '_bv' (applicable only if selectDevicesMethod is 'Business View')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>selectedURL</b></div> <div class="divTableCell">URL Monitor name (applicable only if selectDevicesMethod is 'URLs')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>monthlyType</b></div> <div class="divTableCell">monthlyDate | monthlyDay (applicable only if recurrence is 'Monthly')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>startday</b></div> <div class="divTableCell">Start day of the week (applicable only for Daily)</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>endday</b></div> <div class="divTableCell">End day of the week (applicable only for Daily)</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>weekday</b></div> <div class="divTableCell">Day of the week (applicable only if recurrence is 'Monthly' and monthlyType is 'monthlyDay')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>from_time</b></div> <div class="divTableCell">Start date & time (applicable only if recurrence is 'Daily')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>to_time</b></div> <div class="divTableCell">End date & time (applicable only if recurrence is 'Daily')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>from_hrs</b></div> <div class="divTableCell">Start hour (applicable only if recurrence is 'Monthly')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>to_hrs</b></div> <div class="divTableCell">End hour (applicable only if recurrence is 'Monthly')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>from_mins</b></div> <div class="divTableCell">Start Minutes (applicable only if recurrence is 'Monthly')</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>to_mins</b></div> <div class="divTableCell">End minutes (applicable only if recurrence is 'Monthly')</div> </div> </div> </div> </div> </div> <div id="updateDowntimeSchedule" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">updateDowntimeSchedule</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>Used to update downtime schedule.</p> <p><b>Sample URL: </b><code class="wrap-txt">http://localhost/api/json/admin/updateDowntimeSchedule?operation=Edit&MS_INSTANCEID=14&scheduleId=14</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"name":"Test","id":"1","type":"Once","nextscheduledtime":"Mon, Nov 28, 2022 13:00:00","statusNum":"1","status":"Enabled"}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>operation</b></div> <div class="divTableCell">Edit will be sent by default (Edit).</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>MS_INSTANCEID</b></div> <div class="divTableCell">Downtime scheduler ID.</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>scheduleId</b></div> <div class="divTableCell">Downtime scheduler ID.</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>scheduleName</b></div> <div class="divTableCell">Downtime scheduler name.</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>status</b></div> <div class="divTableCell">Status will be set as Enabled by default.</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>scheduleDesc</b></div> <div class="divTableCell">Downtime scheduler description.</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>recurrence</b></div> <div class="divTableCell">Downtime frequency (OnceOnly | Daily | Weekly | Monthly).</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>selectDevicesMethod</b></div> <div class="divTableCell">Filter by option (Category | BV | Device | URL | GROUP).</div> </div> </div> </div> </div> </div> <div id="getDowntimeSchedule" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getDowntimeSchedule</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Used to get the downtime scheduler details</p> <p><b>Sample URL: </b><code class="wrap-txt">http://localhost/api/json/admin/getDowntimeSchedule?scheduleName=test&_=1564738493372</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"name":"Test","id":"1","type":"Once","nextscheduledtime":"Mon, Nov 28, 2022 13:00:00","statusNum":"1","status":"Enabled"}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>operation</b></div> <div class="divTableCell">Downtime scheduler name</div> </div> </div> </div> </div> </div> <div id="setManaged" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">setManaged</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>Manage or Unmanage the devices,interfaces or URL monitors that are currently added in OpManager.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/setManaged?manage=true&apiKey=***************</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"result":{"message":"Device is being managed."}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>manage*</b></div> <div class="divTableCell">Enables monitoring of devices or interfaces if manage=true, disables monitoring if manage=false</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>name*</b></div> <div class="divTableCell">Name of the device or interface. (Managed Entity name as seen in the URL of device/interface snapshot page OR 'deviceName' property value in the listDevices API response)</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>type</b></div> <div class="divTableCell">Set type as 'INTERFACE' if the managed entity is an interface. Set type as 'URL' if the managed entity is an Url monitor.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>isInterface</b></div> <div class="divTableCell">This parameter will take effect only when the value 'INTERFACE' is supplied to <b>type</b> param. Set the value for this param as 'true' if the managed entity is an interface. By default, the entity will be assumed as device, hence it is not required to pass this parameter for managing device.</div> </div> </div> </div> </div> </div> </div> <div id="Business-Views" class="scroll-parent"> <h1>Business views</h1> <div id="getBusinessView" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getBusinessView</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the business views created in OpManager.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/businessview/getBusinessView?apiKey=***************</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"BusinessView":{"Details":[{"name":"New BusinessView_bv","total":"3","error":"0","displayName":"New BusinessView","status":"5","alarms":"0"}]}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> </div> </div> </div> </div> <div id="getBusinessDetailsView" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getBusinessDetailsView</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the devices available in the given business view</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/businessview/getBusinessDetailsView?apiKey=***************&bvName=ProductionSite_bv</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"BusinessDetailsView":{"Details":[{"severity":"5","MemUtilization":0,"CPUUtilization":0,"displayName":"OPMSwitch_TeamA","name":"OPMSwitch","IpAddress":"127.0.0.1","type":"Unknown","status":"Clear"},{"severity":"5","MemUtilization":0,"CPUUtilization":0,"displayName":"OPMRouter_TeamA","name":"OPMRouter","IpAddress":"127.0.0.1","type":"Unknown","status":"Clear"},{"severity":"5","MemUtilization":0,"CPUUtilization":0,"displayName":"OPMServer_AD","name":"OPMServer_Domaincontroller","IpAddress":"127.0.0.1","type":"Unknown","status":"Clear"}],"TotalRecords":"3"}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>bvName*</b></div> <div class="divTableCell">Name of the Business View (as shown in the URL of Business View page).</div> </div> </div> </div> </div> </div> </div> <div id="Dashboard" class="scroll-parent"> <h1>Dashboard</h1> <div id="getWidgetData" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getWidgetData</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>This API is used to fetch the data to be loaded for a given widget id.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/v2/dashboard/getWidgetData?apiKey=***************&widgetID=495</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"623": {"WidgetName": "Devices by Availability","WidgetForwardPage": "availDetails","WidgetAdditionalData": {},"WidgetData": [{"parentKey":"NULL","onHold":"0s","displayName":"OPM-Firewall1","dependentUnavailable":"0s","ipAddress":"y.y.y.y","availability":"100","downPercent":"0","deviceName":"y.y.y.y","maintenance":"0s","down":"0s","NOTMONITORED":"0s","uptime":"1d"},{"parentKey":"NULL","onHold":"0s","displayName":"OPM-Firewall2","dependentUnavailable":"0s","ipAddress":"x.x.x.x","availability":"100","downPercent":"0","deviceName":"x.x.x.x","maintenance":"0s","down":"0s","NOTMONITORED":"0s","uptime":"1d"}],"Period": "twfourhours","WidgetType": "Grid","WidgetHeaders": ["Name","IPAddress","Up","On Hold","Maintenance","Dependent Unavailable","Down","Not Monitored","Availability(%)"],"Name": "widget.name.topnavail"}} </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>widgetID*</b></div> <div class="divTableCell">The widget ID for which data is to be fetched.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>widgetName</b></div> <div class="divTableCell">The name of the widget.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>widgetType</b></div> <div class="divTableCell">The widget type.</div> </div> </div> </div> </div> </div> <div id="getWidgetList" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getWidgetsList</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>This API is used to list the widgets to be loaded for a given dashboard.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/dashboard/getWidgetsList?apiKey=***************&dashboardName=dashboardname</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"dashName": "Enterprise Dashboard","dashboardID": "31","isDashPropsAvailable": true,"isDefaultDashboard": true,"dashDesc": "contains widgets from all products","noOfCols": "4","colWidths": [{"colWidth": "50","colID": "1"},{"colWidth": "50","colID": "2"}],"configureWidget": true,"editDashboard": false,"widgetList": [{"widgetID": "277","name": "Infrastructure Snapshot","width": "2","x": "0","y": "15","id": "619","type": "Grid","desc": "Infrastructure Snapshot","widgetUniqueName": "widget.name.infrasnap","height": "43"},{"widgetID":"9006","name":"Tree View","width":"2","x":"0","y":"58","id":"9007","type":"DeviceTree","desc":"Tree view of elements","widgetUniqueName":"widget.name.treeView","height":"48"},{"widgetID":"266","name":"HeatMap","width":"2","x":"2","y":"0","id":"618","type":"Heatmap","desc":"HeatMap","widgetUniqueName":"widget.name.heatmap","height":"15"},//and other widget data in above format]} </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>dashboardName*</b></div> <div class="divTableCell">Name of the dashboard.</div> </div> </div> </div> </div> </div> </div> <div id="Devices" class="scroll-parent"> <h1>Devices</h1> <div id="listDevices" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">listDevices</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the devices added in OpManager.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/listDevices?apiKey=****************&</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"total":1,"page":1,"rows":[{"isSNMP":true,"ipaddress":"127.0.0.1","statusStr":"Critical","prettyTime":"10 minutes ago","displayName":"OPMRouterDevice","isNew":false,"type":"Cisco 2900 IS Series","vendorName":"Cisco","deviceName":"127.0.0.1","statusNum":"1","addedTime":"28 Nov 2022 01:08:41 PM IST","interfaceCount":14,"category":"Router"},{"isSNMP":false,"ipaddress":"127.0.0.1","statusStr":"Clear","prettyTime":"50 minutes ago","displayName":"OPMSwitch_Site1","isNew":false,"type":"Unknown","vendorName":"Unknown","deviceName":"127.0.0.1","statusNum":"5","addedTime":"28 Nov 2022 12:29:06 PM IST","interfaceCount":0,"category":"Unknown"}],"records":2}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>isFluidic</b></div> <div class="divTableCell">Set value as 'true' by default.(for internal purpose)</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>type</b></div> <div class="divTableCell">Fetches the list of devices that fall under the given Device Type. [Example: type=Cisco2081]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>category</b></div> <div class="divTableCell">Fetches the list of devices that fall under the given device category [Example: Server, Switch, etc.]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>app</b></div> <div class="divTableCell">Fetches the list of devices that have the given App in it and monitored in OpManager [Example: MSSQL, Exchange, Domain Controller]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>bvName</b></div> <div class="divTableCell">Fetches the list of devices that are under the given Business View map name</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>vendor</b></div> <div class="divTableCell">Fetches the list of devices that have the given vendor name.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>protocol</b></div> <div class="divTableCell">Filter devices by protocol [Example: all|SNMP|WMI|CLI|VIWebService|VIWMI|CLI|XenService|PrismAPI|NetAppAPI|SMI]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>severity</b></div> <div class="divTableCell">Filter devices by severity [Example: 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>selectedVTypes</b></div> <div class="divTableCell">Filter devices by Virtual device type [Example: VMware-VM|VMware-Host|HyperV-VM|Xen-VM|VMware-vCenter|Xen-Host|HyperV-Host]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>groupName</b></div> <div class="divTableCell">Filter devices by Group name</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>customFields</b></div> <div class="divTableCell">To fetch custom field values associated to the device. Set as 'true' if you are using v2 API applicable in OpManager version above 12.x. [Example: /api/json/v2/device/listDevices]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>getInterfaces</b></div> <div class="divTableCell">To fetch devices with associated interfaces. Boolean value: TRUE/FALSE</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>page</b></div> <div class="divTableCell">To fetch devices in batches. This should be combinedly used with 'rows' parameter. [Example: page=1, rows=200, page=2, rows=200]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>rows</b></div> <div class="divTableCell">To fetch devices in batches. This should be combinedly used with 'page' parameter [Example: page=1, rows=200, page=2, rows=200]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>sortByType</b></div> <div class="divTableCell">Defining sort type to be ascending or descending  [Example, sortByType=asc Or sortByType=desc]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>sortByColumn</b></div> <div class="divTableCell">Sorting device list by columns [Example: displayName, interfaceCount, ipaddress, type, etc.]</div> </div> </div> </div> </div> </div> <div id="getDeviceInfo" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getDeviceInfo</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Provides the Hardware Informations of a device</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getDeviceInfo?apiKey=***************&deviceName=xxx.xxx.xx.x</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"OperatingSystem":"Windows", "MACAddress":"00:00:00:11:11:11", "SoftwareVersion":"10.0.1", "SerialNumber":"RKQTHT", "ServiceTag":"ADRFB126", "Model":"ProLiant BL460c", Manufacturer:"HP", "HDD":"512", "RAM":"16384", ...}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName/ipAddress/dnsName*</b></div> <div class="divTableCell">Either one of these three parameters can be used to retrieve the device details. These parameters are the managed Entity name as seen in the URL of the device snapshot page (OR 'deviceName' property value in the listDevices API response), or the IP address of the device, or the DNS name of the device.</div> </div> </div> </div> </div> </div> <div id="setDeviceInfo" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">setDeviceInfo</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>API to update the Hardware Information of any device.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/setDeviceInfo?apiKey=***************&deviceName=xxx.xxx.xx.x</code></p> <p class="yellow-box1"><b>Sample Body: </b><code>values=[{"metricName":"SoftwareVersion","metricValue":"12345"},{"metricName":"RAM","metricValue":"800"}, ...]</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"Hardware details updated successfully."}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName/ipAddress/dnsName*</b></div> <div class="divTableCell">Either one of these three parameters can be used to update the device details. These parameters are the managed Entity name as seen in the URL of the device snapshot page (OR 'deviceName' property value in the listDevices API response), or the IP address of the device, or the DNS name of the device.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>values*</b></div> <div class="divTableCell"> <p>The JSON array containing <strong>metricName</strong> and <strong>metricValue</strong> for Hardware details update:</p> <p>(a) <strong>metricName</strong> - The Hardware metric(s) that need to be changed. These metrics include Model, SoftwareVersion, OperatingSystem, RAM, HDD, and Manufacturer. [Note: These metrics are case-sensitive and must be used as it is]</p> <p>(b) <strong>metricValue</strong> - The value corresponding to the respective <strong>metricName</strong> to be changed.</p> </div> </div> </div> </div> </div> </div> <div id="getDeviceNotes" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getDeviceNotes</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Provides custom field values associated to the given device such as Building, Cabinet, Serial number, etc.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getDeviceNotes?apiKey=***************&name=xxx.xxx.xx.x</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"FIELDVALUE":"","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Building where the device is present","FIELDNAME":"Building","ALIASNAME":"UDF2","FIELDLENGTH":100},{"FIELDVALUE":"","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Cabinet where the device is located","FIELDNAME":"Cabinet","ALIASNAME":"UDF4","FIELDLENGTH":100},{"FIELDVALUE":"","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Comments about the device","FIELDNAME":"Comments","ALIASNAME":"UDF8","FIELDLENGTH":800},{"FIELDVALUE":"user-DevTeam","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Contact person for the device","FIELDNAME":"Contact Name","ALIASNAME":"UDF6","FIELDLENGTH":100},{"FIELDVALUE":"","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Department for which the device services","FIELDNAME":"Department","ALIASNAME":"UDF5","FIELDLENGTH":100},{"FIELDVALUE":"","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Floor where the device is located","FIELDNAME":"Floor","ALIASNAME":"UDF3","FIELDLENGTH":100},{"FIELDVALUE":"FGL120A10AY","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Serial Number of the device","FIELDNAME":"SerialNumber","ALIASNAME":"UDF1","FIELDLENGTH":100},{"FIELDVALUE":"","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Contact number for this device","FIELDNAME":"Telephone Number","ALIASNAME":"UDF7","FIELDLENGTH":100}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>name*</b></div> <div class="divTableCell">Name of the device - Managed Entity name as seen in the URL of the device snapshot page OR 'deviceName' property value in the listDevices API response.</div> </div> </div> </div> </div> </div> <div id="getInfrastructureDetailsView" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getInfrastructureDetailsView</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Provides categorywise details of devices such as device name, device displayname, status, IP Address, Device type and the associated performance monitor values.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/discovery/getInfrastructureDetailsView?apiKey=**************&categoryName=Server</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"InfrastructureDetailsView":{"Details":[{"intfCount":"0","severity":"5","displayName":"127.0.0.1","name":"127.0.0.1","IpAddress":"127.0.0.1","type":"Unknown","monitors":{"DiskUtilization":0,"CPUUtilization":0,"MemoryUtilization":0},"status":"Clear"},{"intfCount":"0","severity":"5","displayName":"127.0.0.1","name":"127.0.0.1","IpAddress":"127.0.0.1","type":"Windows 2016","monitors":{"DiskUtilization":0,"CPUUtilization":0,"MemoryUtilization":0},"status":"Clear"}],"TotalRecords":"2"}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>categoryName*</b></div> <div class="divTableCell">Name of the device category. [Example: Server, Desktop, etc]</div> </div> </div> </div> </div> </div> <div id="getDeviceSummary" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getDeviceSummary</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Provides the device details as in the Device snapshot page</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getDeviceSummary?apiKey=**************&name=opmserver.testdomain.com</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"NFA_ID":"","recBandwidth":"1","IntfIpaddress":"127.0.0.1","instance":"101","displayName":"ciscostackswitchdevice874","Util":"5","availability":{"Down":0,"Dependent Unavailable":0,"On Hold":0,"Not Monitored":0,"Parent Down":98.34,"On Maintenance":0,"Up":1.66},"avgOutPackets":"500 ","outTraffic":"0.008 ","moID":"10000000310","isIPAvailable":true,"inSpeedDisplayValue":"1 bps","intfDisplayName":"GigabitEthernet1/0/1","txUtil":"0.89","typeIdDescr":"Ethernet (6)","operStateImg":"<img alt="" src="/webclient/devices/images/status5.gif" border="0" align="absMiddle" />","isSubInterface":"false","managed":"true","snapDetails":{"snapList":[{"indexCount":0,"ondemandWidget":false,"refresh":false,"type":"IntfSummary","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceSummary","rowNum":1,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.summary","header":false,"id":10000000081,"snapid":10000000081,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[],"sizey":12,"timeSelection":false,"desc":"dashboard.name.nwconfig"},{"indexCount":1,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":13,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000082,"snapid":10000000082,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"totalPackets"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.devices.details.totalbytes"},{"indexCount":2,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":15,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000083,"snapid":10000000083,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"traffic"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Interface.Traffic"},{"indexCount":3,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":17,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000084,"snapid":10000000084,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"utilization"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Interface.Utilization"},{"indexCount":4,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":19,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000085,"snapid":10000000085,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"errors"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.devices.details.errndiscards"},{"indexCount":5,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":21,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000086,"snapid":10000000086,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"discardRate"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Discard.Rate"},{"indexCount":6,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":23,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000087,"snapid":10000000087,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"packets"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"opu.views.PACKETS"},{"indexCount":7,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":25,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000088,"snapid":10000000088,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"errorRate"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Error.Rate"},{"indexCount":8,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceMonitors","rowNum":50,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.monitors","header":true,"id":10000000089,"snapid":10000000089,"snapshotData":{"colModelList":[{"name":"monitorName","index":"monitorName"},{"name":"interval","index":"interval"},{"name":"collectionTime","index":"collectionTime"},{"formatter":"intfValuesWithUnits","name":"value","index":"value"},{"hidden":true,"name":"displayName","index":"displayName"},{"hidden":true,"name":"unit","index":"unit"}],"colNamesList":["webclient.devices.details.monitors","webclient.map.edit.interval","webclient.devices.details.lastpoll","webclient.action.currVal","",""],"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[],"sizey":14,"timeSelection":false,"desc":"webclient.admin.url.monitors"},{"indexCount":9,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceMonitors","rowNum":50,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.monitors","header":true,"id":10000000971,"snapid":10000000971,"snapshotData":{"colModelList":[{"name":"monitorName","index":"monitorName"},{"name":"interval","index":"interval"},{"name":"collectionTime","index":"collectionTime"},{"formatter":"intfValuesWithUnits","name":"value","index":"value"},{"hidden":true,"name":"displayName","index":"displayName"},{"hidden":true,"name":"unit","index":"unit"}],"colNamesList":["webclient.devices.details.monitors","webclient.map.edit.interval","webclient.devices.details.lastpoll","webclient.action.currVal","",""],"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[],"sizey":14,"timeSelection":false,"desc":"webclient.admin.url.monitors"},{"indexCount":10,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceNotes","rowNum":64,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.notes","header":true,"id":10000000090,"snapid":10000000090,"snapshotData":{"colModelList":[{"hidden":true,"classes":"GridColHidden","name":"ALIASNAME","width":"0","index":"ALIASNAME","key":true},{"hidden":true,"classes":"GridColHidden","name":"DATATYPE","width":"0","index":"DATATYPE","key":true},{"formatter":"custField_escapeHtmlTags","name":"FIELDNAME","index":"FIELDNAME"},{"formatter":"custField_escapeHtmlTags","name":"DESCRIPTION","index":"DESCRIPTION"},{"formatter":"custField_escapeHtmlTags","name":"FIELDVALUE","index":"FIELDVALUE"}],"actionurls":[{"name":"Edit","url":"InterfaceNotes"}],"colNamesList":["","","webclient.devices.customfields.fieldname","webclient.devices.customfields.description","webclient.widget.value"]},"expandtime":false,"parameters":[],"sizey":14,"timeSelection":false,"desc":"webclient.commontext.customfields"}],"snapshotID":"10000000005","snapshotDesc":"snapshot.desc.Interface","snapshotName":"OPMInterface","tabs":{"tabs":[{"tabid":10000000026,"name":"webclient.snapshot.testlinks.summary","order":1},{"tabid":10000000027,"name":"webclient.snapshot.name.Interface.Graphs","order":2},{"tabid":10000000028,"name":"webclient.admin.url.monitors","order":3}],"tabWidgets":{"10000000028":[{"ROW":50,"ASSOCIATIONID":10000000089}],"10000000027":[{"ROW":13,"ASSOCIATIONID":10000000082},{"ROW":15,"ASSOCIATIONID":10000000083},{"ROW":17,"ASSOCIATIONID":10000000084},{"ROW":19,"ASSOCIATIONID":10000000085},{"ROW":21,"ASSOCIATIONID":10000000086},{"ROW":23,"ASSOCIATIONID":10000000087},{"ROW":25,"ASSOCIATIONID":10000000088}],"10000000026":[{"ROW":1,"ASSOCIATIONID":10000000081},{"ROW":64,"ASSOCIATIONID":10000000090}]}},"timeSelectionNeeded":true,"yScale":25,"maxColumns":10},"ifPhysAddr":"20","adminState":"Up","transBandwidth":"1","statusPolledVia":"SNMP","outSpeedDisplayValue":"1 bps","rstime":"1 bps","availabilityTimeLine":["ParentDown,1670178610981,1670233674317","ParentDown,1670234394000,1670234514150","UP,1670234514150,1670237050981","UP,1670233674317,1670234394000"],"rxPackets":"0.005 ","ifAdminStatus":"1","rxUtil":"0.89","ifSpeedIn":"1","isAddedToNFA":"false","Discards":"2","stringStatus":"Down","txPackets":"0.002 ","Errors":"2","ifSpeedOut":"1","inTraffic":"0.008 ","operState":"Up","intfmanaged":"true","name":"xxx.xxx.x.xx.10000000001","typeId":"6","ifOperStatus":"1","category":"Switch","adminStateImg":"<img alt="" src="/webclient/devices/images/status5.gif" border="0" align="absMiddle" />","avgInPackets":"200 ","status":"2","desc":"GigabitEthernet1/0/1","trafficCounter":"32 bit"} </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>name*</b></div> <div class="divTableCell">Name of the device - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>isFluidic</b></div> <div class="divTableCell">Set value as TRUE by default. (for internal purpose)</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>snapType</b></div> <div class="divTableCell">Type of the device snapshot. If the device is monitored only in OpManager, set value as 'MonitoringDevice'. If Flow monitoring is enabled for this device, set value as 'FlowDevice'</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>RouterID</b></div> <div class="divTableCell">Router ID of the device if the snapType is set as 'FlowDevice'.</div> </div> </div> </div> </div> </div> <div id="getDeviceCompleteDetails" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getDeviceCompleteDetails</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists the basic details and availability of the device</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/v2/device/getDeviceCompleteDetails?apiKey=***************&name=devicename</code></p> <p class="yellow-box1"><b>Sample Response: </b><code> { "nfadetails":{"NFAStatus":"Not Added"}, "statusStr":"Critical", "responseTime":"001ms", "format":"dd-MM-yy HH:mm:ss", "dnsName":"xxx.xxx.xxx.xx", "timeZone":"Asia/Calcutta", "availability":["DownTime,1672597848117,1672654248117"], "todayTimeAvail":{"todayStartTime":"1672597848132","endTimeVal":"1672654248132"}, "type":"Cisco 2800 Series", "vendorName":"Cisco", "statusNum":"1", "isStorage":false, "ncmdetails":{"SUMMARY_NOT_AVAILABLE":true}, "packetLoss":"11", "configBackup":{"RunningConfig":{},"StartupConfig":{}}, "opmdetails":{ "Type":"Cisco 2800 Series", "dependentDisplayName":"None", "Category":"Server", "hardwareInfo":{"HW_MANUFACTURER":"Cisco","HW_SERIALNUMBER":"FHK1112F402","IS_ALARM_SUPPRESSED":"false","ISPDPresent":false,"HW_MODEL":"CISCO2801","LAST_UPDATED_TIME":"May 10, 2018 05:39 AM","MOID":8438,"IS_MONITORED":"true"}, "displayCategory":"Servers", "PollInterval":"7", "IPAddress":"xxx.xxx.xx.xx", "DNSName":"xxx.xxx.xx.xx", "SysDescription":"Cisco IOS Software, 2801 Software (C2801-ADVENTERPRISEK9-M), Version 15.1(3)T1, RELEASE SOFTWARE (fc2)\r\nTechnical Support: http://www.cisco.com/techsupport\r\nCopyright (c) 1986-2011 by Cisco Systems, Inc.\r\nCompiled Sun 27-Mar-11 07:15 by prod_rel_team", "Monitoring":"ICMP", "UpLinkDependency":"None" }, "state":"2", "availdata":{"Down":100,"Dependent Unavailable":0,"On Hold":0,"Not Monitored":0,"Parent Down":0,"On Maintenance":0,"Up":0} } </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>name*</b></div> <div class="divTableCell">Name of the device</div> </div> </div> </div> </div> </div> <div id="listVirtualDevices" class="scroll-topic"> <h2>Virtual Devices</h2> <div class="api-content-main"> <h3 class="mod-title">listVirtualDevices</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the entities of selected virtual type.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/listVirtualDevices?apiKey=***************&virtualDeviceType=VM</code></p> <p class="yellow-box1"><b>Sample Response: </b><code> {"VENDOR_NAME":"VMware, Inc.","BUILD_INFO":"VMware ESXi 6.7.0 build-8169922","CPU_PACKAGES":2,"TotalDataStores":2,"NUM_PNIC":2,"OS_TYPE":"vmnix-x86","CPU_MODEL":"Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz","MAINTENANCE_MODE":false,"TotalVms":11,"VCENTERDISPLAYNAME":"opm-user-vc","SYSUPTIME":"2021-09-19 21:24:17.745","CONNECTION_STATUS":"connected","CPU_THREADS":40,"CPU_SPEED_MHZ":2194,"HARDWARE_VENDOR":"Dell Inc.","NUM_HBA":3,"CPU_CORES":"20 x 2.20GHz","LASTUPDATEDTIME":"2023-01-09 17:47:25.159","MEM_CAPACITY_MB":"127 GB ","VCENTERNAME":"opm-user-vc.xxx.usercorpin.com","UUID":"4c4c4544-0047-4b10-8043-c4c04f305432","HARDWARE_MODEL":"PowerEdge C6420","ENTITYNAME":"xxx.xx.xxx.xx","POWER_STATE":"On"} </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>virtualDeviceType*</b></div> <div class="divTableCell">Type of virtual entity which you want to list. (Allowed values: VHOST, VDATASTORE, VM, VCENTER, HyperV-Host, HyperV-VM, HyperV-Disk, Xen-Host, Xen-VM, Xen-SR, Xen-Pool, Nutanix-Cluster, Nutanix-Host, Nutanix-VM)</div> </div> </div> </div> </div> </div> <div id="getVMWareHosts" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getVMWareHosts</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b> Lists all the VMware ESX Host for a particular vCenter</p> <p><b>Sample URL: </b><code class="wrap-txt">http://localhost:8060/api/json/device/getVMWareHosts?apiKey=***************&name=vCenter-1 </code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"DISPLAYNAME":"ESXHost-2","STATUS_STR":"Critical","NUM_PNIC":2,"OS":"ESXServer","OS_TYPE":"vmnix-x86","SYSUPTIME":"Apr 22, 2023 21:52 PM","CONNECTION_STATUS":"connected","NAME":"ESXHost-2","VHOST_ID":23703,"STATUS":"1","CPU_SPEED_MHZ":2195,"MEM_CAPACITY_MB":130698,"POWER_STATE":"On"},{"DISPLAYNAME":"ESXHost-1","STATUS_STR":"Clear","NUM_PNIC":2,"OS":"ESXServer","OS_TYPE":"vmnix-x86","SYSUPTIME":"Apr 23, 2023 01:53 AM","CONNECTION_STATUS":"connected","NAME":"ESXHost-1","VHOST_ID":22505,"STATUS":"5","CPU_SPEED_MHZ":2195,"MEM_CAPACITY_MB":130698,"POWER_STATE":"On"}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>name</b></div> <div class="divTableCell">Name of the vCenter device - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.</div> </div> </div> </div> </div> </div> <div id="getDataCenterDetails" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getDataCenterDetails</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the Datacenters present in a particular vCenter</p> <p><b>Sample URL: </b><code class="wrap-txt">http://localhost:8060/api/json/device/getDataCenterDetails?apiKey=***************&moID=13 </code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"NO_OF_DATASTORES":5,"STATUS_STR":"Unknown","STATUS":"7","NO_OF_NETWORKS":3,"ENTITY_NAME":"Datacenter"},{"NO_OF_DATASTORES":0,"STATUS_STR":"Unknown","STATUS":"7","NO_OF_NETWORKS":0,"ENTITY_NAME":"Datacenter 2"},{"NO_OF_DATASTORES":0,"STATUS_STR":"Unknown","STATUS":"7","NO_OF_NETWORKS":0,"ENTITY_NAME":"Datacenter 1"}] </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>moID</b></div> <div class="divTableCell">Unique ID for vCenter device - 'moID' property value in the getDeviceSummary API response.</div> </div> </div> </div> </div> </div> <div id="getClusterDetails" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getClusterDetails</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b> Lists all the Clusters present in a particular vCenter</p> <p><b>Sample URL: </b><code class="wrap-txt">http://localhost:8060/api/json/device/getClusterDetails?apiKey=***************&moID=13 </code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"NO_OF_DATASTORES":5,"STATUS_STR":"Clear","STATUS":"5","NO_OF_NETWORKS":2,"EFFECTIVE_CPU":76780,"NO_OF_HOSTS":2,"TOTAL_CPU_GHZ":86,"DRS_ENABLED":false,"DAS_ENABLED":true,"EFFECTIVE_MEMORY":208229,"ENTITY_NAME":"VSANLab","TOTAL_MEMORY_GB":255}] </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>moID</b></div> <div class="divTableCell">Unique ID for vCenter device - 'moID' property value in the getDeviceSummary API response.</div> </div> </div> </div> </div> </div> <div id="getVMWareVMs" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getVMWareVMs</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b> Lists all the Virtual Machines present in the given entity type</p> <p><b>Sample URL: </b><code class="wrap-txt">http://localhost:8060/api/json/device/getVMWareVMs?apiKey=***************&name=esx2&type=HOST </code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"VM_CONNECTIONSTATE":"connected","DISPLAYNAME":"VMware-vm1","VM_ID":33002,"VIRTUAL_TYPE":"VMware-VM","NUM_ETHERNET":1,"VM_POWERSTATE":"Off","OS_NAME":"CentOS 4/5 or later (32-bit)","NUM_VDISK":1,"VHOST_ID":22505,"MEMORY_MB":1024,"MOID":-4,"IS_ORPHANED":"false","NUM_VCPU":1},{"VM_CONNECTIONSTATE":"connected","DISPLAYNAME":"VMware-VM2","STATUS_STR":"Trouble","VM_ID":23716,"VIRTUAL_TYPE":"VMware-VM","NUM_ETHERNET":1,"VM_POWERSTATE":"On","MAX_CPU_MHZ":17560,"IPADDRESS":"172.24.141.242","OS_NAME":"Microsoft Windows Server 2016 (64-bit)","NUM_VDISK":1,"NAME":"VMware-VM-3","VHOST_ID":23703,"MEMORY_MB":16384,"STATUS":"2","MOID":27302,"MAX_MEMORY_MB":16384,"IS_ORPHANED":"false","NUM_VCPU":8}] </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>name</b></div> <div class="divTableCell">Name of the selected entity type - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>type</b></div> <div class="divTableCell">Type of virtual entity which you want to list. (Allowed values: VCENTER , HOST , DATASTORE)</div> </div> </div> </div> <p> </p> </div> </div> <div id="getVMWareDataStores" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getVMWareDataStores</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b> Lists all the Datastores present in the given entity type</p> <p><b>Sample URL: </b><code class="wrap-txt">http://localhost:8060/api/json/device/getVMWareDataStores?apiKey=***************&name=esxHost2&type=HOST </code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"HostCount":1,"DATASTORENAME":"VMDatastorage (1)","Datastore_ID":23719,"FILESYSTEM_TYPE":"VMFS","CAPACITY_MB":3224,"DATASTORE_URL":"ds:///vmfs/volumes/442ec0fc-67dad2ec-386f-b496913ce490/","MOID":48373,"FREESPACE_MB":615,"deviceName":"device1_com_datastore-1923","IS_ACCESSIBLE":"5"},{"HostCount":1,"DATASTORENAME":"VMFSdatastore (3)","Datastore_ID":23718,"FILESYSTEM_TYPE":"VMFS","CAPACITY_MB":492,"DATASTORE_URL":"ds:///vmfs/volumes/342ebecc-2b289b6a-dd6e-b496913ce490/","MOID":48372,"FREESPACE_MB":427,"deviceName":"device2_datastore-1922","IS_ACCESSIBLE":"5"},{"HostCount":2,"DATASTORENAME":"VSANDatastore","Datastore_ID":32101,"FILESYSTEM_TYPE":"vsan","CAPACITY_MB":1862,"DATASTORE_URL":"ds:///vmfs/volumes/vsan:56f4a7b4df993895-66fa8c0ed80efd32/","MOID":61801,"FREESPACE_MB":1840,"deviceName":"device3_datastore-2718","IS_ACCESSIBLE":"5"}] </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>name</b></div> <div class="divTableCell">Name of the selected entity type - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>type</b></div> <div class="divTableCell">Type of virtual entity which you want to list. (Allowed values: VCENTER , HOST , VM)</div> </div> </div> </div> </div> </div> <div id="getNutanixVDisks" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getNutanixVDisks</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the Virtual disks present in the given entity type</p> <p><b>Sample URL: </b><code class="wrap-txt">http://localhost:8060/api/json/device/getNutanixVDisks?apiKey=***************&name=Nutanix-VM-8 </code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"CAPACITY":"150","NFSFILEPATH":"/General/.acropolis/vmdisk/343e6469-b11d-e321-b30a-1598371a20f8","VDISK_ID":1,"DISKADDRESS":"scsi.0","UUID":"343e6469-b11d-e321-b30a-1598371a20f8"}] </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>name</b></div> <div class="divTableCell">Name of the selected entity type - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.</div> </div> </div> </div> </div> </div> <div id="getNutanixDetails" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getNutanixDetails</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the Virtual disks present in the given entity type</p> <p><b>Sample URL: </b><code class="wrap-txt">http://localhost:8060/api/json/device/getNutanixDetails?apiKey=***************&deviceName=Nutanix-VM8&entityType=Nutanix-VM </code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"DISPLAYNAME":"NutanixVM2","clusterMoName":"Nutanix-Cluster-1","hostName":"Nutanix-Host-1","VCPUCOUNT":2,"VM_ID":21,"statusStr":"Clear","TOOLSMOUNTED":false,"TOOLSVERSION":"1.2.0.3","VM_POWERSTATE":"Powered On","DISKCAPACITY":"150","IPADDRESS":"172.24.151.114","uuid":"3af940cd-b453-485d-89ab-2cab95aba188","deviceName":"Nutanix-VM-1","MEMORYCAPACITY":"6","statusNum":5,"ISCONTROLLERVM":"False","STATUS":"<img alt="" src="/images/devices/status5.gif" /> Clear","NOOFNETWORKADAPTERS":1,"clusterName":"Nutanix-Cluster-1","hostMoName":"Nutanix-Host-1","MOID":307,"MEMRESERVEDCAPACITY":"6","ENTITYNAME":"Nutanix-VM-2"} </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>deviceName</b></div> <div class="divTableCell">Name of the selected entity type - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response.</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>entityType</b></div> <div class="divTableCell">Type of virtual entity which you want to list . Allowed values are Nutanix-Cluster , Nutanix-Host , Nutanix-VM</div> </div> </div> </div> </div> </div> </div> <div id="Discovery" class="scroll-parent"> <h1>Discovery</h1> <div id="addServiceMonitor" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">addDevice</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>Allows you to add individual devices to OpManager for monitoring.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/discovery/addDevice?apiKey=***************&name=opmserver.mydomain.com</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"device":{"deviceIp":"127.0.0.1","message":"Device added successfully.","deviceName":"127.0.0.1","moid":365}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>deviceName*</b></div> <div class="divTableCell">Hostname, FQDN name or IP Address of the device</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>credentialName</b></div> <div class="divTableCell">Name of the credential used to access the device to fetch device information.</div> </div> </div> </div> </div> </div> </div> <div id="Enterprise" class="scroll-parent"> <h1>Enterprise</h1> <div id="listProbes" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">listProbes</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>This API is to list all the probes</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/admin/listProbes?apiKey=***************</code></p> <p class="yellow-box1"><b>Sample Response: </b><code> [ { "severity": "1", "serverMode": "PRIMARY", "serverStatus": "Server down", "contactEmail": "opm@user1.com", "deviceCount": "1", "natProtocol": "http", "probeID": "10000000001", "isConnected": "false", "contactPerson": "OpmUser1", "statusImg": "images/status1.gif", "ipslaCount": "0", "lastContact": "26 Oct 2022 12:42:59 PM IST", "natName": "opm-probe1", "name": "Probe1", "probeDisplayName": "Probe1", "ncmCount": "-1", "attr": { "deviceCount": { "rowspan": "1" }, "name": { "rowspan": "1" }, "lastContact": { "rowspan": "1" } }, "natPort": "8062", "status": "Critical" } ] </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> </div> </div> </div> </div> </div> <div id="Events" class="scroll-parent"> <h1>Events</h1> <div id="listEvents" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">listEvents</h3> <p><b>Method: </b>GET</p> <p><b>Description:</b> Lists event history.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/events/listEvents?apiKey=***************</code></p> <p class="yellow-box1"><b>Sample Response: </b><code> { "severityVsCount": { "Trouble": 1, "Critical": 2, "Attention": 3 }, "List": [ { "modTimeLong": "1666786290075", "statusStr": "Attention", "prettyTime": "5 minutes ago", "displayname": "opm-server1", "text": "CPU Utilization is 12%, threshold value for this monitor is 2%: Top 3 Processes:-WmiPrvSE#4 - 1.467%;CynetMS - 1.381%;Code#4 - 0.69%", "category": "Desktop", "statusNum": "3" }, { "modTimeLong": "1666785470844", "statusStr": "Critical", "prettyTime": "19 minutes ago", "displayname": "opm-server1", "text": "Disk Utilization is 44%, threshold value for this monitor is 5%", "category": "Desktop", "statusNum": "1" }, { "modTimeLong": "1666785450689", "statusStr": "Trouble", "prettyTime": "19 minutes ago", "displayname": "opm-server1", "text": "Memory Utilization is 75%, threshold value for this monitor is 4%: Top 3 Processes:-java.exe - 7.247%;CynetMS.exe - 3.791%;explorer.exe - 3.216%", "category": "Desktop", "statusNum": "2" }, { "modTimeLong": "1666785429095", "statusStr": "Attention", "prettyTime": "20 minutes ago", "displayname": "opm-server1", "text": "CPU Utilization is 21%, threshold value for this monitor is 2%: Top 3 Processes:-svchost#25 - 12.362%;MEARWService - 6.266%;msedge#7 - 2.371%", "category": "Desktop", "statusNum": "3" }, { "modTimeLong": "1666091221235", "statusStr": "Critical", "prettyTime": "8 days ago", "displayname": "System", "text": "File Integrity : New files were found during the last scan.", "category": "Security settings", "statusNum": "1" }, { "modTimeLong": "1666090716359", "statusStr": "Attention", "prettyTime": "8 days ago", "displayname": "opm-server1", "text": "CPU Utilization is 9%, threshold value for this monitor is 2%: Top 3 Processes:-java - 6.377%;svchost#21 - 6.207%;msedge#6 - 1.616%", "category": "Desktop", "statusNum": "3" } ], "Details": { "Desktop": [ { "value": 3, "status": 3, "label": "Attention" }, { "value": 1, "status": 2, "label": "Trouble" }, { "value": 1, "status": 1, "label": "Critical" } ], "Security settings": [ { "value": 1, "status": 1, "label": "Critical" } ] } } </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName</b></div> <div class="divTableCell">Device name for which the events to be listed</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>entity</b></div> <div class="divTableCell">Entity of the event</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>period</b></div> <div class="divTableCell">Time period for which events should be listed</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>severity</b></div> <div class="divTableCell">Severity of the alarm</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>category</b></div> <div class="divTableCell">Device category of the alarm</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>eventType</b></div> <div class="divTableCell">EventType of the alarm</div> </div> </div> </div> </div> </div> </div> <div id="addEvent" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">addEvent</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>This API can be used to generate a new Event which can trigger an alarm</p> <p class="yellow-box1"><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/events/addEvent?source=Test_Device_MoName&severity=1&message=Sample_Critical_Message&alarmCode=Sample_AlarmCode&entity=Sample_Entity&apiKey=*** </code></p> <p class="yellow-box1"><b>Sample Response: </b><code> {"result":{"message":"Event has been successfully generated."}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell"><b>Parameter name</b></div> <div class="divTableCell"><b>Description</b></div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager Server</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>source*</b></div> <div class="divTableCell">Source device of of the alarm.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>severity*</b></div> <div class="divTableCell">Severity of the alarm. The severity could range anywhere from 1 to 5. <em>1 = Critical, 2 = Trouble, 3 = Attention, 4 = Service Down, 5 = Clear</em>.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>message*</b></div> <div class="divTableCell">Message of the alarm.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>alarmCode*</b></div> <div class="divTableCell">Alarm code of the alarm.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>entity*</b></div> <div class="divTableCell">Unique Value for the generating Alarm</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>eventType</b></div> <div class="divTableCell">EventType of the Alarm. It will be used to identify the group of alerts.</div> </div> </div> </div> </div> </div> <div id="Groups" class="scroll-parent"> <h1>Groups</h1> <div id="listAllLogicalGroups" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">listAllLogicalGroups</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the groups available in OpManager. Also provides basic group information such as members count and group health.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/admin/listAllLogicalGroups?apiKey=***************</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"groupDisplayName":"Devices","groupType":"Device","groupName":"devices-363","device_Count":"2","groupID":"363","count":"2","description":"No Description","availability":"NA","statusImg":"/images/devices/status1.gif","displayGroupType":"Device","statusLabel":"Critical","status":"1"}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> </div> </div> </div> </div> <div id="getLogicalGroupInfo" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getLogicalGroupInfo</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Provides details (such as members count, group status, etc.) of the given group.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/admin/getLogicalGroupInfo?apiKey=***************&groupName=NorthBayRegion-4201&period=3&snapType=LogicalDeviceGroup</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"GroupDetails":{"groupType":"Device","groupID":"363","count":"2","description":"No Description","statusImg":"/images/devices/status1.gif","deviceDevice_Count":"2","statusLabel":"Critical","groupDisplayName":"Devices","groupName":"devices-363","alertCount":3,"statusChangeCount":2,"displayGroupType":"Device","status":"1"},"snapDetails":{"snapList":[{"indexCount":0,"ondemandWidget":false,"refresh":false,"type":"GroupSummary","sizex":10,"expand":false,"apiurl":"/client/api/json/admin/getLogicalGroupInfo","rowNum":1,"parameter":"groupName","isEnabled":true,"colNum":1,"name":"opm.intfGroup.Summary","header":true,"id":884,"snapid":884,"expandtime":false,"parameters":[{"param":"period","paramData":[],"value":"3"}],"sizey":9,"timeSelection":false,"desc":"webclient.storage.summary"},{"indexCount":1,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":5,"expand":false,"apiurl":"/client/api/json/admin/getLogicalGroupAlerts","rowNum":12,"parameter":"groupName","isEnabled":true,"colNum":1,"name":"opm.devicegrouping.Alarms","header":true,"id":885,"snapid":885,"snapshotData":{"colModelList":[{"formatter":"opm_linkToElementAlarmSnapshot","classes":"pointer","name":"message","index":"message"},{"hidden":true,"name":"severity","index":"severity"},{"formatter":"opm_gElemAlarmToElemSnap","classes":"pointer","name":"displayName","index":"displayName"},{"hidden":true,"name":"groupType","index":"groupType"},{"hidden":true,"name":"name","index":"name"},{"hidden":true,"name":"entity","index":"entity"},{"hidden":true,"name":"status","index":"status"},{"name":"modTime","index":"modTime"},{"hidden":true,"name":"alarmId","index":"alarmId"}],"colNamesList":["webclient.admin.traps.message","","webclient.fault.event.displayName","","","","","webclient.fault.details.properties.modttime","alarmid"],"onselectfunction":"opm_groupsAlert"},"expandtime":false,"parameters":[],"sizey":2,"timeSelection":false,"desc":"webclient.logicDevfGroup.deviceAlarms"},{"indexCount":2,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":5,"expand":false,"apiurl":"/client/api/json/admin/listLogicalGroupMembers","rowNum":12,"parameter":"groupName","isEnabled":true,"colNum":6,"name":"opm.grouping.devices","header":true,"id":886,"snapid":886,"snapshotData":{"colModelList":[{"formatter":"opm_linkToGroupSnap","classes":"pointer","name":"displayname","index":"displayname"},{"hidden":true,"name":"statusNum","index":"statusNum"},{"name":"type","index":"type"},{"hidden":true,"name":"name","index":"name"},{"hidden":true,"name":"moid","index":"moid"},{"hidden":true,"name":"groupType","index":"groupType"}],"colNamesList":["webclient.fault.addnotes.device_name","","webclient.topo.objectdetails.type","","",""],"onselectfunction":"opm_groupsElements"},"expandtime":false,"parameters":[],"sizey":2,"timeSelection":false,"desc":"webclient.grouping.device.list"}],"snapshotID":"89","snapshotDesc":"snapshot.desc.groupsummary","snapshotName":"LogicalDeviceGroup","tabs":{"tabs":[{"tabid":383,"name":"webclient.group.summary","order":1}],"tabWidgets":{"383":[{"ROW":1,"ASSOCIATIONID":884},{"ROW":12,"ASSOCIATIONID":885},{"ROW":12,"ASSOCIATIONID":886}]}},"timeSelectionNeeded":false,"yScale":25,"maxColumns":10}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>groupName*</b></div> <div class="divTableCell">Name of the group with MOID appended in the suffix. such as <groupname>- <moid></moid> </groupname></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>period</b></div> <div class="divTableCell">Time for which the availability data is to be fetched.[Example: twelvehours(16),Today(6),twfourhours(3),Yesterday(7),thisweek(8),Last_7_Days(4),lastweek(9),thismonth(10),Last_30_Days(5),Last_Month(11),custom(23)]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>snapType</b></div> <div class="divTableCell">Group Snapshot type. [Example: LogicalGroup|LogicalIntfGroup|LogicalDeviceGroup]</div> </div> </div> </div> </div> </div> <div id="getLogicalGroupAlerts" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getLogicalGroupAlerts</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Fetches the alarms generated from the members (devices/interfaces) of the given group.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/admin/getLogicalGroupAlerts?apiKey=***************&groupName=bvgcty-4201</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"severity":"Critical","groupType":"device","severityString":"/images/devices/status1.gif","modTime":"25 Nov 2022 02:27:11 PM IST","displayName":"Pradh","name":"opm-server","alarmId":1,"type":"device","message":"Device Down: No response from device for last 5 polls","entity":"opm-server_Poll","status":1},{"severity":"Attention","groupType":"device","severityString":"/images/devices/status3.gif","modTime":"25 Nov 2022 07:17:49 PM IST","displayName":"HPswitch9","name":"127.0.0.1","alarmId":33,"type":"device","message":"Device not responding: Probably down or busy","entity":"127.0.0.1_Poll","status":3},{"severity":"Attention","groupType":"device","severityString":"/images/devices/status3.gif","modTime":"25 Nov 2022 02:50:59 PM IST","displayName":"HPswitch9","name":"127.0.0.1","alarmId":26,"type":"device","message":"Response Time is 21 ms, threshold value for this device is 10 ms","entity":"154_Device","status":3}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>groupName</b></div> <div class="divTableCell">Name of the group</div> </div> </div> </div> </div> </div> <div id="listLogicalGroupMembers" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">listLogicalGroupMembers</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Provides information on the members available in the given group.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/admin/listLogicalGroupMembers?apiKey=***************&groupName=NorthBayRegion-4201</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"groupType":"Device","statusStr":"Clear","displayname":"OPMServer","name":"OPMServer","type":"Device","moid":"10","statusNum":"5"},{"groupType":"Device","statusStr":"Attention","displayname":"HPswitch","name":"127.0.0.1","type":"Device","moid":"362","statusNum":"3"}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>groupName</b></div> <div class="divTableCell">Name of the Device/Interface Group having suffix as '- <moid>'. [Example: <groupname>- <moid>]</moid> </groupname> </moid></div> </div> </div> </div> </div> </div> <div id="addToGroup" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">addToGroup</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>Allows you to add device(s) to the specified Group.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/addToGroup?apiKey=***************&groupType=device&selectedMembers=10.1.1.20,opmserver</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"result":{"message":"The Device(s) have been associated to the group successfully."}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>groupName*</b></div> <div class="divTableCell">Name of the Device/Interface Group with MOID in the suffix. [Example: <groupname>- <moid>]</moid> </groupname></div> </div> <div class="divTableRow"> <div class="divTableCell"><b>groupType*</b></div> <div class="divTableCell">Type of the group [Example: device|interface]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>selectedMembers*</b></div> <div class="divTableCell">Device name(s) supplied as a comma-separated string. Device name is a Managed entity name as seen in the device snapshot page URL OR in 'deviceName' property of the listDevices API response</div> </div> </div> </div> </div> </div> </div> <div id="Interfaces" class="scroll-parent"> <h1>Interfaces</h1> <div id="listInterfaces" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">listInterfaces</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the interfaces monitored in OpManager</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/listInterfaces?apiKey=***************&isFluidic=true&rows=100&page=1&sortByColumn=statusNum&sortByType=desc</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"total":"1","records":"5","page":"1","rows":[{"interfaceDisplayName":"Loopback55-\"Loop Back 55\"","statusStr":"Clear","displayName":"OPMRouterDevice","ipAddress":"","outSpeed":"8 Gbps","inSpeed":"8 Gbps","type":"Software Loopback","deviceName":"127.0.0.1","interfaceStatus":5,"statusNum":5,"adminStatus":"Up","operStatus":"Up","id":"1","interfaceName":"IF-127.0.0.1-415"},{"interfaceDisplayName":"Loopback51-Lo51","statusStr":"Clear","displayName":"OPMRouterDevice","ipAddress":"","outSpeed":"8 Gbps","inSpeed":"8 Gbps","type":"Software Loopback","deviceName":"127.0.0.1","interfaceStatus":5,"statusNum":5,"adminStatus":"Up","operStatus":"Up","id":"2","interfaceName":"IF-127.0.0.1-417"}]}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>isFluidic</b></div> <div class="divTableCell">Set value as 'true' by default (for internal purpose)</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>rows</b></div> <div class="divTableCell">To fetch interface list in batches. This should be combinedly used with 'page' parameter [Example: page=1, rows=200, page=2, rows=200]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>page</b></div> <div class="divTableCell">To fetch interface list in batches. This should be combinedly used with 'rows' parameter [Example: page=1, rows=200, page=2, rows=200]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>sortByColumn</b></div> <div class="divTableCell">Sorting interfaces list with columns [Example: inSpeed, displayName, ipaddress, outSpeed, statusNum, severity - 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>sortByType</b></div> <div class="divTableCell">Defining ascending or descending sort of interfaces list [Example, sortByType=asc Or sortByType=desc]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>severity</b></div> <div class="divTableCell">Filter interfaces with severity. [Example: 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>type</b></div> <div class="divTableCell">Filter interface with interface type. [Example: Ethernet,Software Loopback, etc]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>intfProps</b></div> <div class="divTableCell">To fetch additional interface properties such as ifName (Interface ifName), moid (internal managed object identifier used for interface/device), physAddress</div> </div> </div> </div> </div> </div> <div id="getInterfaceSummary" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getInterfaceSummary</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Provides basic details of the interface such as ifIndex, ifName, ifDesc, ifAlias, parent device, Rx/Tx Traffic, etc.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getInterfaceSummary?apiKey=***************&interfaceName=IF-172.24.146.225-4429</code></p> <p class="yellow-box1"><b>Sample Response: </b><code> {"NFA_ID":"","recBandwidth":"1","IntfIpaddress":"127.0.0.1","instance":"101","displayName":"ciscostackswitchdevice874","Util":"5","availability":{"Down":0,"Dependent Unavailable":0,"On Hold":0,"Not Monitored":0,"Parent Down":98.34,"On Maintenance":0,"Up":1.66},"avgOutPackets":"500 ","outTraffic":"0.008 ","moID":"10000000310","isIPAvailable":true,"inSpeedDisplayValue":"1 bps","intfDisplayName":"GigabitEthernet1/0/1","txUtil":"0.89","typeIdDescr":"Ethernet (6)","operStateImg":"<img alt="" src="/webclient/devices/images/status5.gif" border="0" align="absMiddle" />","isSubInterface":"false","managed":"true","snapDetails":{"snapList":[{"indexCount":0,"ondemandWidget":false,"refresh":false,"type":"IntfSummary","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceSummary","rowNum":1,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.summary","header":false,"id":10000000081,"snapid":10000000081,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[],"sizey":12,"timeSelection":false,"desc":"dashboard.name.nwconfig"},{"indexCount":1,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":13,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000082,"snapid":10000000082,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"totalPackets"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.devices.details.totalbytes"},{"indexCount":2,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":15,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000083,"snapid":10000000083,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"traffic"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Interface.Traffic"},{"indexCount":3,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":17,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000084,"snapid":10000000084,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"utilization"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Interface.Utilization"},{"indexCount":4,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":19,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000085,"snapid":10000000085,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"errors"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.devices.details.errndiscards"},{"indexCount":5,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":21,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000086,"snapid":10000000086,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"discardRate"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Discard.Rate"},{"indexCount":6,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":23,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000087,"snapid":10000000087,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"packets"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"opu.views.PACKETS"},{"indexCount":7,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":25,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000088,"snapid":10000000088,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"errorRate"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Error.Rate"},{"indexCount":8,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceMonitors","rowNum":50,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.monitors","header":true,"id":10000000089,"snapid":10000000089,"snapshotData":{"colModelList":[{"name":"monitorName","index":"monitorName"},{"name":"interval","index":"interval"},{"name":"collectionTime","index":"collectionTime"},{"formatter":"intfValuesWithUnits","name":"value","index":"value"},{"hidden":true,"name":"displayName","index":"displayName"},{"hidden":true,"name":"unit","index":"unit"}],"colNamesList":["webclient.devices.details.monitors","webclient.map.edit.interval","webclient.devices.details.lastpoll","webclient.action.currVal","",""],"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[],"sizey":14,"timeSelection":false,"desc":"webclient.admin.url.monitors"},{"indexCount":9,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceMonitors","rowNum":50,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.monitors","header":true,"id":10000000971,"snapid":10000000971,"snapshotData":{"colModelList":[{"name":"monitorName","index":"monitorName"},{"name":"interval","index":"interval"},{"name":"collectionTime","index":"collectionTime"},{"formatter":"intfValuesWithUnits","name":"value","index":"value"},{"hidden":true,"name":"displayName","index":"displayName"},{"hidden":true,"name":"unit","index":"unit"}],"colNamesList":["webclient.devices.details.monitors","webclient.map.edit.interval","webclient.devices.details.lastpoll","webclient.action.currVal","",""],"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[],"sizey":14,"timeSelection":false,"desc":"webclient.admin.url.monitors"},{"indexCount":10,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceNotes","rowNum":64,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.notes","header":true,"id":10000000090,"snapid":10000000090,"snapshotData":{"colModelList":[{"hidden":true,"classes":"GridColHidden","name":"ALIASNAME","width":"0","index":"ALIASNAME","key":true},{"hidden":true,"classes":"GridColHidden","name":"DATATYPE","width":"0","index":"DATATYPE","key":true},{"formatter":"custField_escapeHtmlTags","name":"FIELDNAME","index":"FIELDNAME"},{"formatter":"custField_escapeHtmlTags","name":"DESCRIPTION","index":"DESCRIPTION"},{"formatter":"custField_escapeHtmlTags","name":"FIELDVALUE","index":"FIELDVALUE"}],"actionurls":[{"name":"Edit","url":"InterfaceNotes"}],"colNamesList":["","","webclient.devices.customfields.fieldname","webclient.devices.customfields.description","webclient.widget.value"]},"expandtime":false,"parameters":[],"sizey":14,"timeSelection":false,"desc":"webclient.commontext.customfields"}],"snapshotID":"10000000005","snapshotDesc":"snapshot.desc.Interface","snapshotName":"OPMInterface","tabs":{"tabs":[{"tabid":10000000026,"name":"webclient.snapshot.testlinks.summary","order":1},{"tabid":10000000027,"name":"webclient.snapshot.name.Interface.Graphs","order":2},{"tabid":10000000028,"name":"webclient.admin.url.monitors","order":3}],"tabWidgets":{"10000000028":[{"ROW":50,"ASSOCIATIONID":10000000089}],"10000000027":[{"ROW":13,"ASSOCIATIONID":10000000082},{"ROW":15,"ASSOCIATIONID":10000000083},{"ROW":17,"ASSOCIATIONID":10000000084},{"ROW":19,"ASSOCIATIONID":10000000085},{"ROW":21,"ASSOCIATIONID":10000000086},{"ROW":23,"ASSOCIATIONID":10000000087},{"ROW":25,"ASSOCIATIONID":10000000088}],"10000000026":[{"ROW":1,"ASSOCIATIONID":10000000081},{"ROW":64,"ASSOCIATIONID":10000000090}]}},"timeSelectionNeeded":true,"yScale":25,"maxColumns":10},"ifPhysAddr":"20","adminState":"Up","transBandwidth":"1","statusPolledVia":"SNMP","outSpeedDisplayValue":"1 bps","rstime":"1 bps","availabilityTimeLine":["ParentDown,1670178610981,1670233674317","ParentDown,1670234394000,1670234514150","UP,1670234514150,1670237050981","UP,1670233674317,1670234394000"],"rxPackets":"0.005 ","ifAdminStatus":"1","rxUtil":"0.89","ifSpeedIn":"1","isAddedToNFA":"false","Discards":"2","stringStatus":"Down","txPackets":"0.002 ","Errors":"2","ifSpeedOut":"1","inTraffic":"0.008 ","operState":"Up","intfmanaged":"true","name":"xxx.xxx.x.xx.10000000001","typeId":"6","ifOperStatus":"1","category":"Switch","adminStateImg":"<img alt="" src="/webclient/devices/images/status5.gif" border="0" align="absMiddle" />","avgInPackets":"200 ","status":"2","desc":"GigabitEthernet1/0/1","trafficCounter":"32 bit"} </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>interfaceName*</b></div> <div class="divTableCell">ManagedObject name of the interface as seen in the URL of interface snapshot page.</div> </div> </div> </div> </div> </div> <div id="getIntfAtAGlanceReportDetails" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getIntfAtAGlanceReportDetails</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Provides a consolidated availability and performance monitoring health report data for the given interface.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/v2/device/getIntfAtAGlanceReportDetails?apiKey=***************&InterfaceName=IF-xxx.xxx.xx.4-3820&period=Today</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"intfDisplayName":"VLAN555-VLAN555","InterfaceCategory":"LAN","Details":{"Parent Name":"HPswitch9","IfDescr":"VLAN555","IfAlias":"VLAN555","IfIndex":"1132","Receive Bandwidth":"0 bps","IfName":"VLAN555","Transmit Bandwidth":"0 bps","Circuit ID":"-"},"repType":7,"graphData":{"Errors":[{"seriesname":"inErrors","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Errors/sec"],"yaxiscolumnorder":[0],"suffix":""},{"seriesname":"outErrors","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Errors/sec"],"yaxiscolumnorder":[0],"suffix":""}],"Unicast":[{"seriesname":"broadcast","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","%"],"yaxiscolumnorder":[0],"suffix":""},{"seriesname":"unicast","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","%"],"yaxiscolumnorder":[0],"suffix":""}],"outBytes":[{"seriesname":"outBytes","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time",""],"yaxiscolumnorder":[0],"suffix":""}],"inTraffic":[{"seriesname":"inTraffic","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","bps"],"yaxiscolumnorder":[0],"suffix":""}],"inBytes":[{"seriesname":"inBytes","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Bytes/sec"],"yaxiscolumnorder":[0],"suffix":""}],"inUtilization":[{"seriesname":"inUtilization","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Percentage"],"yaxiscolumnorder":[0],"suffix":""}],"outUtilization":[{"seriesname":"outUtilization","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Percentage"],"yaxiscolumnorder":[0],"suffix":""}],"Discards":[{"seriesname":"inDiscards","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Discards/sec"],"yaxiscolumnorder":[0],"suffix":""},{"seriesname":"outDiscards","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Discards/sec"],"yaxiscolumnorder":[0],"suffix":""}],"totalUtilization":[{"seriesname":"totalUtilization","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Percentage"],"yaxiscolumnorder":[0],"suffix":""}],"inFrames":[{"seriesname":"inFrames","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Frames/sec"],"yaxiscolumnorder":[0],"suffix":""}],"outFrames":[{"seriesname":"outFrames","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Frames/sec"],"yaxiscolumnorder":[0],"suffix":""}],"outTraffic":[{"seriesname":"outTraffic","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","bps"],"yaxiscolumnorder":[0],"suffix":""}]}} </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>InterfaceName*</b></div> <div class="divTableCell">Name of the interface - Managed Entity name as seen in the URL of interface snapshot page OR 'interfaceName' property value in the listInterfaces API response.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>period*</b></div> <div class="divTableCell">Period for which the interface data is required. [Example: twelvehours,Today,twfourhours,Yesterday,thisweek,Last_7_Days,lastweek,thismonth,Last_30_Days,Last_Month,custom]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>startDate</b></div> <div class="divTableCell">From Date. This parameter is applicable only if 'custom' time is opted in <b>period</b> param value</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>endDate</b></div> <div class="divTableCell">To Date. This parameter is applicable only if 'custom' time is opted in <b>period</b> param value</div> </div> </div> </div> </div> </div> <div id="getIntfBWOutageReportDetails" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getIntfBWOutageReportDetails</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Provides data for consolidated Bandwidth report (Rx/Tx Traffic) for the given interface.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/v2/device/getIntfBWOutageReportDetails?apiKey=***************&interfaceName=IF-xxx.xxx.xx.x-3836&period=Today</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"InSpeed":"0 bps","IfDesc":"VLAN555","repType":9,"consolidatedValues":{"Total":{"95thpercentileValue":"0 ( 0.0 % )","minCollectionTime":"1669619780249","maxVal":"0 ( 0.0 % )","currVal":"0 ( 0.0 % )","minVal":"0 ( 0.0 % )","seriesName":"Total","95thpercRawVal":"0.0","avgVal":"0 ( 0.0 % )","95thperc":"0 ( 0.0 % )","maxCollectionTime":"1669619780249","95thpercVal":"0.0"},"InTraffic":{"95thpercentileValue":"0 ( 0.0 % )","minCollectionTime":"1669619780249","maxVal":"0 ( 0.0 % )","currVal":"0 ( 0.0 % )","minVal":"0 ( 0.0 % )","seriesName":"InTraffic","95thpercRawVal":"0.0","avgVal":"0 ( 0.0 % )","95thperc":"0 ( 0.0 % )","maxCollectionTime":"1669619780249","95thpercVal":"0.0"},"OutTraffic":{"95thpercentileValue":"0 ( 0.0 % )","minCollectionTime":"1669619780249","maxVal":"0 ( 0.0 % )","currVal":"0 ( 0.0 % )","minVal":"0 ( 0.0 % )","seriesName":"OutTraffic","95thpercRawVal":"0.0","avgVal":"0 ( 0.0 % )","95thperc":"0 ( 0.0 % )","maxCollectionTime":"1669619780249","95thpercVal":"0.0"}},"seriesNames":["OutTraffic","OutTraffic-95th","Total","Total-95th","InTraffic","InTraffic-95th"],"bwChartData":[{"seriesname":"OutTraffic","isRaw":true,"data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Bits per Second"]},{"seriesname":"OutTraffic-95th","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Bits per Second"]},{"seriesname":"Total","isRaw":true,"data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Bits per Second"]},{"seriesname":"Total-95th","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Bits per Second"]},{"seriesname":"InTraffic","isRaw":true,"data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Bits per Second"]},{"seriesname":"InTraffic-95th","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Bits per Second"]}],"InterfaceDisplayName":"VLAN555-VLAN555","IfAlias":"VLAN555","suffix":"","availData":{"Down":100,"Dependent Unavailable":0,"On Hold":0,"Not Monitored":0,"Parent Down":0,"On Maintenance":0,"Up":0},"deviceName":"IF-127.0.0.1-353","interfaceDetails":{"Parent Name":"HPswitch9","IfDescr":"VLAN555","IfIndex":"1132","IfAlias":"VLAN555","IfName":"VLAN555","Circuit ID":"-"},"OutSpeed":"0 bps","name":"HPswitch9","CircuitID":"-","IfIndex":"1132","InterfaceName":"IF-127.0.0.1-353","IfName":"VLAN555"} </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>interfaceName*</b></div> <div class="divTableCell">Name of the interface - Managed Entity name as seen in the URL of interface snapshot page OR 'interfaceName' property value in the listInterfaces API response</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>period*</b></div> <div class="divTableCell">Period for which the interface graph is required. [Example: twelvehours,Today,twfourhours,Yesterday,thisweek,Last_7_Days,lastweek,thismonth,Last_30_Days,Last_Month,custom]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>startDate</b></div> <div class="divTableCell">From Date. This paramete is applicable only if 'custom' time is opted in <b>period</b> param value</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>endDate</b></div> <div class="divTableCell">To Date. This param is applicable only if 'custom' time is opted in <b>period</b> param value</div> </div> </div> </div> </div> </div> <div id="getInterfaces" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getInterfaces</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Provides the list of interfaces monitored in a device.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getInterfaces?apiKey=***************&name=opmserver.testdomain.com</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"downCount":"0","interfaces":[{"ifIndex":"1","ifAdminStatus":"1","ifIndexNum":1,"statusStr":"Clear","ifType":"Ethernet","displayName":"Backplane-GigabitEthernet0/3-Ba0/3","imagePath":"/apiclient/ember/images/intfTypes/ifType6.gif","RouterPortType":"","trimmedDispName":"Backplane-GigabitEtherne...","outSpeed":"1 G","inSpeed":"1 G","type":"Interface","moid":"301","outTraffic":"0 (0.0%)","nfEnabled":"false","statusNum":"5","bgColor":"00ff00","inTraffic":"0 (0.0%)","isSubInterface":"false","statusString":"Clear","name":"IF-http://127.0.0.1-301","ifOperStatus":"1","errors":"0","status":"5"},{"ifIndex":"4","ifAdminStatus":"1","ifIndexNum":4,"statusStr":"Clear","ifType":"Ethernet","displayName":"GigabitEthernet0/2-Gi0/2","imagePath":"/apiclient/ember/images/intfTypes/ifType6.gif","RouterPortType":"","trimmedDispName":"GigabitEthernet0/2-Gi0/2","outSpeed":"1 G","inSpeed":"1 G","type":"Interface","moid":"305","outTraffic":"160.279 K (0.02%)","nfEnabled":"false","statusNum":"5","bgColor":"00ff00","inTraffic":"32.239 K (0.0%)","isSubInterface":"false","statusString":"Clear","name":"IF-http://127.0.0.1-305","ifOperStatus":"1","errors":"0","status":"5"}],"interfaceCount":"2"}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>name*</b></div> <div class="divTableCell">Name of the parent device - Managed Entity name of the parent device as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response</div> </div> </div> </div> </div> </div> <div id="getInterfaceNotes" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getInterfaceNotes</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Fetches the custom field values associated to the given interface.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://opmserver:8060/api/json/device/getInterfaceNotes?apiKey=************&interfaceName=IF-opmserver.testdomain.com-4505</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"CUSTOMFIELDID":"16","DATATYPE":"Text","DESCRIPTION":"Circuit ID","FIELDNAME":"Circuit ID","ALIASNAME":"UDF1","FIELDLENGTH":250},{"CUSTOMFIELDID":"20","DATATYPE":"Text","DESCRIPTION":"Any comments about the interface","FIELDNAME":"Comments","ALIASNAME":"UDF5","FIELDLENGTH":800},{"CUSTOMFIELDID":"21","DATATYPE":"Text","DESCRIPTION":"Contact person","FIELDNAME":"Contact Name","ALIASNAME":"UDF3","FIELDLENGTH":100},{"CUSTOMFIELDID":"18","DATATYPE":"Text","DESCRIPTION":"SLA related details","FIELDNAME":"SLA","ALIASNAME":"UDF2","FIELDLENGTH":250},{"CUSTOMFIELDID":"22","DATATYPE":"Text","DESCRIPTION":"Contact number","FIELDNAME":"Telephone Number","ALIASNAME":"UDF4","FIELDLENGTH":100}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>interfaceName*</b></div> <div class="divTableCell">Name of the interface - Managed Entity name as seen in the URL of interface snapshot page OR 'interfaceName' property value in the listInterfaces API response</div> </div> </div> </div> </div> </div> <div id="getInterfaceGraphs" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getInterfaceGraphs</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Fetches the collected data (such as traffic, errors & discards, etc.) for the given interface.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getInterfaceGraphs?apiKey=***************&interfaceName=IF-xxx.xxx.xx.xxx-329&graphName=rxutilization</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"interfaceDetails":{"Parent Name":"OPMRouter1","IfDescr":"GigabitEthernet0/2","IfIndex":"4","IfAlias":"-","IfName":"Gi0/2","Circuit ID":"-"},"displayName":"Total Bytes Transfered","consolidatedValues":{"Total Bytes":{"95thpercentileValue":"61.616 M","minCollectionTime":"1669383479403","maxVal":"61.616 M","currVal":"21.658 M","minVal":"21.658 M","seriesName":"Total Bytes","95thpercRawVal":"5.02440515E7","avgVal":"51.868 M","95thperc":"50.244 M","maxCollectionTime":"1669371779404","95thpercVal":"50.2440515"},"Rx Bytes":{"95thpercentileValue":"14.783 M","minCollectionTime":"1669383479403","maxVal":"14.783 M","currVal":"3.626 M","minVal":"3.626 M","seriesName":"Rx Bytes","95thpercRawVal":"1.1226045333333334E7","avgVal":"11.734 M","95thperc":"11.226 M","maxCollectionTime":"1669364579398","95thpercVal":"11.226045333333333"},"Tx Bytes":{"95thpercentileValue":"48.097 M","minCollectionTime":"1669383479403","maxVal":"48.097 M","currVal":"18.031 M","minVal":"18.031 M","seriesName":"Tx Bytes","95thpercRawVal":"3.8807332333333336E7","avgVal":"40.134 M","95thperc":"38.807 M","maxCollectionTime":"1669371779404","95thpercVal":"38.807332333333335"}},"seriesNames":["Rx Bytes","Tx Bytes","Total Bytes"],"xyTitles":["Time","Bytes"],"graphData":[{"seriesname":"Rx Bytes","data":[[1669364579398,14.783359,"14.783 M"],[1669368179398,11.846604,"11.846 M"],[1669371779404,13.519316,"13.519 M"],[1669375379404,12.7214,"12.721 M"],[1669378979402,13.057771,"13.057 M"],[1669382579404,12.584193,"12.584 M"],[1669383479403,3.626988,"3.626 M"]]},{"seriesname":"Tx Bytes","data":[[1669364579398,46.577838,"46.577 M"],[1669368179398,38.532922,"38.532 M"],[1669371779404,48.097261,"48.097 M"],[1669375379404,41.533208,"41.533 M"],[1669378979402,44.321489,"44.321 M"],[1669382579404,43.847161,"43.847 M"],[1669383479403,18.031376,"18.031 M"]]},{"seriesname":"Total Bytes","data":[[1669364579398,61.361197,"61.361 M"],[1669368179398,50.379526,"50.379 M"],[1669371779404,61.616577,"61.616 M"],[1669375379404,54.254608,"54.254 M"],[1669378979402,57.37926,"57.379 M"],[1669382579404,56.431354,"56.431 M"],[1669383479403,21.658364,"21.658 M"]]}],"suffix":"M"}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>interfaceName*</b></div> <div class="divTableCell">Name of the interface - Managed Entity name as seen in the URL of interface snapshot page OR 'interfaceName' property value in the listInterfaces API response</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>graphName</b></div> <div class="divTableCell">Name of the interface graph [Example: totalPackets|traffic|utilization|errors|discardRate|packets|errorRate]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>isFluidic</b></div> <div class="divTableCell">Set as 'true' by default (for internal purpose)</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>period</b></div> <div class="divTableCell">Period for which the interface graph is required. [Example: twelvehours(16),Today(6),twfourhours(3),Yesterday(7),thisweek(8),Last_7_Days(4),lastweek(9),thismonth(10),Last_30_Days(5),Last_Month(11),custom(23)]</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>startDate</b></div> <div class="divTableCell">From Date. This parameter is applicable only if 'custom' time is opted in <b>period</b> param value</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>endDate</b></div> <div class="divTableCell">To Date. This parameter is applicable only if 'custom' time is opted in <b>period</b> param value</div> </div> </div> </div> </div> </div> </div> <div id="Monitoring" class="scroll-parent"> <h1>Monitoring</h1> <div id="getDeviceAssociatedMonitors" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getDeviceAssociatedMonitors</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the monitors associated to the device</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getDeviceAssociatedMonitors?apiKey=***************&name=devicename</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"performanceMonitors":{"total":6,"statusIcon":"images/servicestatus5.gif","down":0,"monitors":[{"DISPLAYNAME":"CPU Utilization","YAXISTEXT":"Percentage","graphType":"multiple","checkNumeric":"true","data":[{"instance":"-1","value":98}],"policyName":"WMI-CPUUtilization","Instance":"","THRESHOLDENABLED":"true","GRAPHID":"203","thresholdStatus":"Normal","isMultiple":"true","sSave":"true","type":"multiple","thresholdImg":"images/thresholdConOK.gif","lastCollectedTime":"16 Nov 2022 12:27:48 PM IST","DisplayColumn":"","pollId":"124","name":"WMI-CPUUtilization","numericType":"1","interval":"15","Protocol":"WMI"},{"DISPLAYNAME":"Memory Utilization","YAXISTEXT":"Percentage","graphType":"multiple","checkNumeric":"true","data":[{"instance":"-1","value":85}],"policyName":"WMI-MemoryUtilization","Instance":"","THRESHOLDENABLED":"true","GRAPHID":"204","thresholdStatus":"Normal","isMultiple":"true","sSave":"true","type":"multiple","thresholdImg":"images/thresholdConOK.gif","lastCollectedTime":"16 Nov 2022 12:27:33 PM IST","DisplayColumn":"","pollId":"125","name":"WMI-MemoryUtilization","numericType":"1","interval":"15","Protocol":"WMI"},{"DISPLAYNAME":"Partition Details of the Device(%)-C:","YAXISTEXT":"Percentage","graphType":"multiplenode","checkNumeric":"true","data":[{"instance":"-1","value":99}],"policyName":"WMI-PartitionDetails","Instance":"","THRESHOLDENABLED":"false","GRAPHID":"304","thresholdStatus":"Not Enabled","isMultiple":"false","sSave":"true","type":"node","thresholdImg":"images/thresholdNonConfigured.gif","lastCollectedTime":"16 Nov 2022 11:57:16 AM IST","DisplayColumn":"","pollId":"123","name":"C:","numericType":"1","interval":"60","Protocol":"WMI"},{"DISPLAYNAME":"Disk Utilization","YAXISTEXT":"Percentage","graphType":"multiple","checkNumeric":"true","data":[{"instance":"-1","value":99}],"policyName":"WMI-DiskUtilization","Instance":"","THRESHOLDENABLED":"false","GRAPHID":"205","thresholdStatus":"Not Enabled","isMultiple":"true","sSave":"true","type":"multiple","thresholdImg":"images/thresholdNonConfigured.gif","lastCollectedTime":"16 Nov 2022 11:57:16 AM IST","DisplayColumn":"","pollId":"122","name":"WMI-DiskUtilization","numericType":"1","interval":"60","Protocol":"WMI"}]},"deviceProtocol":"WMI","ntServiceMonitors":{"total":2,"statusIcon":"images/servicestatus1.gif","down":1,"monitors":[{"statusStr":"Clear","name":"DNS Server","serviceName":"DNS","serviceID":"4","moid":"405","status":"/images/devices/status5.gif","statusNum":"5"},{"statusStr":"Critical","name":"Telnet","serviceName":"TlntSvr","serviceID":"12","moid":"404","status":"/images/devices/status4.gif","statusNum":"1"}]},"fileMonitors":{"total":0,"statusIcon":"images/servicestatus5.gif","down":0,"monitors":[]},"adMonitors":{"total":39,"statusIcon":"images/servicestatus5.gif","down":0,"monitors":[{"YAXISTEXT":"Sessions","checkNumeric":"true","Description":"This monitor shows the number of connected Address Book client sessions.","data":[{"instance":"-1","value":0}],"statusStr":"Clear","severityIcon":"images/thresholdNonConfigured.gif","displayName":"AB Client Sessions","THRESHOLDENABLED":"false","GRAPHID":"605","groupingName":"Network","oid":"AD.Perf.ABClientSessions","PREVIOUSSEVERITY":"5","ID":"129","Protocol":"WMI","DISPLAYNAME":"AB Client Sessions","graphType":"node","thresholdFontColor":"#999999","policyName":"ABClientSessions","encodedName":"ABClientSessions","thresholdStatus":"Not Enabled","sSave":"true","statusNum":"5","lastCollectedTime":"16 Nov 2022 12:32:33 PM IST","name":"ABClientSessions","numericType":"1","interval":"15"}]},"folderMonitors":{"total":1,"statusIcon":"images/servicestatus5.gif","down":0,"monitors":[{"foldermonitorid":"259","folderpath":"C:\\Program Files","monitorname":"Local Directory","statusStr":"Clear","statusIcon":"/webclient/devices/images/servicestatus5.gif","state":"1","status":"5","statusNum":5}]},"isVM":false,"isHost":false,"serverMonitors":{"total":1,"down":0,"monitors":[{"portNo":"53","failureThreshold":1,"statusStr":"Clear","responseTime":"50","statusText":"Up","name":"DNS","THRESHOLDENABLED":"false","thresholdStatus":"Not Enabled","moid":"402","statusNum":"5"}]},"urlMonitors":{"total":1,"statusIcon":"images/servicestatus5.gif","down":0,"monitors":[{"compactURL":"http://localhost:8060/","availPercentage":"100.0","urlName":"localhost","stringstatus":"Clear","name":"localhost_URL","RESPONSETIME":"NA","completeURL":"http://localhost:8060/","deviceName":"localhost","url":"http://localhost:8060/","statusNum":"5"}]},"processMonitors":{"total":2,"statusIcon":"images/servicestatus5.gif","down":0,"monitors":[{"path":"C:\\Windows\\system32\\svchost.exe","statusStr":"Clear","cmdLineArgs":"-k UnistackSvcGroup","statusIcon":"/webclient/devices/images/servicestatus5.gif","name":"svchost.exe","state":"1","id":"407","proName":"svchost.exe","trimName":"svchost.exe","status":"5","statusNum":"5"},{"path":"C:\\Windows\\system32\\winlogon.exe","statusStr":"Clear","cmdLineArgs":"winlogon.exe","statusIcon":"/webclient/devices/images/servicestatus5.gif","name":"winlogon.exe","state":"1","id":"408","proName":"winlogon.exe","trimName":"winlogon.exe","status":"5","statusNum":"5"}]},"exchangeMonitors":{"total":30,"exchangeVersion":"Exchange 2016","statusIcon":"images/servicestatus5.gif","down":0,"monitors":[{"YAXISTEXT":"Calls","checkNumeric":"true","Description":"This monitor shows the number of calls disconnected after an internal system error occurred.","data":[{"instance":"-1","value":0}],"statusStr":"Clear","severityIcon":"images/thresholdNonConfigured.gif","displayName":"Calls Disconnected on Irrecoverable Internal Error","THRESHOLDENABLED":"false","GRAPHID":"1030","groupingName":"Unified Messaging Performance","oid":"Exchange.UMAvailability.CallsDisconnectedonIrrecoverableInternalError","PREVIOUSSEVERITY":"5","ID":"194","Protocol":"WMI","DISPLAYNAME":"Calls Disconnected on Irrecoverable Internal Error","graphType":"node","thresholdFontColor":"#999999","policyName":"CallsDisconnectedonIrrecoverableInternalError","encodedName":"CallsDisconnectedonIrrecoverableInternalError","thresholdStatus":"Not Enabled","sSave":"true","statusNum":"5","lastCollectedTime":"16 Nov 2022 12:27:39 PM IST","name":"CallsDisconnectedonIrrecoverableInternalError","numericType":"1","interval":"15"},{"YAXISTEXT":"%","checkNumeric":"true","Description":"This monitor shows the percentage of mailbox connection attempts that have failed in the last hour.","data":[{"instance":"-1","value":0}],"statusStr":"Clear","severityIcon":"images/thresholdNonConfigured.gif","displayName":"Percent of Failed Mailbox Connection Attempts Over the Last Hour","THRESHOLDENABLED":"false","GRAPHID":"1028","groupingName":"Unified Messaging Performance","oid":"Exchange.UMAvailability.PercentofFailedMailboxConnectionAttemptsOvertheLastHour","PREVIOUSSEVERITY":"5","ID":"185","Protocol":"WMI","DISPLAYNAME":"Percent of Failed Mailbox Connection Attempts Over the Last Hour","graphType":"node","thresholdFontColor":"#999999","policyName":"PercentofFailedMailboxConnectionAttemptsOvertheLastHour","encodedName":"PercentofFailedMailboxConnectionAttemptsOvertheLastHour","thresholdStatus":"Not Enabled","sSave":"true","statusNum":"5","lastCollectedTime":"16 Nov 2022 12:27:41 PM IST","name":"PercentofFailedMailboxConnectionAttemptsOvertheLastHour","numericType":"1","interval":"15"}]},"exchangeServices":{"total":15,"statusIcon":"images/servicestatus1.gif","down":14,"monitors":[{"displayName":"Microsoft Exchange Compliance Audit","description":"The Microsoft Exchange Compliance Audit service.","serviceMOID":368,"state":2,"serviceName":"MSComplianceAudit","serviceID":22,"status":4},{"displayName":"Microsoft Exchange Compliance Service","description":"Host for Compliance Services.","serviceMOID":369,"state":2,"serviceName":"MSExchangeCompliance","serviceID":23,"status":4},{"displayName":"Microsoft Exchange Health Manager Recovery","description":"Recovery Service for Health Manager","serviceMOID":370,"state":2,"serviceName":"MSExchangeHMRecovery","serviceID":24,"status":4},{"displayName":"Microsoft Exchange Mailbox Assistants","description":"Performs background processing of mailboxes in the Exchange store.","serviceMOID":361,"state":2,"serviceName":"MSExchangeMailboxAssistants","serviceID":15,"status":4},{"displayName":"Microsoft Exchange Monitoring","description":"Allows applications to call the Exchange diagnostic cmdlets.","serviceMOID":362,"state":2,"serviceName":"MSExchangeMonitoring","serviceID":16,"status":4},{"displayName":"Microsoft Exchange Notifications Broker","description":"The Microsoft Exchange Notifications Broker service provides generation and routing of Exchange notifications to local and remote Exchange processes.","serviceMOID":371,"state":2,"serviceName":"MSExchangeNotificationsBroker","serviceID":25,"status":4},{"displayName":"Microsoft Exchange Service Host","description":"Provides a host for several Exchange services.","serviceMOID":364,"state":2,"serviceName":"MSExchangeServiceHost","serviceID":18,"status":4},{"displayName":"Microsoft Exchange Throttling","description":"Limits the rate of user operations.","serviceMOID":365,"state":2,"serviceName":"MSExchangeThrottling","serviceID":19,"status":4},{"displayName":"Microsoft Exchange Unified Messaging Service","description":"Enables Microsoft Exchange Unified Messaging features.","serviceMOID":367,"state":2,"serviceName":"MSExchangeUM","serviceID":21,"status":4},{"displayName":"Microsoft Filtering Management Service","description":"Manages the queuing and dispatching of scan requests.","serviceMOID":372,"state":1,"serviceName":"FMS","serviceID":26,"status":5},{"displayName":"MS Exchange Active Directory Topology Service","description":"Provides Active Directory topology information to Exchange services.","serviceMOID":359,"state":2,"serviceName":"MSExchangeADTopology","serviceID":13,"status":4},{"displayName":"MS Exchange IMAP4","description":"Provides IMAP4 service to clients.","serviceMOID":360,"state":2,"serviceName":"MSExchangeImap4","serviceID":14,"status":4},{"displayName":"MS Exchange Information Store","description":"Information Store service - Stores all the user information, documents, messages and other informations. It contains user mail boxes where it stores user mails.","serviceMOID":358,"state":2,"serviceName":"MSExchangeIS","serviceID":12,"status":4},{"displayName":"MS Exchange POP3","description":"Provides POP3 service to clients.","serviceMOID":363,"state":2,"serviceName":"MSExchangePop3","serviceID":17,"status":4},{"displayName":"MS Exchange Transport","description":"The Microsoft Exchange Transport Service.","serviceMOID":366,"state":2,"serviceName":"MSExchangeTransport","serviceID":20,"status":4}]},"eventlogMonitors":{"period":"300","total":2,"statusIcon":"images/servicestatus5.gif","isActive":"true","down":0,"monitors":[{"ruleName":"Any Application failure","id":"2"},{"ruleName":"Any Directory Service failure","id":"45"}]},"scriptMonitors":{"total":1,"statusIcon":"images/servicestatus5.gif","down":0,"monitors":[{"checkNumeric":"true","data":[{"instance":"count","value":"17"}],"statusStr":"Clear","displayName":"Instance Count","thresholdSeverity":"Not Enabled","OID":"301","sSave":"true","statusNum":"5","lastCollectedTime":"16 Nov 2022 12:37:36 PM IST","pollid":"258","interval":"15","thresholdSevFont":"#999999","numericType":"1"}]},"adServices":{"total":11,"statusIcon":"images/servicestatus1.gif","down":1,"monitors":[{"displayName":"DFS Replication","description":"This service enables synchronizing folders on multiple servers across local or WAN network","serviceMOID":"346","serviceName":"DFSR","serviceID":"1","status":"5"},{"displayName":"DNS Client Service","description":"This service resolves and caches (Domain Name Server) DNS names.","serviceMOID":"347","serviceName":"Dnscache","serviceID":"2","status":"5"},{"displayName":"File Replication Service","description":"This service maintains file synchronization of file directory contents among multiple servers.","serviceMOID":"348","serviceName":"NtFrs","serviceID":"3","status":"4"},{"displayName":"Intersite Messaging Service","description":"This service is used for mail-based replication between sites. Active Directory includes support for replication between sites by using SMTP over IP transport.","serviceMOID":"349","serviceName":"IsmServ","serviceID":"4","status":"5"},{"displayName":"Kerberos Key Distribution Center Service","description":"This service enables users to log on to the network using the Kerberos version 5 authentication protocol.","serviceMOID":"350","serviceName":"kdc","serviceID":"5","status":"5"},{"displayName":"Net Logon Service","description":"This service supports pass-through authentication of account logon events for computers in a domain. ","serviceMOID":"351","serviceName":"Netlogon","serviceID":"6","status":"5"},{"displayName":"Remote Procedure Call (RPC) Service","description":"This service provides the name services for RPC clients.","serviceMOID":"352","serviceName":"RpcSs","serviceID":"7","status":"5"},{"displayName":"Security Accounts Manager Service","description":"This service signals other services that the Security Accounts Manager subsystem is ready to accept requests.","serviceMOID":"353","serviceName":"SamSs","serviceID":"8","status":"5"},{"displayName":"Server Service","description":"This service enables the computer to connect to other computers on the network based on the SMB protocol.","serviceMOID":"354","serviceName":"lanmanserver","serviceID":"9","status":"5"},{"displayName":"Windows Time service","description":"The service synchronizes the time between domain controllers, which prevents time skews from occurring.","serviceMOID":"355","serviceName":"W32Time","serviceID":"10","status":"5"},{"displayName":"Workstation Service","description":"This service provides network connections and communications.","serviceMOID":"356","serviceName":"lanmanworkstation","serviceID":"11","status":"5"}]}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>name*</b></div> <div class="divTableCell">Name of the device</div> </div> </div> </div> </div> </div> <div id="getPerformanceMonitors" class="scroll-topic"> <h2>Performance Monitors</h2> <div class="api-content-main"> <h3 class="mod-title">getPerformanceMonitors</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b> Lists all the available performance monitors for a particular device (based on the device's category and type)</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getPerformanceMonitors?apiKey=***************&deviceName=devicename&category=Desktop&type=Windows 2008 R2</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"General Monitors":[{"DISPLAYNAME":"SysUpTime","Description":"The time (in hundredths of a second) since the network management portion of the system was last re-initialized","name":"SysUpTime","isSelected":"false","GRAPHID":1166,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"General Monitors"},{"DISPLAYNAME":"Network Interfaces","Description":"The number of network interfaces (regardless of their current state) present on this system","name":"Number of Network Interfaces","isSelected":"false","GRAPHID":1167,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"General Monitors"},{"DISPLAYNAME":"IP Routing discards","Description":"The number of routing entries which were chosen to be discarded even though they are valid","name":"ipRoutingDiscards","isSelected":"false","GRAPHID":1168,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"General Monitors"}],"Performance Monitors":[{"DISPLAYNAME":"File Access Violations","Description":"Monitors the number of access permission violations encountered on this server.","name":"Win-FileAccessViolations","isSelected":"false","GRAPHID":4604,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"},{"DISPLAYNAME":"Number of System Errors","Description":"Monitors the number of system errors encountered on the server.","name":"Win-NumberOfSystemErrors","isSelected":"false","GRAPHID":4605,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"},{"DISPLAYNAME":"Number of installed services","Description":"Monitors the number of network services installed on this server.","name":"Win-NumberOfInstalledServices","isSelected":"false","GRAPHID":4606,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"},{"DISPLAYNAME":"Number of Shared Resources","Description":"Monitors the number of shared resources on this server.","name":"Win-NumberOfSharedResources","isSelected":"false","GRAPHID":4607,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"},{"DISPLAYNAME":"Number of Print Queued Jobs","Description":"Monitors the total number of print jobs that have been spooled on the server.","name":"Win-NumberOfPrintQueuedJobs","isSelected":"false","GRAPHID":4609,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"},{"DISPLAYNAME":"Logical Drive status","Description":"Monitors the status of logical drives. KEY: 2 - Ok, 3 - Failed, 10 - Overheating, 11 - Shutdown, 13 - notAvailable","name":"Win-LogicalDriveStatus","isSelected":"false","GRAPHID":4603,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"},{"DISPLAYNAME":"Number of Opened Files","Description":"Monitors the total number of files that have been opened on the server.","name":"Win-NumberOfOpenedFiles","isSelected":"false","GRAPHID":4608,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"},{"DISPLAYNAME":"Number of Failed Logins","Description":"Monitors the number of password violations encountered on the server.","name":"WinFailedLogins","isSelected":"false","GRAPHID":4610,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"}],"HOST-RESOURCES Monitors":[{"DISPLAYNAME":"CPU Utilization","Description":"Monitors the CPU Utilization based on HOSTRESOURCE MIB","name":"Win-CPUUtilization","isSelected":"false","GRAPHID":35,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Memory Utilization","Description":"Monitors the Memory Utilization","name":"Win-MemoryUtilization","isSelected":"false","GRAPHID":36,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Disk Utilization","Description":"Monitors the Disk Utilization","name":"DiskUtilization","isSelected":"false","GRAPHID":37,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Free Disk Space in GB","Description":"Monitors the free disk space in GB using SNMP","name":"Win-FreeDiskSpaceInGB","isSelected":"false","GRAPHID":276,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Free Disk Space in MB","Description":"Monitors the Free disk space in MB using SNMP","name":"Win-FreeDiskSpaceInMB","isSelected":"false","GRAPHID":277,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Used Disk Space in GB","Description":"Monitors the used disk space in GB","name":"Win-UsedDiskSpaceInGB","isSelected":"false","GRAPHID":278,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Used Disk Space in MB","Description":"Monitors the used disk space in MB using SNMP","name":"Win-UsedDiskSpaceInMB","isSelected":"false","GRAPHID":279,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Partition Details of the Device (%)","Description":"Monitoring the usage in each partition of the Device.","name":"PartitionWiseDiskDetails","isSelected":"false","GRAPHID":280,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"CPU Utilization(UCD SNMP MIB)","Description":"Monitors the CPU Utilization based on UCD SNMP MIB","name":"Lin-CPUUtilization","isSelected":"false","GRAPHID":330,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Process Count","Description":"Monitors the Number of Processes running in a machine.","name":"ProcessCount","isSelected":"false","GRAPHID":375,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Memory Utilization(UCD SNMP MIB)","Description":"Monitors the Memory utilization based on UCD SNMP MIB","name":"Lin-MemoryUtilization","isSelected":"false","GRAPHID":549,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"}],"Custom Monitor":[{"DISPLAYNAME":"ifSpeed","Description":"ifSpeed","name":"ifSpeed","isSelected":"false","GRAPHID":4646,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"true"}]}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName*</b></div> <div class="divTableCell">Name of the device</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>category*</b></div> <div class="divTableCell">Category of the device</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>type*</b></div> <div class="divTableCell">Type of the device</div> </div> </div> </div> </div> </div> <div id="getPerformanceMonitorDetails" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getPerformanceMonitorDetails</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists the details of an associated performance monitor from a particular device</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getPerformanceMonitorDetails?apiKey=***************&name=devicename&policyName=WMI-CPUUtilization&graphName=WMI-CPUUtilization&checkNumeric=true</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"statsList":[{"minimumValue":"84","averageValue":"85","instance":"PhysicalMemUtilization","percentile":"85","lastPolledValue":"86","maximumValue":"86"}],"monitors":{"YAXISTEXT":"Percentage","checkNumeric":"true","Description":"Monitors the Memory Utilization using WMI","Instance":"","THRESHOLDENABLED":"true","GRAPHID":"204","oid":"Memory Utilization","type":"multiple","PREVIOUSSEVERITY":"5","defaultMessage_AT":"$MONITOR is $CURRENTVALUE $UNITS,Expected value for this monitor is $EXPECTEDVALUE $UNITS, current adaptive threshold is $THRESHOLDVALUE $UNITS","defaultMessage":"$MONITOR is $CURRENTVALUE%, threshold value for this monitor is $THRESHOLDVALUE%","id":"125","Protocol":"WMI","FAILURETHRESHOLD":"1","DISPLAYNAME":"Memory Utilization","thresholdSet":[{"severity":"2","clrMessage":"$MONITOR is now back to normal, current value is $CURRENTVALUE $UNITS","troubleThresholdType":"max","troubleThresholdName":"1668514350868814042","troubleMessage":"$MONITOR is $CURRENTVALUE $UNITS,Expected value for this monitor is $EXPECTEDVALUE $UNITS, current adaptive threshold is $THRESHOLDVALUE $UNITS","oidType":"","rearmValue":"0","troubleThresholdValue":"15"},{"severity":"1","clrMessage":"$MONITOR is now back to normal, current value is $CURRENTVALUE $UNITS","criticalThresholdName":"1668514350869567781","criticalMessage":"$MONITOR is $CURRENTVALUE $UNITS,Expected value for this monitor is $EXPECTEDVALUE $UNITS, current adaptive threshold is $THRESHOLDVALUE $UNITS","criticalThresholdValue":"20","oidType":"","rearmValue":"0","isAtEnabled":true,"criticalThresholdType":"max"},{"severity":"3","clrMessage":"$MONITOR is now back to normal, current value is $CURRENTVALUE $UNITS","warningThresholdName":"1668514350867431743","warningMessage":"$MONITOR is $CURRENTVALUE $UNITS,Expected value for this monitor is $EXPECTEDVALUE $UNITS, current adaptive threshold is $THRESHOLDVALUE $UNITS","warningThresholdType":"max","oidType":"","warningThresholdValue":"10","rearmValue":"0","isAtEnabled":true}],"graphType":"multiple","policyName":"WMI-MemoryUtilization","agentName":"localhost","isMultiple":"true","sSave":"true","defaultClrMessage":"$MONITOR is now back to normal, current value is $CURRENTVALUE%","DisplayColumn":"","name":"WMI-MemoryUtilization","numericType":"1","interval":"15","Id":"125","isAtEnabled":true}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> <div class="divTableCell">Note</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> <div class="divTableCell">-</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>name*</b></div> <div class="divTableCell">Name of the device</div> <div class="divTableCell">-</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>policyName*</b></div> <div class="divTableCell">Policy name of the performance monitor</div> <div class="divTableCell">-</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>graphName*</b></div> <div class="divTableCell">Graph name of the performance monitor.</div> <div class="divTableCell">The "policyName" and "graphName" values can be obtained from <b>getDeviceAssociatedMonitors</b> API</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>checkNumeric*</b></div> <div class="divTableCell">true (or) false.</div> <div class="divTableCell">-</div> </div> </div> </div> </div> </div> <div id="addPerformanceMonitors" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">addPerformanceMonitors</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>Adds a new performance monitor (or multiple performance monitors) to the device</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/addPerformanceMonitors?apiKey=***************&name=devicename&selectedMonitors=1166,3337,304,204,205,203,3327</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"result":{"message":"Monitor added successfully"}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> <div class="divTableCell">Note</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> <div class="divTableCell">-</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>name*</b></div> <div class="divTableCell">Name of the device</div> <div class="divTableCell">-</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>selectedMonitors*</b></div> <div class="divTableCell">GraphID of the performance monitor(s) to be added (multiple values separated by commas).</div> <div class="divTableCell">The GraphID value(s) can be obtained from <b>getPerformanceMonitors</b> API</div> </div> </div> </div> </div> </div> <div id="deletePerformanceMonitors" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">deletePerformanceMonitors</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>Deletes performance monitor(s) from the device</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/deletePerformanceMonitors?apiKey=***************&name=devicename&pollId=332,213</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"result":{"message":"The monitor(s) will be deleted. Please check after sometime."}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> <div class="divTableCell">Note</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> <div class="divTableCell">-</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>name*</b></div> <div class="divTableCell">Name of the device</div> <div class="divTableCell">-</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>pollId*</b></div> <div class="divTableCell">pollId of the performance monitor (multiple values separated by commas).</div> <div class="divTableCell">The pollId value(s) can be obtained from <b>getDeviceAssociatedMonitors</b> API</div> </div> </div> </div> </div> </div> <div id="TestMonitor" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">TestMonitor</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>Tests a performance monitor in a particular device</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/TestMonitor?apiKey=***************&name=devicename&policyName=WMI-MemoryUtilization&graphName=WMI-MemoryUtilization</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"protocol":"SNMP","checkNumeric":"true","reasons":[],"monitorname":"Win-MemoryUtilization","data":[89],"displayName":"Memory Utilization","isMultiple":"false","oid":".1.3.6.1.2.1.25.5.1.1.2","units":"Percentage","deviceName":"localhost"}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> <div class="divTableCell">Note</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> <div class="divTableCell">-</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>name*</b></div> <div class="divTableCell">Name of the device</div> <div class="divTableCell">-</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>policyName*</b></div> <div class="divTableCell">Policy name of the monitor</div> <div class="divTableCell">-</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>graphName*</b></div> <div class="divTableCell">Graph name of the monitor.</div> <div class="divTableCell">The "policyName" and "graphName" values can be obtained from <b>getDeviceAssociatedMonitors</b> API</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>instanceName</b></div> <div class="divTableCell">Instance name (only applicable for MSSQL monitors).</div> <div class="divTableCell">-</div> </div> </div> </div> </div> </div> <div id="getAssociatedProcessMonitors" class="scroll-topic"> <h2>Process Monitors</h2> <div class="api-content-main"> <h3 class="mod-title">getAssociatedProcessMonitors</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Fetches the list of process monitors that have been associated to a device</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getAssociatedProcessMonitors?apiKey=***************&deviceName=devicename</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"protocol":"WMI","Templates":[{"protocol":"CLI","associatedDeviceCount":"0","templateName":"httpd","displayName":"httpd","description":"Process Template for httpd","templateId":"2"},{"protocol":"WMI","associatedDeviceCount":"2","templateName":"sqlservr.exe","displayName":"MSSQL","description":"Process Template for MSSQL","templateId":"1"}],"AssignedMonitors":[{"path":"C:\\Program Files\\Microsoft SQL Server\\MSSQL\\Binn\\sqlservr.exe","statusStr":"Clear","cmdLineArgs":"","statusIcon":"/webclient/devices/images/servicestatus5.gif","name":"MSSQL","state":"1","id":"611","proName":"sqlservr.exe","trimName":"MSSQL","status":"5","statusNum":"5"}],"ActiveProcesses":{"7244":{"path":"C:\\Windows\\System32\\msdtc.exe","trimArgs":"","trimPath":"C:\\Windows\\System32\\msdtc.exe","cmdLineArgs":"","name":"msdtc.exe","trimName":"msdtc.exe"},"3680":{"path":"C:\\Windows\\system32\\SearchIndexer.exe","trimArgs":"/Embedding","trimPath":"C:\\Windows\\system32\\SearchIndexer.exe","cmdLineArgs":"/Embedding","name":"SearchIndexer.exe","trimName":"SearchIndexer.exe"},"4692":{"path":"-","trimArgs":"","trimPath":"-","cmdLineArgs":"","name":"csrss.exe","trimName":"csrss.exe"},"1473196":{"path":"C:\\Program Files (x86)\\DesktopCentral_Agent\\appctrl\\bin\\DriverCtrl.exe","trimArgs":" ","trimPath":"C:\\Program Files (x86)\\DesktopCentral_Ag...","cmdLineArgs":" ","name":"DriverCtrl.exe","trimName":"DriverCtrl.exe"},"4652":{"path":"C:\\Windows\\system32\\winlogon.exe","trimArgs":"winlogon.exe","trimPath":"C:\\Windows\\system32\\winlogon.exe","cmdLineArgs":"winlogon.exe","name":"winlogon.exe","trimName":"winlogon.exe"},"1473196":{"path":"C:\\Program Files (x86)\\DesktopCentral_Agent\\appctrl\\bin\\DriverCtrl.exe","trimArgs":" ","trimPath":"C:\\Program Files (x86)\\DesktopCentral_Ag...","cmdLineArgs":" ","name":"DriverCtrl.exe","trimName":"DriverCtrl.exe"},"4652":{"path":"C:\\Windows\\system32\\winlogon.exe","trimArgs":"winlogon.exe","trimPath":"C:\\Windows\\system32\\winlogon.exe","cmdLineArgs":"winlogon.exe","name":"winlogon.exe","trimName":"winlogon.exe"}},"deviceName":"localhost"}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName*</b></div> <div class="divTableCell">Name of the device</div> </div> </div> </div> </div> </div> <div id="associateProcessMonitor" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">associateProcessMonitor</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>Associates process monitor(s) to a device</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/associateProcessMonitor?apiKey=***************&deviceName=devicename&processId=408,8,68&protocol=WMI</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"result":{"message":"Process monitor(s) associated successfully."}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> <div class="divTableCell">Note</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> <div class="divTableCell">-</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName*</b></div> <div class="divTableCell">Name of the device.</div> <div class="divTableCell">-</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>processId*</b></div> <div class="divTableCell">ID of the processes that need to be associated</div> <div class="divTableCell">The processId value(s) can be obtained from <b>getAssociatedProcessMonitors</b> API</div> </div> </div> </div> </div> </div> <div id="getAssociatedServiceMonitors" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getAssociatedServiceMonitors</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Fetches the list of service monitors that have been associated to a device</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getAssociatedServiceMonitors?apiKey=***************&name=devicename</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"remainingServices":["DNS(53)","Echo(7)","FTP(21)","HTTPS(443)","IMAP(143)","LDAP(389)","MSSQL(1433)","MySQL(3306)","NNTP(119)","Oracle(1521)","POP(110)","SMTP(25)","Telnet(23)","Web(80)","WebLogic(7001)"],"selectedServices":["MSSQL(1433)"]}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>name*</b></div> <div class="divTableCell">Name of the device</div> </div> </div> </div> </div> </div> <div id="associateServiceMonitor" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">associateServiceMonitor</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>Associates service monitor(s) to a device</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/admin/associateServiceMonitor?apiKey=***************&deviceName=devicename&serviceName=DNS,FTP,Echo</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"result":{"message":"Service Monitor associated successfully"}}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName*</b></div> <div class="divTableCell">Name of the device for which the service to be associated. Give the names by comma separated for bulk association</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>serviceName*</b></div> <div class="divTableCell">Name of the service(s) (multiple values separated by commas).</div> </div> </div> </div> </div> </div> <div id="getDeviceAssociatedWindowsServiceMonitors" class="scroll-topic"> <h2>Windows Service Monitors</h2> <div class="api-content-main"> <h3 class="mod-title">getDeviceAssociatedWindowsServiceMonitors</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists the associated Windows Service Monitors for a device</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getDeviceAssociatedWindowsServiceMonitors?apiKey=***************&name=devicename</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"displayName": "Diagnostic Service Host","serviceName": "WdiServiceHost","serviceID": "349","status": "Critical"},{"displayName": "Diagnostic System Host","serviceName": "WdiSystemHost","serviceID": "350","status": "Critical"},{"displayName": "Print Spooler","serviceName": "Spooler","serviceID": "1","status": "Clear"}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>name*</b></div> <div class="divTableCell">Name of the device</div> </div> </div> </div> </div> </div> <div id="listURLMonitors" class="scroll-topic"> <h2>URL Monitors</h2> <div class="api-content-main"> <h3 class="mod-title">listURLMonitors</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the global URL monitors available in OpManager</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/admin/listURLMonitors?apiKey=***************</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"List":[{"availPercentage":0,"urlName":"Google","statusStr":"Service Down","name":"Google_URL","RESPONSETIME":"No Response","url":"http://www.google.com","moID":961,"statusNum":4},{"availPercentage":0,"urlName":"HTTP Url","statusStr":"Service Down","name":"HTTP Url_URL","RESPONSETIME":"No Response","url":"http://localhost:8060","moID":996,"statusNum":4},{"availPercentage":0,"urlName":"HTTPS Url","statusStr":"Service Down","name":"HTTPS Url_URL","RESPONSETIME":"No Response","url":"https://www.zoho.com","moID":997,"statusNum":4}],"Details":{"00-10%":[{"Status":4,"Label":"Service Down","Count":6}]},"DialCounter":[{"title":"Service Down","value":6,"status":4}]}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> </div> </div> </div> </div> <div id="listAllDevicesSpecificURLs" class="scroll-topic"> <h2>URL Monitors</h2> <div class="api-content-main"> <h3 class="mod-title">listAllDevicesSpecificURLs</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the device-specific URL monitors available in OpManager</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8061/api/json/admin/listAllDevicesSpecificURLs?apiKey=***************</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"List":[{"parentName":"localhost","urlName":"URL_1","stringstatus":"Clear","parentDispName":"localhost","name":"URL_1_URL","url":"https://google.com","status":"5","statusNum":"5"},{"parentName":"localhost","urlName":"URL_2","stringstatus":"Clear","parentDispName":"localhost","name":"URL_2_URL","url":"https://google.com","status":"5","statusNum":"5"}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> </div> </div> </div> </div> <div id="listScriptMonitors" class="scroll-topic"> <h2>Script Monitors</h2> <div class="api-content-main"> <h3 class="mod-title">listScriptMonitors</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the script templates available in OpManager</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/admin/listScriptMonitors?apiKey=***************</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"graphName":"Cache Memory","scriptID":"102","executeFrom":"1","graphDesc":"Perl Script to get cache memory of a linux system","graphID":"1207"},{"graphName":"File Size","scriptID":"103","executeFrom":"1","graphDesc":"Shell script to get memory size of a file in linux system","graphID":"1208"},{"graphName":"Instance Count","scriptID":"101","executeFrom":"0","graphDesc":"VBScript to get number of instances running for a given process","graphID":"1206"},{"graphName":"Thread Count","scriptID":"104","executeFrom":"0","graphDesc":"Powershell script to get thread count of a process","graphID":"1209"}] </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> </div> </div> </div> </div> </div> <div id="Notifications" class="scroll-parent"> <h1>Notifications</h1> <div id="listNotificationProfiles" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">listNotificationProfiles</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>This API is used to list all the Notification Profiles created in OpManager.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/admin/listNotificationProfiles?apiKey=***************&isGlobal=true&profileFilter=All&deviceName=devicename</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"profileName":"Play Sound","hasSubProfiles":false,"profileType":"Run Program","profileLabel":"Run Program","profileID":"1","hasCriteria":false,"isDevice":false,"status":"true"}, {"profileName":"testProfile","hasSubProfiles":false,"profileType":"Send Email","profileLabel":"Send Email","profileID":"301","isDevice":false,"hasAssociated":true,"status":"true"}] </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>isGlobal</b></div> <div class="divTableCell">false - To list all the Device Specific Profiles</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>profileFilter</b></div> <div class="divTableCell">All / Send Email / Send SMS / Send Modem SMS / Run System Command / Run Program / Log a Ticket / Web Alarm / Send SysLog / Send Trap / Chat / SDPOnDemand / Webhook (<strong>All</strong> - To list all the Global Profiles / <strong>Any one of other values</strong> - To list that particular type of Global Profiles)</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName</b></div> <div class="divTableCell">Name of the device - To list all Global Proflies with device association hint in it. (The value of hasAssociated key in API response will be "true", if that particular Notification profile is associated to the given device name)</div> </div> </div> </div> <p><strong>Note:</strong></p> <ol> <li>The API gives expected results, only with two parameters selected. The parameter <strong>apiKey</strong> is a mandatory parameter, and select one of the remaining three parameters and use it as per your requirement.</li> <li>Notification Profiles that are created from <strong>Inventory->Device->Device Snapshot page->Click on the mail icon from top right panel->Add option</strong> are called as <strong>Device Specific profiles.</strong></li> <li>Notification Profiles that are created from <strong>Settings->Notification->Add option</strong> are called as <strong>Global profiles.</strong></li> </ol> </div> </div> <div id="associateNotificationProfiles" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">associateNotificationProfiles</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>This API is used to associate notification profiles to devices.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/admin/associateNotificationProfiles?apiKey=***************&deviceName=devicename&profiles=501</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"result":{"message":"Notification Profile has been associated successfully"}} </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName*</b></div> <div class="divTableCell">Name of the devices to be associated</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>profiles*</b></div> <div class="divTableCell">ProfileID of the profiles to be associated.</div> </div> </div> </div> </div> </div> <div id="updateNotificationProfileStatus" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">updateNotificationProfileStatus</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>This API is used to enable/disable notification profiles. This API will be available from OpManager version 127189</p> <p><b>Sample URL: </b><code class="wrap-txt"> https://localhost:8060/api/json/admin/updateNotificationProfileStatus?apiKey=***************&profileName=testprofile&profileId=301&status=disable</code></p> <p class="yellow-box1"><b>Sample Response:</b><code>{"message":"Notification Profile(s) enabled successfully"} or {"message":"Notification Profile(s) disabled successfully"}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>profileName*</b></div> <div class="divTableCell">Name of the profile which has to be enabled/disabled</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>profileId*</b></div> <div class="divTableCell">ID of the profile which has to be enabled/disabled</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>status*</b></div> <div class="divTableCell">enable or disable</div> </div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName</b></div> <div class="divTableCell">Name of the device on which the Notification profile is created. [Only for Device Specific Notification Profiles and not required for Global Notification Profiles]</div> </div> </div> </div> </div> <div id="getNotificationProfileS" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getNotificationProfiles</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>This API is used to list notification profiles specific to the device.</p> <p><b>Sample URL: </b><code class="wrap-txt"> https://localhost:8060/api/json/device/getNotificationProfiles?apiKey=***************&name=devicename</code></p> <p class="yellow-box1"><b>Sample Response:</b><code>[{"profileName":"Default Notification Profile","actionDisplayName":"Send Email","profileLabel":"Send Email","criteriaId":"301","profileId":"601","isGlobal":true,"actionName":"Send Email","status":"true"}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>name*</b></div> <div class="divTableCell">Name of the device for which the profiles has to be listed</div> </div> </div> </div> </div> </div> </div> <div id="Reports" class="scroll-parent"> <h1>Reports</h1> <div id="getAdvancedReportData" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getAdvancedReportData</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>getAdvancedReportData functions based on lazy loading. When the first API call is made, it will give the count of the rows present in the report as a response. The subsequent API calls will bring the appropriate response based on the specified params.</p> <p><b>Example:</b><br /> Make the listAllAdvancedReports API call to get the reportId data. Then make the getAdvancedReportData API call subsequently.</p> <p><strong>First API Call: </strong><code class="wrap-txt">https://<Host>:<port>/api/json/reports/getAdvancedReportData?getColumnDetails=true&reportID=901&apiKey=***********************************</code></p> <p><strong>Params:</strong> getColumnDetails=true, reportID=901, apiKey=**********************************************</p> <p class="yellow-box1"><b>Sample Response: </b><code>{ "headers": [ "Availability (%)", "Up time", "On Hold time", "Maintenance Time", "Parent Down Time", "Dependent Down Time", "Down time" ], "total": 1, "groupByCount": 0, "reportID": "6903", "reportName": "sdfsf", "records": 1, "totalColumns": 7, "groupHeader": [] }</code></p> <p><strong>Response</strong>:<br /> {<br /> deviceNameIndex: 0<br /> groupByCount: 0<br /> groupHeader: []<br /> headers: ["Device Name", "Status", "Availability (%)"]<br /> moduleId: "1"<br /> records: 4289<br /> total: 86<br /> totalColumns: 3<br /> }</p> <p><b>Note: </b>Records represent the total number of rows present in the report. Depending on the records (the number of rows) you can decide the number of API calls to be made. In a single API call, you can get up to 1000 rows. So, if your report has 5000 rows totally, you have to make 5 consecutive API calls to get the complete data.</p> <p><b>Consecutive API calls</b></p> <p><code class="wrap-txt">https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=1&rowsToFetch=1000&reportId=901&apiKey=*********************************** </code><br /> <code class="wrap-txt">https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=1001&rowsToFetch=1000&reportId=901&apiKey=*********************************** </code><br /> <code class="wrap-txt">https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=2001&rowsToFetch=1000&reportId=901&apiKey=*********************************** </code><br /> <code class="wrap-txt">https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=3001&rowsToFetch=1000&reportId=901&apiKey=***********************************</code> <br /> <code class="wrap-txt">https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=4001&rowsToFetch=289&reportId=901&apiKey=*********************************** </code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{ "total": 1, "reportID": "6903", "reportName": "Report 1", "records": 1, "page": "1", "rows": [ { "Maintenance Time": "0 seconds", "Maintenance Time": "0 seconds", "Availability (%)": "0", "name": "Ground Floor ADServer", "On Hold time": "0 seconds", "Down time": "23 hours 0 minutes 0 seconds", "Dependent Down Time": "0 seconds", "Up time": "0 seconds", "moName": "xxx.xx.xxx.xxx.x0000000001", "moid": 20000049227 } ], "headerKeyVsTypeMap": { "Maintenance Time": 2, "Parent Down Time": 2, "Availability (%)": 2, "name": 12, "On Hold time": 2, "Down time": 2, "Dependent Down Time": 2, "Up time": 2, "moid": -5 } }</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>rowsToFetch</b></div> <div class="divTableCell">Number of Rows to Fetch -- range is from 1 to 1000</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>fetchFromRowNumber</b></div> <div class="divTableCell">Specifies the starting number of rows to fetch the data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>getOnlyColumnDetails</b></div> <div class="divTableCell">Specify either true or false. If true, Report MetaData will be returned, if false, remaining parameters should be sent mandatory.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>reportId</b></div> <div class="divTableCell">Unique and varies for each report</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>apiKey</b></div> <div class="divTableCell">An apiKey enables you to access OpManager server.</div> </div> </div> </div> </div> </div> <div id="getReportsList" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getReportsList</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>This API is to list all the reports</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/reports/getReportsList?apiKey=***************&isFavouriteNeeded=true&hideintegratedReports=true&hideHardwareReport=true</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[ { "displayName": "System", "list": [ { "list": [ { "customStatus": "False", "displayName": "Notification Profiles Triggered", "isCustom": "false", "id": 6, "url": "/reports/GenerateReports.do?firstTime=true&reportID=6", "Name": "Notification Profiles Triggered", "desc": "Get report of notification profiles triggered" }, { "customStatus": "False", "displayName": "Downtime Scheduler Log", "isCustom": "false", "id": 7, "url": "/reports/GenerateReports.do?firstTime=true&reportID=7", "Name": "Downtime Scheduler Log", "desc": "Get report of downtime scheduler log" }, { "customStatus": "False", "displayName": "Schedule Reports Log", "isCustom": "false", "id": 8, "url": "/reports/GenerateReports.do?firstTime=true&reportID=8", "Name": "Schedule Reports Log", "desc": "Get report of schedule reports log" }, { "customStatus": "False", "displayName": "All Down Events", "isCustom": "false", "id": 2, "url": "/reports/GenerateReports.do?firstTime=true&reportID=2", "Name": "All Down Events", "desc": "Get report for all down events" }, { "customStatus": "False", "displayName": "All Alerts", "isCustom": "false", "id": 84, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=84", "Name": "All Alerts", "desc": "Get report for all alerts" }, { "customStatus": "False", "displayName": "All Events", "isCustom": "false", "id": 1, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=1", "Name": "All Events", "desc": "Get report for all events" }, { "customStatus": "False", "displayName": "All Down Alerts", "isCustom": "false", "id": 85, "url": "/reports/GenerateReports.do?firstTime=true&reportID=85", "Name": "All Down Alerts", "desc": "Get report for all down alerts" }, { "customStatus": "False", "displayName": "SNMP Trap Log", "isCustom": "false", "id": 3, "url": "/reports/GenerateReports.do?firstTime=true&reportID=3", "Name": "SNMP Trap Log", "desc": "Get SNMP trap log report" }, { "customStatus": "False", "displayName": "Windows Event Log", "isCustom": "false", "id": 4, "url": "/reports/GenerateReports.do?firstTime=true&reportID=4", "Name": "Windows Event Log", "desc": "Get windows event log report" }, { "customStatus": "False", "displayName": "Performance Monitor Error Log", "isCustom": "false", "id": 5, "url": "/reports/GenerateReports.do?firstTime=true&reportID=5", "Name": "Performance Monitor Error Log", "desc": "Get performance monitor error log report" }, { "customStatus": "False", "displayName": "All Alerts with Notes", "isCustom": "false", "id": 721, "url": "/reports/GenerateReports.do?firstTime=true&reportID=721", "Name": "All Alerts with Notes", "desc": "Get report for all alerts with Notes" }, { "customStatus": "False", "displayName": "Top SysLog Count by Source", "isCustom": "false", "id": 95, "url": "/reports/GenerateReports.do?firstTime=true&reportID=95", "Name": "webclient.top.syslog.reports", "desc": "Top N devices with most number of SysLogs" }, { "customStatus": "False", "displayName": "Top EventLog Count by Source", "isCustom": "false", "id": 94, "url": "/reports/GenerateReports.do?firstTime=true&reportID=94", "Name": "webclient.top.eventlog.reports", "desc": "Top N devices with most number of EventLogs" }, { "customStatus": "False", "displayName": "Top Trap Count by Source", "isCustom": "false", "id": 93, "url": "/reports/GenerateReports.do?firstTime=true&reportID=93", "Name": "webclient.top.trap.reports", "desc": "Top N devices with most number of Traps" }, { "customStatus": "False", "displayName": "Suppressed Devices", "isCustom": "false", "id": 92, "url": "/reports/GenerateReports.do?firstTime=true&reportID=92", "Name": "webclient.suppress.devices.reports", "desc": "Get report for suppressed devices" }, { "customStatus": "False", "displayName": "DataCollection Error Logs", "isCustom": "false", "id": 151, "url": "/reports/GenerateReports.do?firstTime=true&reportID=151", "Name": "widget.name.dataCollectionLog", "desc": "Get datacollection failure details" }, { "customStatus": "False", "displayName": "Active Alerts", "isCustom": "false", "id": 149, "url": "/reports/GenerateReports.do?firstTime=true&reportID=149", "Name": "webclient.report.name.activealarms", "desc": "Get report for active alerts" }, { "customStatus": "False", "displayName": "Workflow Logs", "isCustom": "false", "id": 90, "url": "/reports/GenerateReports.do?firstTime=true&reportID=90", "Name": "Workflow Logs", "desc": "Workflow logs report" }, { "customStatus": "False", "displayName": "Syslog Events", "isCustom": "false", "id": 88, "url": "/reports/GenerateReports.do?firstTime=true&reportID=88", "Name": "Syslog Events", "desc": "Get Syslog events report " }, { "displayName": "DataCollection Error Logs for N Consecutive Time(s)", "id": "ServerHealthReport", "desc": "Get datacollection failure details for N consecutive times" }, { "displayName": "Audit Report", "id": "Audit", "url": "/reports/AuditReport.do", "desc": "Audit Report" } ], "title": "" } ], "Name": "System" }, { "displayName": "Health and Performance", "list": [ { "list": [ { "customStatus": "True", "displayName": "Servers by Rx Utilization", "isCustom": "true", "id": 28, "url": "/reports/GenerateReports.do?firstTime=true&reportID=28", "Name": "Servers by Rx Utilization", "desc": "Identify servers with heavy incoming traffic utilization" }, { "customStatus": "True", "displayName": "Servers by Tx Utilization", "isCustom": "true", "id": 29, "url": "/reports/GenerateReports.do?firstTime=true&reportID=29", "Name": "Servers by Tx Utilization", "desc": "Identify servers with heavy outgoing traffic utilization" }, { "customStatus": "True", "displayName": "Volumes with Least Free Space", "isCustom": "true", "id": 30, "url": "/reports/GenerateReports.do?firstTime=true&reportID=30", "Name": "Volumes with Least Free Space", "desc": "Identify disk partitions with least free space" }, { "customStatus": "True", "displayName": "Volumes with Most Free Space", "isCustom": "true", "id": 31, "url": "/reports/GenerateReports.do?firstTime=true&reportID=31", "Name": "Volumes with Most Free Space", "desc": "Identify disk partitions with most free space" }, { "customStatus": "True", "displayName": "All Servers Disk Usage Report", "isCustom": "true", "id": 32, "url": "/reports/GenerateReports.do?firstTime=true&reportID=32", "Name": "All Servers Disk Usage Report", "desc": "Get partition wise disk usage report for all servers" }, { "customStatus": "True", "displayName": "Routers Health Report", "isCustom": "true", "id": 33, "url": "/reports/GenerateReports.do?firstTime=true&reportID=33", "Name": "Routers Health Report", "desc": "Get health report of routers" }, { "customStatus": "True", "displayName": "Routers by CPU Utilization", "isCustom": "true", "id": 34, "url": "/reports/GenerateReports.do?firstTime=true&reportID=34", "Name": "Routers by CPU Utilization", "desc": "Identify busy routers with high CPU Utilization" }, { "customStatus": "True", "displayName": "Routers by Memory Utilization", "isCustom": "true", "id": 35, "url": "/reports/GenerateReports.do?firstTime=true&reportID=35", "Name": "Routers by Memory Utilization", "desc": "Identify overloaded routers with high Memory Utilization" }, { "customStatus": "True", "displayName": "Router Interfaces by Rx Traffic", "isCustom": "true", "id": 36, "url": "/reports/GenerateReports.do?firstTime=true&reportID=36", "Name": "Router Interfaces by Rx Traffic", "desc": "Identify interfaces with heavy incoming traffic" }, { "customStatus": "True", "displayName": "Router Interfaces by Tx Traffic", "isCustom": "true", "id": 37, "url": "/reports/GenerateReports.do?firstTime=true&reportID=37", "Name": "Router Interfaces by Tx Traffic", "desc": "Identify interfaces with heavy outgoing traffic" }, { "customStatus": "True", "displayName": "Router Interfaces by Rx Errors", "isCustom": "true", "id": 38, "url": "/reports/GenerateReports.do?firstTime=true&reportID=38", "Name": "Router Interfaces by Rx Errors", "desc": "Identify interfaces with high incoming errors" }, { "customStatus": "True", "displayName": "Router Interfaces by Tx Errors", "isCustom": "true", "id": 39, "url": "/reports/GenerateReports.do?firstTime=true&reportID=39", "Name": "Router Interfaces by Tx Errors", "desc": "Identify interfaces with high incoming errors" }, { "customStatus": "True", "displayName": "Router Interfaces by Rx Utilization", "isCustom": "true", "id": 40, "url": "/reports/GenerateReports.do?firstTime=true&reportID=40", "Name": "Router Interfaces by Rx Utilization", "desc": "Identify interfaces with high % Receive utilization" }, { "customStatus": "True", "displayName": "Router Interfaces by Tx Utilization", "isCustom": "true", "id": 41, "url": "/reports/GenerateReports.do?firstTime=true&reportID=41", "Name": "Router Interfaces by Tx Utilization", "desc": "Identify interfaces with high % Transmit utilization" }, { "customStatus": "True", "displayName": "Switches Health Report", "isCustom": "true", "id": 42, "url": "/reports/GenerateReports.do?firstTime=true&reportID=42", "Name": "Switches Health Report", "desc": "Get health report of switches" }, { "customStatus": "True", "displayName": "Ports by Rx Traffic", "isCustom": "true", "id": 43, "url": "/reports/GenerateReports.do?firstTime=true&reportID=43", "Name": "Ports by Rx Traffic", "desc": "Identify ports with heavy incoming traffic" }, { "customStatus": "True", "displayName": "Ports by Tx Traffic", "isCustom": "true", "id": 44, "url": "/reports/GenerateReports.do?firstTime=true&reportID=44", "Name": "Ports by Tx Traffic", "desc": "Identify ports with heavy outgoing traffic" }, { "customStatus": "True", "displayName": "Ports by Rx Errors", "isCustom": "true", "id": 45, "url": "/reports/GenerateReports.do?firstTime=true&reportID=45", "Name": "Ports by Rx Errors", "desc": "Identify ports with most Receive errors" }, { "customStatus": "True", "displayName": "Ports by Tx Errors", "isCustom": "true", "id": 46, "url": "/reports/GenerateReports.do?firstTime=true&reportID=46", "Name": "Ports by Tx Errors", "desc": "Identify ports with most Transmit errors" }, { "customStatus": "True", "displayName": "Ports by Tx Utilization", "isCustom": "true", "id": 48, "url": "/reports/GenerateReports.do?firstTime=true&reportID=48", "Name": "Ports by Tx Utilization", "desc": "Identify ports with high % Transmit utilization" }, { "customStatus": "True", "displayName": "DCs by CPU Utilization", "isCustom": "true", "id": 49, "url": "/reports/GenerateReports.do?firstTime=true&reportID=49", "Name": "DCs by CPU Utilization", "desc": "Identify busy DCs with high CPU Utilization" }, { "customStatus": "True", "displayName": "DCs by Memory Utilization", "isCustom": "true", "id": 50, "url": "/reports/GenerateReports.do?firstTime=true&reportID=50", "Name": "DCs by Memory Utilization", "desc": "Identify overloaded DCs with high Memory Utilization" }, { "customStatus": "True", "displayName": "DCs by Disk Utilization", "isCustom": "true", "id": 51, "url": "/reports/GenerateReports.do?firstTime=true&reportID=51", "Name": "DCs by Disk Utilization", "desc": "Identify overloaded DCs with high Disk Utilization" }, { "customStatus": "True", "displayName": "Ports by Rx Utilization", "isCustom": "true", "id": 47, "url": "/reports/GenerateReports.do?firstTime=true&reportID=47", "Name": "Ports by Rx Utilization", "desc": "Identify ports with high % Receive utilization" }, { "customStatus": "False", "displayName": "Health Report", "isCustom": "false", "id": 9, "url": "/reports/GenerateReports.do?firstTime=true&reportID=9", "Name": "Health Report", "desc": "Get health report of all devices" }, { "customStatus": "False", "displayName": "Devices by CPU Utilization", "isCustom": "false", "id": 10, "url": "/reports/GenerateReports.do?firstTime=true&reportID=10", "Name": "Devices by CPU Utilization", "desc": "Identify overloaded devices with high CPU Utilization" }, { "customStatus": "False", "displayName": "Devices by Memory Utilization", "isCustom": "false", "id": 11, "url": "/reports/GenerateReports.do?firstTime=true&reportID=11", "Name": "Devices by Memory Utilization", "desc": "Identify overloaded devices with high Memory Utilization" }, { "customStatus": "False", "displayName": "Devices by Disk Utilization", "isCustom": "false", "id": 12, "url": "/reports/GenerateReports.do?firstTime=true&reportID=12", "Name": "Devices by Disk Utilization", "desc": "Identify overloaded devices with high Disk Utilization" }, { "customStatus": "False", "displayName": "Disk Usage by Drives", "isCustom": "false", "id": 13, "url": "/reports/GenerateReports.do?firstTime=true&reportID=13", "Name": "Disk Usage by Drives", "desc": "Identify overloaded devices with high Disk Utilization by drives" }, { "customStatus": "False", "displayName": "All Interfaces by Utilization", "isCustom": "false", "id": 14, "url": "/reports/GenerateReports.do?firstTime=true&reportID=14", "Name": "All Interfaces by Utilization", "desc": "Identify devices with heavy traffic utilization" }, { "customStatus": "False", "displayName": "WAN Links by Utilization", "isCustom": "false", "id": 15, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=15", "Name": "WAN Links by Utilization", "desc": "Identify WAN links with heavy traffic utilization" }, { "customStatus": "False", "displayName": "Interfaces by Rx Traffic", "isCustom": "false", "id": 16, "url": "/reports/GenerateReports.do?firstTime=true&reportID=16", "Name": "Interfaces by Rx Traffic", "desc": "Identify devices with heavy incoming traffic" }, { "customStatus": "False", "displayName": "Interfaces by Tx Traffic", "isCustom": "false", "id": 17, "url": "/reports/GenerateReports.do?firstTime=true&reportID=17", "Name": "Interfaces by Tx Traffic", "desc": "Identify devices with heavy outgoing traffic" }, { "customStatus": "False", "displayName": "Interfaces by Rx Utilization", "isCustom": "false", "id": 18, "url": "/reports/GenerateReports.do?firstTime=true&reportID=18", "Name": "Interfaces by Rx Utilization", "desc": "Identify devices with heavy incoming traffic utilization" }, { "customStatus": "False", "displayName": "Interfaces by Tx Utilization", "isCustom": "false", "id": 19, "url": "/reports/GenerateReports.do?firstTime=true&reportID=19", "Name": "Interfaces by Tx Utilization", "desc": "Identify devices with heavy outgoing traffic utilization" }, { "customStatus": "False", "displayName": "Interfaces by Rx Errors", "isCustom": "false", "id": 20, "url": "/reports/GenerateReports.do?firstTime=true&reportID=20", "Name": "Interfaces by Rx Errors", "desc": "Identify interfaces with high incoming errors" }, { "customStatus": "False", "displayName": "Interfaces by Tx Errors", "isCustom": "false", "id": 21, "url": "/reports/GenerateReports.do?firstTime=true&reportID=21", "Name": "Interfaces by Tx Errors", "desc": "Identify interfaces with high outgoing errors" }, { "customStatus": "True", "displayName": "Servers Health Report", "isCustom": "true", "id": 22, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=22", "Name": "Servers Health Report", "desc": "Get health report of servers" }, { "customStatus": "True", "displayName": "Servers by CPU Utilization", "isCustom": "true", "id": 23, "url": "/reports/GenerateReports.do?firstTime=true&reportID=23", "Name": "Servers by CPU Utilization", "desc": "Identify busy servers with high CPU Utilization" }, { "customStatus": "True", "displayName": "Servers by Memory Utilization", "isCustom": "true", "id": 24, "url": "/reports/GenerateReports.do?firstTime=true&reportID=24", "Name": "Servers by Memory Utilization", "desc": "Identify overloaded servers with high Memory Utilization" }, { "customStatus": "True", "displayName": "Servers by Disk Utilization", "isCustom": "true", "id": 25, "url": "/reports/GenerateReports.do?firstTime=true&reportID=25", "Name": "Servers by Disk Utilization", "desc": "Identify overloaded servers with high Disk Utilization" }, { "customStatus": "True", "displayName": "Servers by Rx Traffic", "isCustom": "true", "id": 26, "url": "/reports/GenerateReports.do?firstTime=true&reportID=26", "Name": "Servers by Rx Traffic", "desc": "Identify servers with heavy incoming traffic" }, { "customStatus": "True", "displayName": "Servers by Tx Traffic", "isCustom": "true", "id": 27, "url": "/reports/GenerateReports.do?firstTime=true&reportID=27", "Name": "Servers by Tx Traffic", "desc": "Identify servers with heavy outgoing traffic" }, { "customStatus": "True", "displayName": "All Interfaces By Traffic", "isCustom": "true", "id": 81, "url": "/reports/GenerateReports.do?firstTime=true&reportID=81", "Name": "All Interfaces By Traffic", "desc": "Get traffic report of all interfaces" }, { "customStatus": "True", "displayName": "Volumes With Low Disk Utilization", "isCustom": "true", "id": 82, "url": "/reports/GenerateReports.do?firstTime=true&reportID=82", "Name": "Volumes With Low Disk Utilization", "desc": "Identify volumes with low disk utilization" }, { "customStatus": "True", "displayName": "Volumes With High Disk Utilization", "isCustom": "true", "id": 83, "url": "/reports/GenerateReports.do?firstTime=true&reportID=83", "Name": "Volumes With High Disk Utilization", "desc": "Identify volumes with high disk utilization" }, { "customStatus": "False", "displayName": "Top N Errors And Discards", "isCustom": "false", "id": 86, "url": "/reports/GenerateReports.do?firstTime=true&reportID=86", "Name": "Top N Errors And Discards", "desc": "Identify interfaces with high errors and discards" }, { "customStatus": "False", "displayName": "Interfaces By TotalBytes Transfered", "isCustom": "false", "id": 89, "url": "/reports/GenerateReports.do?firstTime=true&reportID=89", "Name": "Interfaces By TotalBytes Transfered", "desc": "Identify interfaces with high total bytes transfered" }, { "customStatus": "False", "displayName": "Hardware Health Report", "isCustom": "false", "id": 142, "url": "/reports/GenerateReports.do?firstTime=true&reportID=142", "Name": "webclient.reports.hardware.title", "desc": "Get Hardware Health Report" }, { "customStatus": "True", "displayName": "Processes by CPU Utilization", "isCustom": "true", "id": 144, "url": "/reports/GenerateReports.do?firstTime=true&reportID=144", "Name": "Processes by CPU Utilization", "desc": "Identify processes with high CPU Utilization" }, { "customStatus": "True", "displayName": "Processes by Memory Utilization", "isCustom": "true", "id": 145, "url": "/reports/GenerateReports.do?firstTime=true&reportID=145", "Name": "Processes by Memory Utilization", "desc": "Identify processes with high Memory Utilization" }, { "customStatus": "True", "displayName": "Processes by Absolute Memory", "isCustom": "true", "id": 148, "url": "/reports/GenerateReports.do?firstTime=true&reportID=148", "Name": "Processes by Absolute Memory", "desc": "Identify absolute memory value of the Process" }, { "customStatus": "False", "displayName": "Flap Count Summary", "isCustom": "false", "id": 768, "url": "/reports/GenerateReports.do?firstTime=true&reportID=768", "Name": "webclient.bgp.title.flapCount", "desc": "Get Flap Count Summary for BGP Peers" }, { "customStatus": "False", "displayName": "Flap Summary", "isCustom": "false", "id": 769, "url": "/reports/GenerateReports.do?firstTime=true&reportID=769", "Name": "webclient.bgp.title.flapSummary", "desc": "Flap Summary for each BGP Peers" }, { "customStatus": "False", "displayName": "Devices with Performance Monitors", "isCustom": "false", "id": 772, "url": "/reports/GenerateReports.do?firstTime=true&reportID=772", "Name": "webclient.perf.monitors.report", "desc": "Get report for devices with Perforamance monitors" }, { "customStatus": "False", "displayName": "Devices with File Monitors", "isCustom": "false", "id": 773, "url": "/reports/GenerateReports.do?firstTime=true&reportID=773", "Name": "webclient.file.monitors.report", "desc": "Get report for devices with File monitors" }, { "customStatus": "False", "displayName": "Devices with Folder Monitors", "isCustom": "false", "id": 774, "url": "/reports/GenerateReports.do?firstTime=true&reportID=774", "Name": "webclient.folder.monitors.report", "desc": "Get report for devices with Folder monitors" }, { "customStatus": "False", "displayName": "Devices with Process Monitors", "isCustom": "false", "id": 775, "url": "/reports/GenerateReports.do?firstTime=true&reportID=775", "Name": "webclient.process.monitors.report", "desc": "Get report for devices with Process monitors" }, { "customStatus": "False", "displayName": "Devices with AD Monitors", "isCustom": "false", "id": 776, "url": "/reports/GenerateReports.do?firstTime=true&reportID=776", "Name": "webclient.AD.monitors.report", "desc": "Get report for devices with AD monitors" }, { "customStatus": "False", "displayName": "Devices with Exchange Monitors", "isCustom": "false", "id": 777, "url": "/reports/GenerateReports.do?firstTime=true&reportID=777", "Name": "webclient.exchange.monitors.report", "desc": "Get report for devices with Exchange monitors" }, { "customStatus": "False", "displayName": "Devices with MSSQL Monitors", "isCustom": "false", "id": 778, "url": "/reports/GenerateReports.do?firstTime=true&reportID=778", "Name": "webclient.mssql.monitors.report", "desc": "Get report for devices with MSSQL monitors" }, { "customStatus": "False", "displayName": "Devices with AD Service Monitors", "isCustom": "false", "id": 779, "url": "/reports/GenerateReports.do?firstTime=true&reportID=779", "Name": "webclient.ADService.monitors.report", "desc": "Get report for devices with AD Service monitors" }, { "customStatus": "False", "displayName": "Devices with MSSQL Service Monitors", "isCustom": "false", "id": 780, "url": "/reports/GenerateReports.do?firstTime=true&reportID=780", "Name": "webclient.mssqlservice.monitors.report", "desc": "Get report for devices with MSSQL Service monitors" }, { "customStatus": "False", "displayName": "Devices with Exchange Service Monitors", "isCustom": "false", "id": 781, "url": "/reports/GenerateReports.do?firstTime=true&reportID=781", "Name": "webclient.exchangeservice.monitors.report", "desc": "Get report for devices with Exchange Service monitors" }, { "customStatus": "False", "displayName": "Devices with NT Service Monitors", "isCustom": "false", "id": 782, "url": "/reports/GenerateReports.do?firstTime=true&reportID=782", "Name": "webclient.ntservice.monitors.report", "desc": "Get report for devices with NT Service monitors" }, { "customStatus": "False", "displayName": "Devices with URL Monitors", "isCustom": "false", "id": 783, "url": "/reports/GenerateReports.do?firstTime=true&reportID=783", "Name": "webclient.url.monitors.report", "desc": "Get report for devices with URL monitors" }, { "customStatus": "False", "displayName": "Devices with Service Monitors", "isCustom": "false", "id": 784, "url": "/reports/GenerateReports.do?firstTime=true&reportID=784", "Name": "webclient.service.monitors.report", "desc": "Get report for devices with Service monitors" }, { "customStatus": "False", "displayName": "VPN Summary", "isCustom": "false", "id": 895, "url": "/reports/GenerateReports.do?firstTime=true&reportID=895", "Name": "webclient.opm.reports.vpnSummary", "desc": "Get summary report for Site-to-Site VPN devices." } ], "title": "" } ], "Name": "Health and Performance" }, { "displayName": "Availability and Response", "list": [ { "list": [ { "customStatus": "True", "displayName": "SMTP Servers by Response Time", "isCustom": "true", "id": 65, "url": "/reports/GenerateReports.do?firstTime=true&reportID=65", "Name": "SMTP Servers by Response Time", "desc": "Identify SMTP servers with high Response Time" }, { "customStatus": "True", "displayName": "Process Monitors Availability", "isCustom": "true", "id": 146, "url": "/reports/GenerateReports.do?firstTime=true&reportID=146", "Name": "Process Monitors Availability", "desc": "Get availability report for all process monitors" }, { "customStatus": "True", "displayName": "Windows Service Monitors Availability", "isCustom": "true", "id": 147, "url": "/reports/GenerateReports.do?firstTime=true&reportID=147", "Name": "Windows Service Monitors Availability", "desc": "Get availability report for all windows service monitors" }, { "customStatus": "True", "displayName": "HTTP Servers by Response Time", "isCustom": "true", "id": 64, "url": "/reports/GenerateReports.do?firstTime=true&reportID=64", "Name": "HTTP Servers by Response Time", "desc": "Identify Web servers with high Response Time" }, { "customStatus": "False", "displayName": "Devices by Packet Loss", "isCustom": "false", "id": 58, "url": "/reports/GenerateReports.do?firstTime=true&reportID=58", "Name": "Devices by Packet Loss", "desc": "Identify devices with high packet loss" }, { "customStatus": "False", "displayName": "Devices by Response Time", "isCustom": "false", "id": 57, "url": "/reports/GenerateReports.do?firstTime=true&reportID=57", "Name": "Devices by Response Time", "desc": "Identify devices with high response time" }, { "customStatus": "True", "displayName": "Web Servers Availability", "isCustom": "true", "id": 63, "url": "/reports/GenerateReports.do?firstTime=true&reportID=63", "Name": "Web Servers Availability", "desc": "Get availability report for all web servers" }, { "customStatus": "False", "displayName": "WAN Links Availability", "isCustom": "false", "id": 54, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=54", "Name": "WAN Links Availability", "desc": "Get availability report for all interfaces" }, { "customStatus": "False", "displayName": "All Interfaces Availability", "isCustom": "false", "id": 87, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=87", "Name": "All Interfaces Availability", "desc": "Get availability report for all interfaces" }, { "customStatus": "False", "displayName": "URLs Availability", "isCustom": "false", "id": 55, "url": "/reports/GenerateReports.do?firstTime=true&reportID=55", "Name": "URLs Availability", "desc": "Get availability report for all URLs" }, { "customStatus": "False", "displayName": "Service Monitors Availability", "isCustom": "false", "id": 56, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=56", "Name": "Service Monitors Availability", "desc": "Get availability report for all service monitors" }, { "customStatus": "True", "displayName": "DCs Availability Report", "isCustom": "true", "id": 62, "url": "/reports/GenerateReports.do?firstTime=true&reportID=62", "Name": "DCs Availability Report", "desc": "Get availability report for all DCs" }, { "customStatus": "True", "displayName": "Servers Availability Report", "isCustom": "true", "id": 61, "url": "/reports/GenerateReports.do?firstTime=true&reportID=61", "Name": "Servers Availability Report", "desc": "Get availability report for all services" }, { "customStatus": "False", "displayName": "Devices Availability", "isCustom": "false", "id": 52, "url": "/reports/GenerateReports.do?firstTime=true&reportID=52", "Name": "Devices Availability", "desc": "Get availability report for all devices" }, { "customStatus": "False", "displayName": "Devices Availability Dashboard", "isCustom": "false", "id": 53, "url": "/reports/GenerateReports.do?firstTime=true&reportID=53", "Name": "Devices Availability Dashboard", "desc": "Get availability report for all devices" }, { "customStatus": "False", "displayName": "DownTime Report For Interfaces", "isCustom": "false", "id": 724, "url": "/reports/GenerateReports.do?firstTime=true&reportID=724", "Name": "DownTime Report For Interfaces", "desc": "DownTime history for all interfaces" }, { "customStatus": "False", "displayName": "Services by Response Time", "isCustom": "false", "id": 60, "url": "/reports/GenerateReports.do?firstTime=true&reportID=60", "Name": "Services by Response Time", "desc": "Identify services with high response time" }, { "customStatus": "False", "displayName": "URLs by Response Time", "isCustom": "false", "id": 59, "url": "/reports/GenerateReports.do?firstTime=true&reportID=59", "Name": "URLs by Response Time", "desc": "Identify URLs with high response time" }, { "customStatus": "True", "displayName": "Telnet Servers by Response Time", "isCustom": "true", "id": 68, "url": "/reports/GenerateReports.do?firstTime=true&reportID=68", "Name": "Telnet Servers by Response Time", "desc": "Identify Telnet servers with high Response Time" }, { "customStatus": "False", "displayName": "DownTime Report", "isCustom": "false", "id": 91, "url": "/reports/GenerateReports.do?firstTime=true&reportID=91", "Name": "DownTime Report", "desc": "DownTime history for all devices" }, { "customStatus": "True", "displayName": "FTP Servers by Response Time", "isCustom": "true", "id": 67, "url": "/reports/GenerateReports.do?firstTime=true&reportID=67", "Name": "FTP Servers by Response Time", "desc": "Identify FTP servers with high Response Time" }, { "customStatus": "True", "displayName": "MySQL Servers by Response Time", "isCustom": "true", "id": 66, "url": "/reports/GenerateReports.do?firstTime=true&reportID=66", "Name": "MySQL Servers by Response Time", "desc": "Identify MySQL servers with high Response Time" } ], "title": "" } ], "Name": "Availability and Response" }, { "displayName": "Inventory", "list": [ { "list": [ { "customStatus": "True", "displayName": "Devices Down", "isCustom": "true", "id": 722, "url": "/reports/GenerateReports.do?firstTime=true&reportID=722", "Name": "widget.name.devicesdown", "desc": "Get report for all devices down" }, { "customStatus": "False", "displayName": "Notification Profiles Applied by Type", "isCustom": "false", "id": 72, "url": "/reports/GenerateReports.do?firstTime=true&reportID=72", "Name": "Notification Profiles Applied by Type", "desc": "Get report of all notification profiles applied by profile type" }, { "customStatus": "False", "displayName": "Notification Profiles Applied", "isCustom": "false", "id": 71, "url": "/reports/GenerateReports.do?firstTime=true&reportID=71", "Name": "Notification Profiles Applied", "desc": "Get report of all notification profiles applied" }, { "customStatus": "False", "displayName": "Devices by Category", "isCustom": "false", "id": 70, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=70", "Name": "Devices by Category", "desc": "Get inventory report of devices by device category" }, { "customStatus": "False", "displayName": "Devices by Device Type", "isCustom": "false", "id": 69, "url": "/reports/GenerateReports.do?firstTime=true&reportID=69", "Name": "Devices by Device Type", "desc": "Get inventory report of devices by device type" }, { "customStatus": "False", "displayName": "Hardware Information", "isCustom": "false", "id": 155, "url": "/reports/GenerateReports.do?firstTime=true&reportID=155", "Name": "webclient.reports.hardwareinfo.title", "desc": "Get report of Hardware Information" }, { "customStatus": "True", "displayName": "Non SNMP Devices", "isCustom": "true", "id": 80, "url": "/reports/GenerateReports.do?firstTime=true&reportID=80", "Name": "Non SNMP Devices", "desc": "Get inventory report of all SNMP not enabled devices" }, { "customStatus": "True", "displayName": "SNMP Enabled Devices", "isCustom": "true", "id": 79, "url": "/reports/GenerateReports.do?firstTime=true&reportID=79", "Name": "SNMP Enabled Devices", "desc": "Get inventory report of all SNMP enabled devices" }, { "customStatus": "True", "displayName": "Desktop", "isCustom": "true", "id": 78, "url": "/reports/GenerateReports.do?firstTime=true&reportID=78", "Name": "Desktops", "desc": "Get inventory report of desktops" }, { "customStatus": "True", "displayName": "Server", "isCustom": "true", "id": 77, "url": "/reports/GenerateReports.do?firstTime=true&reportID=77", "Name": "Servers", "desc": "Get inventory report of servers" }, { "customStatus": "False", "displayName": "Threshold Details of Devices", "isCustom": "false", "id": 150, "url": "/reports/GenerateReports.do?firstTime=true&reportID=150", "Name": "webclient.report.name.thresholdreports", "desc": "Get report of all thresholds configured" }, { "customStatus": "True", "displayName": "All Devices", "isCustom": "true", "id": 76, "url": "/reports/GenerateReports.do?firstTime=true&reportID=76", "Name": "All Devices", "desc": "Get inventory report of all devices" }, { "customStatus": "False", "displayName": "Interfaces by Type", "isCustom": "false", "id": 75, "url": "/reports/GenerateReports.do?firstTime=true&reportID=75", "Name": "Interfaces by Type", "desc": "Get report of all interfaces by type" }, { "customStatus": "False", "displayName": "Interface Speed Report", "isCustom": "false", "id": 74, "url": "/reports/GenerateReports.do?firstTime=true&reportID=74", "Name": "Interface Speed Report", "desc": "Get report of interface bandwidth" }, { "customStatus": "False", "displayName": "Notification Profiles Applied by Device", "isCustom": "false", "id": 73, "url": "/reports/GenerateReports.do?firstTime=true&reportID=73", "Name": "Notification Profiles Applied by Device", "desc": "Get report of all notification profiles applied by device" }, { "customStatus": "False", "displayName": "Devices by Added Time", "isCustom": "false", "id": 725, "url": "/reports/GenerateReports.do?firstTime=true&reportID=725", "Name": "Devices by Added Time", "desc": "Get Devices with its Added Time" }, { "customStatus": "False", "displayName": "Uplink Dependency Devices", "isCustom": "false", "id": 727, "url": "/reports/GenerateReports.do?firstTime=true&reportID=727", "Name": "Up Link Dependency Devices", "desc": "Get inventory report of all dependent devices" }, { "customStatus": "False", "displayName": "Credentials Associated Devices", "isCustom": "false", "id": 761, "url": "/reports/GenerateReports.do?firstTime=true&reportID=761", "Name": "webclient.credential.devices.report", "desc": "Get report of credentials associated to devices" }, { "customStatus": "False", "displayName": "Agent-monitored devices", "isCustom": "false", "id": 862, "url": "/reports/GenerateReports.do?firstTime=true&reportID=862", "Name": "Agent Devices", "desc": "Get an Inventory report of all agent-monitored devices" }, { "customStatus": "False", "displayName": "IPMI Information", "isCustom": "false", "id": 723, "url": "/reports/GenerateReports.do?firstTime=true&reportID=723", "Name": "webclient.reports.ipmi.info.title", "desc": "Get a report of your IPMI devices and related hardware" } ], "title": "" } ], "Name": "Inventory" }, { "displayName": "WAN RTT Monitors", "list": [ { "list": [ { "customStatus": "False", "displayName": "Top N Paths with Maximum RTT", "isCustom": "false", "id": 101, "url": "/reports/GenerateReports.do?firstTime=true&reportID=101", "Name": "Top N Paths with Maximum RTT", "desc": "Top paths with maximum Round Trip Time" }, { "customStatus": "False", "displayName": "Round Trip Time History Report", "isCustom": "false", "id": 97, "url": "/reports/GenerateReports.do?firstTime=true&reportID=97", "Name": "Round Trip Time Trend Report", "desc": "Show RTT of icmp packets between source and destination host" }, { "customStatus": "False", "displayName": "Availability History", "isCustom": "false", "id": 98, "url": "/reports/GenerateReports.do?firstTime=true&reportID=98", "Name": "Link Availability and Error Statistics", "desc": "Show availability of destination also show type of errors in case of failed operation" }, { "customStatus": "False", "displayName": "RTT Threshold Violation Report", "isCustom": "false", "id": 96, "url": "/reports/GenerateReports.do?firstTime=true&reportID=96", "Name": "RTT Threshold Violation Report", "desc": "Shows threshold violation of icmp packets between source and destination host" }, { "customStatus": "False", "displayName": "Top N Least Available Paths", "isCustom": "false", "id": 99, "url": "/reports/GenerateReports.do?firstTime=true&reportID=99", "Name": "Top N Least Available Paths", "desc": "Top paths with least availability" }, { "customStatus": "False", "displayName": "Top N Paths with Maximum Threshold Violation", "isCustom": "false", "id": 100, "url": "/reports/GenerateReports.do?firstTime=true&reportID=100", "Name": "Top N Paths with Maximum Threshold Violation", "desc": "Top paths with maximum threshold violation" } ], "title": "" } ], "Name": "WAN RTT Monitors" }, { "displayName": "VoIP Monitors", "list": [ { "list": [ { "customStatus": "False", "displayName": "Round Trip Time History Report", "isCustom": "false", "id": 107, "url": "/reports/GenerateReports.do?firstTime=true&reportID=107", "Name": "Round Trip Time History Report", "desc": "Shows RTT (Round Trip Time) of VoIP packets in both directions" }, { "customStatus": "False", "displayName": "Top N Call Paths by Jitter", "isCustom": "false", "id": 110, "url": "/reports/GenerateReports.do?firstTime=true&reportID=110", "Name": "Top N Call Paths by Jitter", "desc": "Top call paths with maximum Jitter" }, { "customStatus": "False", "displayName": "Top N Call Paths by Packet Loss", "isCustom": "false", "id": 109, "url": "/reports/GenerateReports.do?firstTime=true&reportID=109", "Name": "Top N Call Paths by Packet Loss", "desc": "Top call paths with maximum Packet Loss" }, { "customStatus": "False", "displayName": "Top N Call Paths by MOS", "isCustom": "false", "id": 108, "url": "/reports/GenerateReports.do?firstTime=true&reportID=108", "Name": "Top N Call Paths by MOS", "desc": "Top call paths with minimum MOS" }, { "customStatus": "False", "displayName": "Top N Call Paths by Latency", "isCustom": "false", "id": 111, "url": "/reports/GenerateReports.do?firstTime=true&reportID=111", "Name": "Top N Call Paths by Latency", "desc": "Top call paths with maximum Latency" }, { "customStatus": "False", "displayName": "Latency History Report", "isCustom": "false", "id": 102, "url": "/reports/GenerateReports.do?firstTime=true&reportID=102", "Name": "Latency History Report", "desc": "Shows latency of VoIP packets in both directions" }, { "customStatus": "False", "displayName": "Jitter History Report", "isCustom": "false", "id": 103, "url": "/reports/GenerateReports.do?firstTime=true&reportID=103", "Name": "Jitter History Report", "desc": "Shows jitter (inter packet delay) of VoIP packets in bonfa.overview.Qos=QoS" }, { "customStatus": "False", "displayName": "Packet Loss History Report", "isCustom": "false", "id": 104, "url": "/reports/GenerateReports.do?firstTime=true&reportID=104", "Name": "Packet Loss History Report", "desc": "Shows packetloss of VoIP packets in both directions" }, { "customStatus": "False", "displayName": "VoIP Errors History Report", "isCustom": "false", "id": 105, "url": "/reports/GenerateReports.do?firstTime=true&reportID=105", "Name": "VoIP Errors History Report", "desc": "Shows various errors (timeout, tail drop,MIA etc.,) generated in the VoIP traffic" }, { "customStatus": "False", "displayName": "MOS History Report", "isCustom": "false", "id": 106, "url": "/reports/GenerateReports.do?firstTime=true&reportID=106", "Name": "MOS History Report", "desc": "Report shows MOS (Mean Opinion Score) of VoIP traffic. MOS is the key quality indicator of VoIP traffic" } ], "title": "" } ], "Name": "VoIP Monitors" }, { "displayName": "Virtual Servers Report", "list": [ { "list": [ { "customStatus": "False", "displayName": "HyperV-Host vs Disk Mapping", "isCustom": "false", "id": 154, "url": "/reports/GenerateReports.do?firstTime=true&reportID=154", "Name": "webclient.virtual.hyperv.hostdisk.report", "desc": "Get report for all Monitored HyperV-Host Vs Disk Mappings" }, { "customStatus": "False", "displayName": "Datastore vs VMware-Host Mapping", "isCustom": "false", "id": 153, "url": "/reports/GenerateReports.do?firstTime=true&reportID=153", "Name": "webclient.virtual.vmware.datastorehost.report", "desc": "Get report for all Datastore Vs Monitored VMware-Host Mappings" }, { "customStatus": "False", "displayName": "Datastore vs VMware-VM Mapping", "isCustom": "false", "id": 152, "url": "/reports/GenerateReports.do?firstTime=true&reportID=152", "Name": "webclient.virtual.vmware.datastorevm.report", "desc": "Get report for all Datastore Vs Monitored VMware-VM Mappings" }, { "customStatus": "False", "displayName": "VMware Idle VMs", "isCustom": "false", "id": 156, "url": "/reports/GenerateReports.do?firstTime=true&reportID=156", "Name": "widget.name.vmware.idleVms", "desc": "List of Idle VMs" }, { "customStatus": "False", "displayName": "Top VMware VMs by CPU Under Allocated", "isCustom": "false", "id": 157, "url": "/reports/GenerateReports.do?firstTime=true&reportID=157", "Name": "widget.name.vmware.vmUnderAllocatedCPU", "desc": "vms with under allocated CPU" }, { "customStatus": "False", "displayName": "Top VMware VMs by CPU Over Allocated", "isCustom": "false", "id": 158, "url": "/reports/GenerateReports.do?firstTime=true&reportID=158", "Name": "widget.name.vmware.vmOverAllocatedCPU", "desc": "VMs with CPU over allocated" }, { "customStatus": "False", "displayName": "Top VMware VMs by Memory Under Allocated", "isCustom": "false", "id": 159, "url": "/reports/GenerateReports.do?firstTime=true&reportID=159", "Name": "widget.name.vmware.vmUnderAllocatedMemory", "desc": "VMs with memory under allocated" }, { "customStatus": "False", "displayName": "Top VMware VMs by Memory Over Allocated", "isCustom": "false", "id": 160, "url": "/reports/GenerateReports.do?firstTime=true&reportID=160", "Name": "widget.name.vmware.vmOverAllocatedMemory", "desc": "VMs with memory over allocated" }, { "customStatus": "False", "displayName": "All Virtual Machines", "isCustom": "false", "id": 726, "url": "/reports/GenerateReports.do?firstTime=true&reportID=726", "Name": "widget.name.vmware.vmsList", "desc": "List of virtual machines based on virtual type" } ], "title": "" } ], "Name": "Virtual Servers Report" }, { "displayName": "Storage Reports", "list": [ { "list": [ { "customStatus": "False", "displayName": "Growth Trend", "isCustom": "false", "id": 174, "url": "/reports/GenerateReports.do?firstTime=true&reportID=174", "Name": "webclient.reports.growthtrend.title", "desc": "Growth Trend" }, { "customStatus": "False", "displayName": "Storage Summary", "isCustom": "false", "id": 161, "url": "/reports/GenerateReports.do?firstTime=true&reportID=161", "Name": "webclient.reports.storagesummary.title", "desc": "Storage Summary" }, { "customStatus": "False", "displayName": "RAID Capacity Utilization", "isCustom": "false", "id": 162, "url": "/reports/GenerateReports.do?firstTime=true&reportID=162", "Name": "webclient.reports.topncapacity", "desc": "RAID Capacity Utilization" }, { "customStatus": "False", "displayName": "RAID IOPS ", "isCustom": "false", "id": 163, "url": "/reports/GenerateReports.do?firstTime=true&reportID=163", "Name": "webclient.reports.topnraidiops", "desc": "RAID IOPS " }, { "customStatus": "False", "displayName": "RAID Reads/Sec", "isCustom": "false", "id": 164, "url": "/reports/GenerateReports.do?firstTime=true&reportID=164", "Name": "webclient.reports.topnraidreads", "desc": "RAID Reads/Sec" }, { "customStatus": "False", "displayName": "RAID Writes/Sec", "isCustom": "false", "id": 165, "url": "/reports/GenerateReports.do?firstTime=true&reportID=165", "Name": "webclient.reports.topnraidwrites", "desc": "RAID Writes/Sec" }, { "customStatus": "False", "displayName": "RAID Latency", "isCustom": "false", "id": 166, "url": "/reports/GenerateReports.do?firstTime=true&reportID=166", "Name": "webclient.reports.topnraidlatency", "desc": "RAID Latency" }, { "customStatus": "False", "displayName": "RAID Controller IOPS", "isCustom": "false", "id": 167, "url": "/reports/GenerateReports.do?firstTime=true&reportID=167", "Name": "webclient.reports.topnraidcontrolleriops", "desc": "RAID Controller IOPS" }, { "customStatus": "False", "displayName": "RAID Controller Reads/Sec", "isCustom": "false", "id": 168, "url": "/reports/GenerateReports.do?firstTime=true&reportID=168", "Name": "webclient.reports.topnraidcontrollerreads", "desc": "RAID Controller Reads/Sec" }, { "customStatus": "False", "displayName": "RAID Controller Writes/Sec", "isCustom": "false", "id": 169, "url": "/reports/GenerateReports.do?firstTime=true&reportID=169", "Name": "webclient.reports.topnraidcontrollerwrites", "desc": "RAID Controller Writes/Sec" }, { "customStatus": "False", "displayName": "Disk IOPS", "isCustom": "false", "id": 170, "url": "/reports/GenerateReports.do?firstTime=true&reportID=170", "Name": "webclient.reports.topndiskiops", "desc": "Disk IOPS" }, { "customStatus": "False", "displayName": "Disk Reads/Sec", "isCustom": "false", "id": 171, "url": "/reports/GenerateReports.do?firstTime=true&reportID=171", "Name": "webclient.reports.topndiskreads", "desc": "Disk Reads/Sec" }, { "customStatus": "False", "displayName": "Disk Writes/Sec", "isCustom": "false", "id": 172, "url": "/reports/GenerateReports.do?firstTime=true&reportID=172", "Name": "webclient.reports.topndiskwrites", "desc": "Disk Writes/Sec" }, { "customStatus": "False", "displayName": "RAID Forecast By Utilization", "isCustom": "false", "id": 173, "url": "/reports/GenerateReports.do?firstTime=true&reportID=173", "Name": "webclient.reports.forecast.title", "desc": "RAID Forecast By Utilization" } ], "title": "" } ], "Name": "Storage Reports" }, { "displayName": "Forecast Reports", "list": [ { "list": [ { "customStatus": "False", "displayName": "Memory Forecast", "isCustom": "false", "id": 177, "url": "/reports/GenerateReports.do?firstTime=true&reportID=177", "Name": "Memory Forecast", "desc": "Forecasts the Memory Utilization" }, { "customStatus": "False", "displayName": "Disk Forecast By Usage", "isCustom": "false", "id": 175, "url": "/reports/GenerateReports.do?firstTime=true&reportID=175", "Name": "Disk Forecast By Usage", "desc": "Disk Forecast By Usage" }, { "customStatus": "False", "displayName": "CPU Forecast", "isCustom": "false", "id": 178, "url": "/reports/GenerateReports.do?firstTime=true&reportID=178", "Name": "CPU Forecast", "desc": "Forecasts the CPU utilization" } ], "title": "" } ], "Name": "Forecast Reports" }, { "displayName": "Nutanix Reports", "list": [ { "list": [ { "customStatus": "False", "displayName": "Top N Hosts by IOPS", "isCustom": "false", "id": 740, "url": "/reports/GenerateReports.do?firstTime=true&reportID=740", "Name": "webclient.nutanix.hostsUnderIOPS.report", "desc": "Get report for Top Hosts with IOPS rate" }, { "customStatus": "False", "displayName": "Disk Inventory", "isCustom": "false", "id": 739, "url": "/reports/GenerateReports.do?firstTime=true&reportID=739", "Name": "webclient.nutanix.disk.report", "desc": "Get report for all Disk Inventory Details" }, { "customStatus": "False", "displayName": "Storage Containers", "isCustom": "false", "id": 738, "url": "/reports/GenerateReports.do?firstTime=true&reportID=738", "Name": "webclient.nutanix.storagecontainers", "desc": "Get report for all Storage Container Details" }, { "customStatus": "False", "displayName": "Cluster Latency", "isCustom": "false", "id": 736, "url": "/reports/GenerateReports.do?firstTime=true&reportID=736", "Name": "webclient.nutanix.cluster.latency.report", "desc": "Get report for all Cluster Latency Data" }, { "customStatus": "False", "displayName": "Cluster IOPS", "isCustom": "false", "id": 735, "url": "/reports/GenerateReports.do?firstTime=true&reportID=735", "Name": "webclient.nutanix.cluster.iops.report", "desc": "Get report for all Cluster IOPS Data" }, { "customStatus": "False", "displayName": "Cluster Inventory", "isCustom": "false", "id": 734, "url": "/reports/GenerateReports.do?firstTime=true&reportID=734", "Name": "webclient.nutanix.cluster.report", "desc": "Get report for all Cluster details" }, { "customStatus": "False", "displayName": "VM Summary by Host", "isCustom": "false", "id": 733, "url": "/reports/GenerateReports.do?firstTime=true&reportID=733", "Name": "webclient.nutanix.hostToVmMap.report", "desc": "Get report for VMs Details based on its Host" }, { "customStatus": "False", "displayName": "VM Summary by Cluster", "isCustom": "false", "id": 732, "url": "/reports/GenerateReports.do?firstTime=true&reportID=732", "Name": "webclient.nutanix.clusterToVMMap.report", "desc": "Get report for VM Details based on its Cluster" }, { "customStatus": "False", "displayName": "Host Summary", "isCustom": "false", "id": 737, "url": "/reports/GenerateReports.do?firstTime=true&reportID=737", "Name": "webclient.nutanix.clusterToHostMap.report", "desc": "Get report for all Host Details based on its Cluster" }, { "customStatus": "False", "displayName": "Top N Hosts by IO Bandwidth", "isCustom": "false", "id": 743, "url": "/reports/GenerateReports.do?firstTime=true&reportID=743", "Name": "webclient.nutanix.hostUnderBandwidth.report", "desc": "Get report for Top Disks with IO Bandwidth rate" }, { "customStatus": "False", "displayName": "Top N Hosts by Latency", "isCustom": "false", "id": 742, "url": "/reports/GenerateReports.do?firstTime=true&reportID=742", "Name": "webclient.nutanix.hostUnderLatency.report", "desc": "Get report for Top Hosts with Latency" }, { "customStatus": "False", "displayName": "Top N Disks by free space", "isCustom": "false", "id": 741, "url": "/reports/GenerateReports.do?firstTime=true&reportID=741", "Name": "webclient.nutanix.diskUnderFreespace.report", "desc": "Get report for Top Disks with Free space" } ], "title": "" } ], "Name": "Nutanix Reports" }, { "displayName": "WLC Reports", "list": [ { "list": [ { "customStatus": "False", "displayName": "AP Availability", "isCustom": "false", "id": 837, "url": "/reports/GenerateReports.do?firstTime=true&reportID=837", "Name": "webclient.availability.accessPoints.report", "desc": "Get availability report for Access points" }, { "customStatus": "False", "displayName": "Rogue SSID Details", "isCustom": "false", "id": 839, "url": "/reports/GenerateReports.do?firstTime=true&reportID=839", "Name": "webclient.inventory.RougeAP.report", "desc": "Get inventory report of Rogue SSIDs" }, { "customStatus": "False", "displayName": "AP Details", "isCustom": "false", "id": 838, "url": "/reports/GenerateReports.do?firstTime=true&reportID=838", "Name": "webclient.inventory.accessPoints.report", "desc": "Get inventory report of Access points" } ], "title": "" } ], "Name": "WLC Reports" }, { "displayName": "Meraki Reports", "list": [ { "list": [ { "customStatus": "False", "displayName": "Meraki MS Details", "isCustom": "false", "id": 855, "url": "/reports/GenerateReports.do?firstTime=true&reportID=855", "Name": "webclient.opm.reports.meraki.msdetails", "desc": "Get summary reports of Meraki Switch devices." }, { "customStatus": "False", "displayName": "Meraki AP Details", "isCustom": "false", "id": 860, "url": "/reports/GenerateReports.do?firstTime=true&reportID=860", "Name": "webclient.opm.reports.meraki.apDetails", "desc": "Get inventory reports of Meraki Access Points." }, { "customStatus": "False", "displayName": "Meraki Rogue SSID Details", "isCustom": "false", "id": 859, "url": "/reports/GenerateReports.do?firstTime=true&reportID=859", "Name": "webclient.opm.reports.meraki.rogue", "desc": "Get inventory reports of Meraki Rogue SSIDs." }, { "customStatus": "False", "displayName": "Meraki Cellular Gateway Details", "isCustom": "false", "id": 858, "url": "/reports/GenerateReports.do?firstTime=true&reportID=858", "Name": "webclient.opm.reports.meraki.mgdetails", "desc": "Get summary reports of Meraki Gateway devices." }, { "customStatus": "False", "displayName": "Meraki MV Details", "isCustom": "false", "id": 857, "url": "/reports/GenerateReports.do?firstTime=true&reportID=857", "Name": "webclient.opm.reports.meraki.mvdetails", "desc": "Get summary reports of Meraki Vision devices." }, { "customStatus": "False", "displayName": "Meraki MR Details", "isCustom": "false", "id": 856, "url": "/reports/GenerateReports.do?firstTime=true&reportID=856", "Name": "webclient.opm.reports.meraki.mrdetails", "desc": "Get summary reports of Meraki Radio devices." }, { "customStatus": "False", "displayName": "Meraki Organization Summary", "isCustom": "false", "id": 853, "url": "/reports/GenerateReports.do?firstTime=true&reportID=853", "Name": "webclient.opm.reports.meraki.orgSummary", "desc": "Get inventory reports of devices in each organization" }, { "customStatus": "False", "displayName": "Meraki MX Details", "isCustom": "false", "id": 854, "url": "/reports/GenerateReports.do?firstTime=true&reportID=854", "Name": "webclient.opm.reports.meraki.mxdetails", "desc": "Get summary reports of Meraki Security appliances." }, { "customStatus": "False", "displayName": "Down Meraki Devices", "isCustom": "false", "id": 861, "url": "/reports/GenerateReports.do?firstTime=true&reportID=861", "Name": "webclient.opm.reports.meraki.down", "desc": "Get reports for all Meraki devices that are down." } ], "title": "" } ], "Name": "Meraki Reports" }, { "displayName": "My Favorites", "list": [ { "list": [ { "customStatus": "False", "displayName": "All Alerts", "isCustom": "false", "id": 84, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=84", "Name": "All Alerts", "desc": "Get report for all alerts" }, { "customStatus": "False", "displayName": "All Events", "isCustom": "false", "id": 1, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=1", "Name": "All Events", "desc": "Get report for all events" }, { "customStatus": "False", "displayName": "WAN Links by Utilization", "isCustom": "false", "id": 15, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=15", "Name": "WAN Links by Utilization", "desc": "Identify WAN links with heavy traffic utilization" }, { "customStatus": "True", "displayName": "Servers Health Report", "isCustom": "true", "id": 22, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=22", "Name": "Servers Health Report", "desc": "Get health report of servers" }, { "customStatus": "False", "displayName": "WAN Links Availability", "isCustom": "false", "id": 54, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=54", "Name": "WAN Links Availability", "desc": "Get availability report for all interfaces" }, { "customStatus": "False", "displayName": "All Interfaces Availability", "isCustom": "false", "id": 87, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=87", "Name": "All Interfaces Availability", "desc": "Get availability report for all interfaces" }, { "customStatus": "False", "displayName": "Service Monitors Availability", "isCustom": "false", "id": 56, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=56", "Name": "Service Monitors Availability", "desc": "Get availability report for all service monitors" }, { "customStatus": "False", "displayName": "Devices by Category", "isCustom": "false", "id": 70, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=70", "Name": "Devices by Category", "desc": "Get inventory report of devices by device category" } ], "title": "" } ], "Name": "My Favorites" }, { "ScheduleReports": true, "FavoriteReports": false, "CustomReports": true } ] </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>isFavouriteNeeded</b></div> <div class="divTableCell">Boolean value to show favourites reports or not.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>hideintegratedReports</b></div> <div class="divTableCell">Boolean value to show integrated reports or not.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>hideHardwareReport</b></div> <div class="divTableCell">Boolean value to show hardware report or not.</div> </div> </div> </div> </div> </div> <div id="getReportsData" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getReportsData</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>The API to get the required report data.</p> <p class="yellow-box1"><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/reports/getReportsData?apiKey=***************&reportID=84&isExcludeDays=true&excludedDays=Monday,Tuesday&category=Desktop&bview=All&time=Last_Month&timeWindow=8-20&isBusinessHour=false&showType=0&top=1000&viewAs=json</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[ { "clientParams": { "top": 0, "genAt": "15 May 2022 02:26:08 AM IST", "showType": 0, "time": "Last_7_Days", "isFavourite": true, "genAtMilliseconds": 1652561768907 }, "additionalRespData": { "RECORDS": "1", "SKIPCOLUMNS": [ 1, 6 ] }, "graphDetails": [ [ "xxx.xxx.xxx.xx", "xxx.xxx.xxx.xx", "Device Active and Responding", "Clear", "Server", "13 May 2022 09:47:16 AM IST", 1652415436543 ], [ "xxx.xxx.xxx.xx", "xxx.xxx.xxx.xx", "Device Active and Responding", "Clear", "Server", "13 May 2022 09:47:16 AM IST", 1652415436543 ] ], "forward": "eventList", "graphHeaders": [ "Device Name", "Message", "Severity", "Category", "Alert Time", "" ], "vmClientParams": { "RECORDS": 1, "SKIPCOLUMNS": [ 1, 6 ] }, "ReportGraphName": "All Alerts", "graphDispName": "All Alerts" } ] </code></p> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>reportID</b></div> <div class="divTableCell">Unique ID for individual reports.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>viewAs</b></div> <div class="divTableCell">Format to view the resultant report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>time</b></div> <div class="divTableCell">The time period to fetch the report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>isExcludeDays</b></div> <div class="divTableCell">Boolean value to exclude days or not.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>excludedDays</b></div> <div class="divTableCell">The day to be excluded in report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>category</b></div> <div class="divTableCell">The category to view the report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>logicalGroup</b></div> <div class="divTableCell">The logical group to view the report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>bview</b></div> <div class="divTableCell">The business view to view the report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>timeWindow</b></div> <div class="divTableCell">The time window to fetch the report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>showType</b></div> <div class="divTableCell">To show the top or bottom contents of report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>top</b></div> <div class="divTableCell">To show the top of the reports data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>startTime</b></div> <div class="divTableCell">Start time of custom time period.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>endTime</b></div> <div class="divTableCell">End time of custom time period.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>startHour</b></div> <div class="divTableCell">Start hour of custom time period.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>endHour</b></div> <div class="divTableCell">End hour of custom time period.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>customerId</b></div> <div class="divTableCell">Probe Id to be filtered.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>customerName</b></div> <div class="divTableCell">Probe name to be filtered.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>fromEmailid</b></div> <div class="divTableCell">From mail id for report to be sent.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>toEmailid</b></div> <div class="divTableCell">To mail id for report to be sent.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>emailSubject</b></div> <div class="divTableCell">Mail Subject</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>isBusinessHour</b></div> <div class="divTableCell">Boolean value to show business hour data or not.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>businessRuleID</b></div> <div class="divTableCell">ID of the business rule created previously.</div> </div> </div> </div> </div> <div id="listBusinessRules" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">listBusinessRules</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>This api can be used to list all the created Business Hour Rules.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060//api/json/admin/listBusinessRules?apiKey=***************</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> </div> </div> </div> </div> <div id="addBusinessRules" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">addBusinessRules</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>This api is used to configure business hour rule from Monday to Sunday.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/admin/addBusinessRules?apiKey=***************&businessRuleName=Rule1&description=Indian standard time shift 1.&timeSettings={"monday":"1-5","tuesday":"3-6","wednesday":"3-5","thursday":"2-5","friday":"5-13"}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>description</b></div> <div class="divTableCell">Description about the business rule.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>businessRuleName</b></div> <div class="divTableCell">Name of the business hour rule.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>timeSettings</b></div> <div class="divTableCell">Time configuration from Monday to Sunday.</div> </div> </div> </div> </div> </div> <div id="deleteBusinessRules" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">deleteBusinessRules</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>This api is to delete business hour rule created already.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060//api/json/admin/deleteBusinessRules?apiKey=***************&businessRuleId=1</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>businessRuleId</b></div> <div class="divTableCell">ID of the business hour rule.</div> </div> </div> </div> </div> </div> <div id="viewBusinessRules" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">viewBusinessRules</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>This api is to view the business hour rule created already.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060//api/json/admin/viewBusinessRules?apiKey=***************&businessRuleId=1</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>businessRuleId</b></div> <div class="divTableCell">ID of the business hour rule.</div> </div> </div> </div> </div> </div> <div id="updateBusinessRules" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">updateBusinessRules</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>This api is used to update the configured business hour rule From Monday to Sunday.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/admin/updateBusinessRules?apiKey=***************&businessRuleName=Rule1&description=Indian standard time shift 1.&timeSettings={"monday":"1-5","tuesday":"3-6","wednesday":"3-5","thursday":"2-5","friday":"5-13"}&businessRuleId=1</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>description</b></div> <div class="divTableCell">Description about the business rule.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>businessRuleName</b></div> <div class="divTableCell">Name of the business hour rule.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>timeSettings</b></div> <div class="divTableCell">Time configuration From Monday to Sunday.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>businessRuleId</b></div> <div class="divTableCell">ID of the business hour rule.</div> </div> </div> </div> </div> </div> <div id="getReportData" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getReportData</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>The api to fetch data of report builder reports.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/v2/device/getReportData?apiKey=***************&deviceList=moname1,moname2&monitorList=DevicesAvailability,ResponseTime,WMI-CPUUtilization,MSSQLDataFilesSizeKB&timePeriod=Last_Month&view=table&timeWindow=0-24&startDate=2020-11-09&endDate=2020-11-18-18</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{ "DevicesAvailability - Percentage": [ { "seriesname": "Ground Floor AD Server", "data": [ [ 1667759400000, 0, "DevicesAvailability" ], [ 1667763000000, 0, "DevicesAvailability" ], [ 1667766600000, 0, "DevicesAvailability" ], [ 1667770200000, 0, "DevicesAvailability" ], [ 1667773800000, 0, "DevicesAvailability" ], [ 1667777400000, 0, "DevicesAvailability" ], [ 1667781000000, 0, "DevicesAvailability" ], [ 1667784600000, 0, "DevicesAvailability" ], [ 1667788200000, 0, "DevicesAvailability" ], [ 1667791800000, 0, "DevicesAvailability" ], [ 1667795400000, 0, "DevicesAvailability" ], [ 1667799000000, 0, "DevicesAvailability" ] ], "yaxiscolumnorder": [ 0 ], "id": "20000049227" } ], "Packet Loss - Percentage": [ { "seriesname": "Ground Floor AD Server", "data": [ [ 1667759400000, 100, "Packet_Loss" ], [ 1667763000000, 100, "Packet_Loss" ], [ 1667766600000, 100, "Packet_Loss" ], [ 1667770200000, 100, "Packet_Loss" ], [ 1667773800000, 100, "Packet_Loss" ], [ 1667777400000, 100, "Packet_Loss" ], [ 1667781000000, 100, "Packet_Loss" ], [ 1667784600000, 100, "Packet_Loss" ], [ 1667788200000, 100, "Packet_Loss" ], [ 1667791800000, 100, "Packet_Loss" ], [ 1667795400000, 100, "Packet_Loss" ], [ 1667799000000, 100, "Packet_Loss" ] ], "id": "20000001078" } ] }</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>deviceList</b></div> <div class="divTableCell">Device list to fetch the report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>monitorList</b></div> <div class="divTableCell">Monitor list to fetch the report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>timePeriod</b></div> <div class="divTableCell">Time period to fetch the report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>view</b></div> <div class="divTableCell">Viewing report in table/graph format.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>tableView</b></div> <div class="divTableCell">To show the report data in instance/Monitor wise.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>combinedTable</b></div> <div class="divTableCell">Boolean value to show combined table results.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>startDate</b></div> <div class="divTableCell">Start date of the report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>endDate</b></div> <div class="divTableCell">End date of the report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>startHour</b></div> <div class="divTableCell">Start hour of the report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>endHour</b></div> <div class="divTableCell">End hour of the report data.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>timeWindow</b></div> <div class="divTableCell">The time window to fetch the report data.</div> </div> </div> </div> </div> </div> <div id="listAllAdvancedReports" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">listAllAdvancedReports</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>This api can be used to fetch all the created Advanced Reports.</p> <p><b>Sample URL: </b>https://<host>: <port> /api/json/reports/listAllAdvancedReports?apiKey=*********************************** </port> </host><b> <host> <port> </port> </host> </b></p> <p class="yellow-box1"><b>Sample Response: </b><code>[ { "Description": "Interfaces Availability report", "ReportId": 6903, "Name": "Intf Rep" }, { "Description": "Availbility reports for servers", "ReportId": 6904, "Name": "Device Avail" }, { "Description": "Report one for interfaces", "ReportId": 16201, "Name": "Report 1" }, { "Description": "Report two for devices", "ReportId": 16806, "Name": "Report 2" } ]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey</b></div> <div class="divTableCell">An apiKey enables you to access OpManager server.</div> </div> </div> </div> </div> </div> </div> <div id="Subnets" class="scroll-parent"> <h1>Subnets</h1> <div id="listSubnets" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">listSubnets</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the Subnets monitored in OpManager</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/listSubnets?apiKey=***************</code></p> <p class="yellow-box1"><b>Sample Response: </b><code> {"127.0.0.0.10000000001":{"data":[{"Status":"7","Label":"Unknown","Count":"25"}],"displayName":"127.0.0.0","subnetDisplayName":"ProductionSite"},"xxx.xxx.xxx.x.10000000001":{"data":[{"Status":"1","Label":"Critical","Count":"147"}],"displayName":"xxx.xxx.xxx.x","subnetDisplayName":"TestingPlant"}} </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> </div> </div> </div> </div> </div> <div id="Wireless" class="scroll-parent"> <h1>Wireless</h1> <div id="getWirelessNetworkDetails" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getWirelessNetworkDetails</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists Access Points, Client Count and Network Usage for each SSID in Wireless LAN Controller</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/wireless/getWirelessNetworkDetails?apiKey=***************&deviceName=CiscoWirelessController</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"ClientCount":"40","TotalBytes":"224.548 MBps","SSIDName":"Mobile-Connect","APCount":"20"},{"ClientCount":"20","TotalBytes":"224.546 MBps","SSIDName":"Machine-Connect","APCount":"20"},{"ClientCount":"20","TotalBytes":"196.161 MBps","SSIDName":"Free-Connect","APCount":"20"}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName*</b></div> <div class="divTableCell">Name of the WLC device (Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response)</div> </div> </div> </div> </div> </div> <div id="getWirelessAPList" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getWirelessAPList</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all Access Points in the WLC Device.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/wireless/getWirelessAPList?apiKey=***************&deviceName=CiscoWirelessController</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"macAddress":"1:50:bf:7:xx:xx","channels":"53,64","statusStr":"Clear","ipAddress":"127.0.0.1","apDisplayName":"South-0011","advanceMonitoringEnabled":"true","apName":"ap-127.0.0.1-1.80.191.7.xxx.xx","statusNum":"5"},{"macAddress":"1:50:bf:7:xx:xx","channels":"53,64","statusStr":"Not Monitored","ipAddress":"127.0.0.1","apDisplayName":"North021","advanceMonitoringEnabled":"false","apName":"ap-127.0.0.1-1.80.191.7.xxx.xx","statusNum":"7"},{"macAddress":"1:50:bf:7:xx:xx","channels":"53,64","statusStr":"Not Monitored","ipAddress":"127.0.0.1","apDisplayName":"South0021","advanceMonitoringEnabled":"false","apName":"ap-127.0.0.1-1.80.191.7.xxx.xx","statusNum":"7"},{"macAddress":"1:50:bf:7:xx:xx","channels":"53,64","statusStr":"Not Monitored","ipAddress":"127.0.0.1","apDisplayName":"North0031","advanceMonitoringEnabled":"false","apName":"ap-127.0.0.1-1.80.191.7.xxx.xx","statusNum":"7"}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName*</b></div> <div class="divTableCell">Name of the WLC device (Managed Entity name seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response)</div> </div> </div> </div> </div> </div> <div id="getSSIDClientList" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getSSIDClientList</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Lists all the SSID Clients associated with the given WLC device.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/wireless/getSSIDClientList?apiKey=***************&deviceName=CiscoWirelessController</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"clientData":[{"displayName":"Mobile-Connect","ClientCount":"40"},{"displayName":"Free-Connect","ClientCount":"20"},{"displayName":"Machine-Connect","ClientCount":"20"}],"clientCount":80}</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName*</b></div> <div class="divTableCell">Name of the WLC device (Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response)</div> </div> </div> </div> </div> </div> <div id="getClientDetails" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getClientDetails</h3> <p><b>Method: </b>GET</p> <p><b>Description: </b>Fetches the client devices connected to the given SSID of WLC device.</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/wireless/getClientDetails?apiKey=***************&deviceName=CiscoWirelessController&ssidName=WorkstationNetwork</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>[{"ClientCount":"2","TotalBytes":"28.156 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"North0041"},{"ClientCount":"2","TotalBytes":"28.154 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"North0031"},{"ClientCount":"2","TotalBytes":"14.079 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"North0101"},{"ClientCount":"2","TotalBytes":"14.079 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"South0081"},{"ClientCount":"2","TotalBytes":"14.079 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"North0061"},{"ClientCount":"2","TotalBytes":"14.078 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"North0091"},{"ClientCount":"2","TotalBytes":"14.078 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"North0071"},{"ClientCount":"2","TotalBytes":"14.077 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"South0031"},{"ClientCount":"2","TotalBytes":"14.077 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"North0051"}]</code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>deviceName*</b></div> <div class="divTableCell">Name of the WLC device (Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response)</div> </div> <div class="divTableRow"> <div class="divTableCell"><b>ssidName*</b></div> <div class="divTableCell">SSID name of the wireless network associated to WLC</div> </div> </div> </div> </div> </div> </div> <div id="Settings" class="scroll-parent"> <h1>Settings</h1> <div id="getCategoryList" class="scroll-topic"> <div class="api-content-main"> <h3 class="mod-title">getCategoryList</h3> <p><b>Method: </b>POST</p> <p><b>Description: </b>Lists all the available device categories</p> <p><b>Sample URL: </b><code class="wrap-txt">https://localhost:8060/api/json/device/getCategoryList?apiKey=***************</code></p> <p class="yellow-box1"><b>Sample Response: </b><code>{"Wireless":"Wireless","Server":"Server","UCS":"UCS","WirelessLANController":"Wireless LAN Controller","DomainController":"DomainController","Printer":"Printer","IoT":"IoT","MerakiRadio":"Meraki Radio","Unknown":"Unknown","MerakiCellularGateway":"Meraki Cellular Gateway","UPS":"UPS","WirelessAccessPoint":"Wireless Access Point","MerakiVision":"Meraki Vision","SDN":"SDN","TapeLibrary":"TapeLibrary","PDU":"PDU","IPMI":"IPMI","MerakiSwitch":"Meraki Switch","FCSwitch":"FCSwitch","LoadBalancer":"Load Balancer","Router":"Router","RAID":"RAID","Firewall":"Firewall","Storage":"Storage","Desktop":"Desktop","Switch":"Switch","MerakiController":"Meraki Controller","MerakiSecurity":"Meraki Security","WANAccelerator":"WAN Accelerator"} </code></p> <div class="divTable"> <div class="divTableHeading"> <div class="divTableRow"> <div class="divTableCell">Parameter name</div> <div class="divTableCell">Description</div> </div> </div> <div class="divTableBody"> <div class="divTableRow"> <div class="divTableCell"><b>apiKey*</b></div> <div class="divTableCell">API Key to access your OpManager server.</div> </div> </div> </div> </div> </div> </div> <div class="doc_feedback show"> <div class="hide useful"> <p>Thank you for your feedback!</p> </div> <div class="not-useful"> <form class="edi-btn" action="https://creator.zohopublic.com/addRecordValidate.do" method="post" name="Help_Pages_Customer_Feedback" autocomplete="off"> <div class="decision"><span class="quest">Was this content helpful?</span> <div class="ans"><input name="Was_this_content_helpful" id="feedbackYes" type="button" value="Yes" class="btnfeedback" onclick="decision(this)" /> <input name="Was_this_content_helpful" id="feedbackNo" type="button" value="No" class="btnfeedback" onclick="decision(this)" /></div> </div> <div class="hide formdiv"> <p>We are sorry. Help us improve this page.</p> <input type="hidden" name="formid" value="46442000298877538" /> <input type="hidden" name="formLinkName" value="Help_Pages_Customer_Feedback" /> <input type="hidden" name="appLinkName" value="itom" /> <input type="hidden" name="sharedBy" value="adventnetwebmaster" /> <input type="hidden" id="Page_URL" name="Page_URL" value="adventnetwebmaster" /> <input type="hidden" name="nexturl" id="nxtURL" value="https://www.manageengine.com/network-monitoring/help/" /> <input name="scriptembed" value="true" type="hidden" /> <input type="hidden" name="privatelink" value="tgZz86X5E9sWh50yXOPMrQ3RwUrBTfWbDEgOAQXX2BZ3q8tJauOFVUxfCDp3KSWfabkMRVVX0MGnzyFaPjwmW2T8TWt5NxTB3Ozy" /> <input type="hidden" name="Was_this_article_useful" value="" /> <input type="hidden" name="Source" id="Source" value="" /> <input type="hidden" id="Was_this_content_helpful1" name="Was_this_content_helpful1" value="Yes" /> <input type="hidden" name="productname" value="OpManager" /> <input type="hidden" name="leadsource" value="General" /> <div class="form-fields"> <div class="fed_op"> <h6>How can we improve this page?</h6> <div class="improve"> <div class="input-group"><input id="f1" type="checkbox" name="How_can_we_improve_this_page" value="Need more information on this topic" /> <label for="f1">Need more information on this topic</label></div> <div class="input-group"><input id="f2" type="checkbox" name="How_can_we_improve_this_page" value="Need better screenshots" /> <label for="f2">Need better screenshots</label></div> <div class="input-group"><input id="f3" type="checkbox" name="How_can_we_improve_this_page" value="Need clear step by step instructions" /> <label for="f3">Need clear step by step instructions</label></div> <div class="input-group"><input id="f4" type="checkbox" name="How_can_we_improve_this_page" value="Others" /> <label for="f4">Others</label></div> </div> <div id="feedback-comment" class="hide"><textarea placeholder="How can we improve it?" name="Feedback_Comment" spellcheck="true" rows="6" required=""></textarea></div> <div class="input-group feed_dec"> <h6>Do you need assistance with this topic?</h6> <div class="flex"><input type="radio" name="Do_you_need_assistance_with_this_topic" value="Yes" id="Yes" /> <label for="Yes">Yes</label> <input type="radio" name="Do_you_need_assistance_with_this_topic" value="No" id="No" /> <label for="No">No</label></div> </div> </div> <div class="reporter_details"> <div class="input-group"><input class="hide" type="text" id="zc-Name" name="Name" placeholder="Enter your Full Name *" /></div> <div class="input-group"><input class="hide" type="email" id="Email" name="Business_Email1" placeholder="Enter your Business Email address *" /></div> <div class="input-group"> <div class="hide input-group country select"><select data-countrygdpr="MECountryListing" id="zc-country" name="country"> </select> <input type="hidden" id="gdpr_con" name="gdpr_country" /> <div class="dwn-priv tac" data-clickgdpr="formCTAgdpr">By clicking "Submit", you agree to processing of personal data according to the <a href="https://www.manageengine.com/privacy.html">Privacy Policy</a>.</div> </div> </div> </div> </div> </div> <input type="submit" name="Submit1" id="Submit" value="Submit" class="hide" /> </form> </div> </div> </div> </div> </div> </div> </div>  <div class="doc_feedback"> <div class="hide useful"> <p>Thank you for your feedback!</p> </div> <div class="not-useful"> <form class="edi-btn" action="https://creator.zohopublic.com/addRecordValidate.do" method="post" name="Help_Pages_Customer_Feedback" autocomplete="off"> <div class="decision"><span class="quest">Was this content helpful?</span> <div class="ans"><input name="Was_this_content_helpful" id="feedbackYes" type="button" value="Yes" class="btnfeedback" onclick="decision(this)" /> <input name="Was_this_content_helpful" id="feedbackNo" type="button" value="No" class="btnfeedback" onclick="decision(this)" /> </div> </div> <div class="hide formdiv"> <p>We are sorry. Help us improve this page.</p> <input type="hidden" name="formid" value="46442000298877538" /> <input type="hidden" name="formLinkName" value="Help_Pages_Customer_Feedback" /> <input type="hidden" name="appLinkName" value="itom" /> <input type="hidden" name="sharedBy" value="adventnetwebmaster" /> <input type="hidden" id="Page_URL" name="Page_URL" value="adventnetwebmaster" /> <input type="hidden" name="nexturl" id="nxtURL" value="https://www.manageengine.com/network-monitoring/help/" /> <input name="scriptembed" value="true" type="hidden" /> <input type="hidden" name="privatelink" value="tgZz86X5E9sWh50yXOPMrQ3RwUrBTfWbDEgOAQXX2BZ3q8tJauOFVUxfCDp3KSWfabkMRVVX0MGnzyFaPjwmW2T8TWt5NxTB3Ozy" /> <input type="hidden" name="Was_this_article_useful" value="" /> <input type="hidden" name="Source" id="Source" value="" /> <input type="hidden" id="Was_this_content_helpful1" name="Was_this_content_helpful1" value="Yes" /> <input type="hidden" name="productname" value="OpManager" /> <input type="hidden" name="leadsource" value="General" /> <div class="form-fields"> <div class="fed_op"> <h6>How can we improve this page?</h6> <div class="improve"> <div class="input-group"><input id="f1" type="checkbox" name="How_can_we_improve_this_page" value="Need more information on this topic" /> <label for="f1">Need more information on this topic</label></div> <div class="input-group"><input id="f2" type="checkbox" name="How_can_we_improve_this_page" value="Need better screenshots" /> <label for="f2">Need better screenshots</label></div> <div class="input-group"><input id="f3" type="checkbox" name="How_can_we_improve_this_page" value="Need clear step by step instructions" /> <label for="f3">Need clear step by step instructions</label></div> <div class="input-group"><input id="f4" type="checkbox" name="How_can_we_improve_this_page" value="Others" /> <label for="f4">Others</label></div> </div> <div id="feedback-comment" class="hide"><textarea placeholder="How can we improve it?" name="Feedback_Comment" spellcheck="true" rows="6" required=""></textarea></div> <div class="input-group feed_dec"> <h6>Do you need assistance with this topic?</h6> <div class="flex"><input type="radio" name="Do_you_need_assistance_with_this_topic" value="Yes" id="Yes" /> <label for="Yes">Yes</label> <input type="radio" name="Do_you_need_assistance_with_this_topic" value="No" id="No" /> <label for="No">No</label></div> </div> </div> <div class="reporter_details"> <div class="input-group"><input class="hide" type="text" id="zc-Name" name="Name" placeholder="Enter your Full Name *" /></div> <div class="input-group"><input class="hide" type="email" id="Email" name="Business_Email1" placeholder="Enter your Business Email address *" /></div> <div class="input-group"> <div class="hide input-group country select"><select data-countrygdpr="MECountryListing" id="zc-country" name="country"> </select> <input type="hidden" id="gdpr_con" name="gdpr_country" /> <div class="dwn-priv tac" data-clickgdpr="formCTAgdpr">By clicking "Submit", you agree to processing of personal data according to the <a href="https://www.manageengine.com/privacy.html">Privacy Policy</a>.</div> </div> </div> </div> </div> </div> <input type="submit" name="Submit1" id="Submit" value="Submit" class="hide" /> </form> </div> </div> </div> </div> </section> <section> <div class="btmBar mbH"> <div id="btmBar"> <div class="container clearfix"> <ul class="clearfix"> <li class="btm-dwn"><a title="Download ManageEngine OpManager" href="https://www.manageengine.com/network-monitoring/download.html?btmMenu">Download <span class="s-icon icon-s-download"> </span></a></li> <li><a title="Live Demo - ManageEngine OpManager" target="_blank" href="https://demo.opmanager.com/"><span class="s-icon icon-s-demo"> </span><br> Live Demo</a></li> <li><a title="Compare Edition - ManageEngine OpManager" href="https://www.manageengine.com/network-monitoring/opmanager-editions.html?btmMenu"><span class="s-icon icon-s-compare"> </span><br> Compare</a></li> <li><a title="Get Quote - ManageEngine OpManager" href="https://www.manageengine.com/network-monitoring/get-quote.html?btmMenu"><span class="s-icon icon-s-quote"> </span><br> Get Quote</a></li> <li><a title="Buy Now - ManageEngine OpManager" target="_blank" href="https://store.manageengine.com/opmanager/"><span class="s-icon icon-s-buynow"> </span><br> Buy Now</a></li> </ul> </div> </div> </div> </section> <footer id="meCommonFooterNew"></footer> <script src="https://accounts.zoho.com/u/info" type="text/javascript"></script> <script src="https://www.manageengine.com/js/me-v1-header-a.js"></script> <script src="/js/me-new-v1.js"></script> <script src="/network-monitoring/help/scripts/common.js"></script> <script src="/network-monitoring/help/scripts/tree_nodes.js"></script> <script type="text/javascript"> jQuery( document ).ready(function(){ jQuery("#lhsTree li:first").removeClass("icon_plus").addClass("heading icon_minus"); jQuery("#lhsTree ul:first").removeClass("mainmenu").addClass("icon_plus heading"); }); </script> <script>$(document).ready(function(){$("#storelnk").attr("href", "https://store.manageengine.com/opmanager/");$("#forumlnk").attr("href", "https://forums.manageengine.com/opmanager");$("#blogslnk").attr("href", "https://blogs.manageengine.com/opmanager");$("#smaplnk").attr("href", "//www.manageengine.com/network-monitoring/sitemap.html");$("#fbacklnk").attr("data-feedback", "49000004360343");});</script> <script>$('.ssRhs').append('<li><a href="tel:+18442451099"><strong>US:</strong> +1 844 245 1099</a></li><li><span>Direct Inward Dialing</span></li><li><a href="tel:+14089169400"><strong>Tel:</strong> +1 408 916 9400</a></li>');</script> <script> // $(document).off('click', '[type="submit"]'); var feddback_value = ''; $('#feedbackYes').click(function () { getMarkvalcreator(); var loc = window.location.href; $('#nxtURL').val(loc); feddback_value = $(this).val(); $('#Page_URL').val(loc); var was_val = $(this).val(); $('#Was_this_content_helpful1').val(was_val) setTimeout(function () { document.Help_Pages_Customer_Feedback.submit() }, 6000); }); $('#feedbackNo').click(function () { $('.formdiv').removeClass('hide'); feddback_value = $(this).val(); $('#Submit').removeClass('hide'); var was_val = $(this).val(); $('#Page_URL').val(loc); $('#Was_this_content_helpful1').val(was_val) }); $('#Submit').click(function () { var improve_val = $(".improve input[type=checkbox]:checked").val(); console.log(improve_val); if (feddback_value != "Yes") { if (!$(".improve input[type=checkbox]").is(':checked')) { alert("Please select How can we improve this page?"); return false; } else if (!$(".feed_dec input[type=radio]").is(':checked')) { alert("Please select Do you need assistance with this topic?"); return false; } else { $('textarea[name="Feedback_Comment"]').focus().css({ 'border': '1px solid #ccc' }); var assistace = $(".feed_dec input[type=radio]:checked").val(); if (assistace == "No") { $(".improve input[type=checkbox]:checked").each(function () { if ($(this).val() == "Others") { if (!(document.Help_Pages_Customer_Feedback.Feedback_Comment.value)) { $('textarea[name="Feedback_Comment"]').focus().css({ 'border': '1px solid red' }); return false; } } else { getMarkvalcreator(); var loc = window.location.href; $('#nxtURL').val(loc); $('#Page_URL').val(loc); setTimeout(function () { document.Help_Pages_Customer_Feedback.submit() }, 6000); } }); } else if (assistace = "Yes") { var mailformat = /^[a-z0-9]([a-z0-9_\-\.\+]*)@([a-z0-9_\-\.]+)(\.[a-z]{2,6}){1,2}$/i; var EmailId = document.Help_Pages_Customer_Feedback.Business_Email1.value; var Name = document.Help_Pages_Customer_Feedback.Name.value; $(".improve input[type=checkbox]:checked").each(function () { if ($(this).val() == "Others") { if (!(document.Help_Pages_Customer_Feedback.Feedback_Comment.value)) { $('textarea[name="Feedback_Comment"]').focus().css({ 'border': '1px solid red' }); return false; } } else if (!(document.Help_Pages_Customer_Feedback.Name.value)) { $('input[name="Name"]').focus().css({ 'border': '1px solid red' }); return false; } if (!mailformat.test(EmailId)) { $('input[name="Business_Email1"]').focus().css({ 'border': '1px solid red' }); return false; } else { getMarkvalcreator(); var loc = window.location.href; $('#nxtURL').val(loc); $('#Page_URL').val(loc); setTimeout(function () { document.Help_Pages_Customer_Feedback.submit() }, 6000); } }); } } } }); $(document).ready(function () { $("input[name='Name']").keypress(function () { if ($(this.length > 1)) { $('input[name="Name"]').focus().css({ 'border': '1px solid #0090E0' }); } }); $("textarea[name='Feedback_Comment']").keypress(function () { if ($(this.length > 1)) { $('textarea[name="Feedback_Comment"]').focus().css({ 'border': '1px solid #0090E0' }); } }); $("input[name='Business_Email1']").keypress(function () { if ($(this.length > 1)) { $('input[name="Business_Email1"]').focus().css({ 'border': '1px solid #0090E0' }); } }); }); </script> <script> function decision(e) { decision_state = e.value; } var decision_state; console.log(decision_state); $(document).ready(function () { $(".doc_feedback input,.doc_feedback select").on("change", function () { $('[name="gdpr_country"]').val($('[name="country"]').val()); if ($('[name="Do_you_need_assistance_with_this_topic"]#Yes').is(":checked")) { $('[name="Business_Email1"], .input-group.country').removeClass("hide"); $('[name="Name"], .input-group.country').removeClass("hide"); } else { $('[name="Business_Email1"], .input-group.country').addClass("hide"); $('[name="Name"], .input-group.country').addClass("hide"); } if ($('[name="How_can_we_improve_this_page"]#f4').is(":checked")) { $('#feedback-comment').removeClass("hide"); $('[name="Feedback_Comment"]').attr("required", ""); } else { $('#feedback-comment').addClass("hide"); $('[name="Feedback_Comment"]').removeAttr("required"); } }); $('.doc_feedback [name="How_can_we_improve_this_page"]').on("change", function () { if ($(this).is(":checked")) { $(".feed_dec").addClass("active"); } }); $('.doc_feedback [name="Do_you_need_assistance_with_this_topic"]').on("change", function () { if ($(this).is(":checked")) { $('[name="Submit1"]').removeClass("hide"); if ($(this).val() == "Yes") { $('[name="Business_Email1"]').attr("required", ""); $('[name="Name"]').attr("required", ""); } else { $('[name="Business_Email1"]').removeAttr("required"); $('[name="Name"]').removeAttr("required"); } } }); $(".doc_feedback input").on("click", function () { if ($(this).attr("id") == "feedbackYes") { $(".useful").removeClass("hide"); $(".not-useful").addClass("hide"); $(".decision").addClass("hide"); $('input[name ="Was_this_article_useful"]').val("Yes"); setTimeout(function () { $('[name="Submit1"]').trigger("click"); }, 1000); } else if ($(this).attr("id") == "feedbackNo") { $(".not-useful").removeClass("hide"); $(".useful").addClass("hide"); $(".decision").addClass("hide"); $('input[name ="Was_this_article_useful"]').val("No"); } }); var suc_msg_yes = "Thank you for taking the time to respond. We'll get back to you."; var suc_msg_no = "Thank you for taking the time to respond."; var suc_msg; if (location.search == "?feedback_thanks") { suc_msg = suc_msg_yes; } if (location.search == "?feedback") { suc_msg = suc_msg_no; } }); </script> <script>$('[data-popcont]').click(function (e){ e.preventDefault(); var getCont=$(this).attr('href'); $('.pop-container').html( '<span id="close"> </span><iframe class="iframe-center" frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="' + getCont + '"></iframe>'); $('.pop-box,.pop-container').fadeIn();}); $(document).ready(function () { $('#api-con').next('.doc_feedback').remove(); }); </script> <script src="/network-monitoring/style/opm-api.js" type="text/javascript"></script> </body> </html>

CINXE.COM

OpManager REST API | OpManager Help