Common use of Trademarks Clause in Contracts

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Guide Updated - November 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Infrastructure Utilities User and Reference Guide Updated - November 2018 Software December 2017 Foglight Version - 5.9.x Getting Started Glossary 5.9.2 Foglight Web Monitor Version 5.9.2 Foglight Net Monitor Version 5.9.2 Introduction to this guide 6 Prerequisites 6 Overview Monitoring Web transactions 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout Configuring credentials for Web sites requiring user or proxy authentication 7 Configuring credentials to access Web sites requiring user authentication 9 Configuring credentials for accessing Web sites through proxy servers 12 Security — Set Auth Token Monitoring URLs that require a client certificate 16 Exploring your collection of monitored Web sites 17 Expanding your collection of monitored sites 18 Removing Web sites from the existing collection 20 Moving multiple transactions as a group 21 Removing stale transactions from the Performance Browser dashboard 22 Viewing and editing individual Web transaction details 23 Investigating the performance of Web transactions and monitoring locations 26 Exploring the FAQts tab 26 Drilling down on transactions 27 Drilling down on locations via the Locations tab 28 Exploring Web Monitor services 29 Generating reports 32 Configuring Web Monitor agent properties 33 Settings 33 Data Collection Scheduler 35 View reference 35 Web Monitor Performance Browser views 35 Web Monitor Transaction Management views 58 Web Monitor Service Operation Console and Foglight for a given user 12 Security — Delete Auth Token APM Transactions views 62 Monitoring network devices 66 Configuring the ICMP service for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 monitoring 66 Configuring the Agent 14 Agent — Get Manager ICMP service 67 Configuring OS-Level ICMP services 68 Managing monitored network devices 68 Expanding your collection of monitored network devices 70 Removing network devices from the existing collection 73 Viewing and editing individual network device details 73 Investigating the performance of network devices 76 Exploring individual network devices 77 Tracing data packets between monitoring locations and network devices 78 Exploring the FAQ tab 79 Generating reports 80 Configuring the agent by properties 80 Configuring Net Monitor agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 81 View reference 83 Net Monitor Devices Management views 83 About Us 103 We are more than just a name 45 103 Our brand, our vision. Together 45 103 Contacting Quest 45 103 Technical support resources 45 Getting Started‌ The 103 Introduction to this guide‌ Welcome to the Infrastructure Utilities User and Reference Guide. This User and Reference Guide provides agent configuration instructions and information on investigating the performance of monitored Web sites and monitored network devices. It describes the dashboards included with Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POSTWeb Monitor and Foglight Net Monitor, and DELETE datacontains instructions for configuring monitoring agents that collect information from monitored systems. The Foglight REST API Reference Guide This guide is intended for users any user who have been assigned wants to know more about the API Access monitoring agent properties and the Administrator roles dashboards included with these utilities. It is also meant for those users that want to learn about the rules that are included with the Infrastructure utilities. Foglight Log Monitor is an infrastructure utility shipped with Foglight for Infrastructure which monitors log files and who need programmatic access identifies activities that can potentially lead to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIsperformance issues. For more informationinformation about Foglight Log Monitor, see the following topics: • Glossary • Prerequisites • OverviewFoglight for Infrastructure Release Notes and User and Reference Guide.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Federation Field Guide Updated - November June 2018 Software Version - 5.9.x Getting Started Glossary Federation overview 5 Use cases 5 Capabilities 6 Prerequisites 6 Overview Known issues 7 REST APIs App Requirements 8 Scalability expectations 9 Managing federation 10 APP — Get App information Understanding federation communication channels 10 Topology synchronization 10 Metric pull on demand 11 Alarm service communication channel 12 Planning for federation 13 Communication ports 13 HA considerations 14 Configuring a federated environment 14 Setting up a federated environment 14 Federation configuration changes 16 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for settings 17 Query limitations 18 Custom script queries 19 Upgrading cartridges on a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms federated system 19 Alarm — Get history alarms Selectively disabling federation services 19 Alarm — Get topology object current alarms Deploying cartridge components 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms Troubleshooting 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Frequently asked questions 21 About Us 27 We are more than just a name 45 27 Our brand, our vision. Together 45 27 Contacting Quest 45 27 Technical support resources 45 Getting Started‌ The 27 Federation overview‌ Federation is a Foglight® feature that addresses the needs of customers who monitor large-scale environments that are naturally partitioned into logical units. Each partition is traditionally served by one Foglight REST API is Management Server instance and its distributed clients/agents. This document presents an application programming interface (API) that uses HTTP requests to GET, PUT, POST, overview of the federation feature and DELETE dataprovides guidelines for configuring Federation Masters and Federated Children. The Foglight REST API Reference Guide intended audience for this document is intended for users who have been assigned the API Access and Quest SC/PSO (System Consultant/Professional Services Organization) personnel working in the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systemsfield. This section introduces you to describes a number of cases where the Foglight REST APIsfederation feature is used. For more informationIn addition, see a list of federation capabilities, known issues, and requirements are provided. • Use cases • Capabilities • Known issues • Requirements • Scalability expectations Use cases‌ Federation enables the use of one Foglight® Management Server to operate, while using other Management Servers as the data source. As illustrated in the following topics: • Glossary • Prerequisites • Overviewfigure, a Foglight user can visualize the data from one or more stand-alone Management Servers (the Federated Children) from a single, central Management Server (the Federation Master). This allows users to meet both local and central monitoring requirements.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Performance Tuning Field Guide Updated - November 2018 April 2017 Software Version - 5.9.x 5.7.5.8 Contents Overview 7 Characteristics of Poor Performance in Foglight 7 Parameters that Affect Foglight Performance 7 Critical Areas that Can Affect Foglight Performance 8 Identifying Performance Problems 8 Hardware and Operating System Tuning 9 Running on Virtual Hardware 10 Performance Challenges 10 CPU 11 Memory 11 Shares 12 Disk 12 Management Server Tuning 13 Dashboard Default Timeout 14 Java Virtual Machine Tuning 16 Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 16 Foglight JVM Configuration 16 JVM Options 17 Common Symptoms and Tuning Resolutions 19 JVM Code Cache 20 Backend Database Tuning 22 Initial Database Configuration Settings 22 Monitoring and Managing Database Size 22 Backup and Recovery Recommendations 22 init.ora Configuration 22 Database Maintenance Recommendations 23 MySQL Tuning 23 Case 23 Oracle Tuning 24 How the Management Server Uses the Database 24 Index Management 24 Memory 25 Block Size 25 Oracle Striping 25 Oracle Tablespaces 25 Microsoft SQL Server Tuning 28 Troubleshooting 28 Management Server Load Preventing Database Connections 28 Foglight 5.7.5.8 Performance Tuning Field Guide Contents High Availability (HA) Tuning 31 Tuning Connection Issues in an HA Implementation 31 Managing Hosts with Multiple Network Interfaces 32 JDK with IPv6 on Linux 33 Management Server Automatically Restarted 33 Other JGroup Related Issues and Information 33 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value Tuning 34 Topology — Get topology object by id Changes and Topology Churn 34 Canonical Data Transformations (CDTs) 35 Agent Weight / Environment Complexity 35 Large Topologies 36 Sampling Frequency 36 XML-HTTP Agent Adapter 36 Dropped Agent Manager Log Messages 37 Java EE Technologies 37 Store and Forward Processing 38 About Store and Forward Processing in Foglight 38 Store and Forward Processing and the Foglight Management Server 38 Store and Forward Processing and the Foglight Agent Manager 39 Viewing the Settings that Control the Size of Stored Data 39 Examples 40 Example 1: Reporting on Disk Usage 41 Example 2: Calculating Service Availability Metrics 41 Appendix: Performance Health Check 42 Is the Server Getting the Right Amount of Memory? 42 Management Server Memory is Healthy if 42 Management Server Memory Checks 43 Possible Actions 43 Is the Server Getting Enough CPU? 43 Management Server CPU is Healthy if 43 Management Server CPU Checks 43 Extended Browser Interface Checks 44 Possible Actions 44 Is the Database too Slow? 44 The Database is Healthy if 44 Database Checks 45 Possible Actions 45 Is the Database Growth Reasonable? 45 Database Growth is Healthy if 46 Possible Actions 46 Is There Too Much Data to Process? 46 Data Volume is Healthy if 46 Data Volume Checks 46 Is the Model Stable? 47 The Model is Healthy if 47 Model Checks 47 Possible Actions 47 Are Too Many Alarms Firing? 47 The Number of Alarms is in a Healthy State if. 47 Alarms Checks 48 Possible Actions 48 Is the Business Logic Properly Tuned? 48 Business Logic is Healthy if. 48 Business Logic Checks 48 Possible Actions 48 Are There Too Many User Requests? 49 User Activity Is Healthy If. 49 Possible Actions 49 Appendix: Analyzing a Support Bundle 50 Server Log 50 Topology — Get topology object by ids 35 Sync 50 Topology — Observations query 36 Limits 50 Diagnostic Snapshot 51 Memory Consumption 51 Threads, Deadlocks, and Overall CPU Usage 51 Useful Information 51 ---- jboss.system:type=ServerInfo 51 ---- jboss.jca:service=ManagedConnectionPool,name=jdbc/nitrogen 52 ---- jboss.web:type=RequestProcessor,* 52 ---- com.quest.nitro:service=Derivation 52 ---- com.quest.nitro:service=Topology — TopologyObject query 37 53 ---- com.quest.nitro:service=DataCacheEviction 54 Analyzing a Performance Report 55 Server Rule Information 55 System-wide Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Changes 56 JVM Memory Usage 56 Management Server Garbage Collectors 58 JDBC Connection Pool 59 Derivation Rulette 60 About Us 61 We are more than just a name 45 61 Our brand, our vision. Together 45 61 Contacting Quest 45 61 Technical support resources 45 Getting Started‌ The Foglight REST API 61 Overview‌ Performance is a measure of the efficiency of an application programming running in an environment or of the overall efficiency of multiple applications running in the same environment. You tune performance in order to optimize it. • Characteristics of Poor Performance in Foglight • Parameters that Affect Foglight Performance • Critical Areas that Can Affect Foglight Performance • Identifying Performance Problems Characteristics of Poor Performance in Foglight‌ The following items characterize poor performance in the Foglight™ environment: • poor performing (slow) browser interface • missing data • high CPU load for the Foglight Management Server process • high CPU load for the database backend process • excessive memory utilization (APIor out of memory) • long-running SQL statements Parameters that uses HTTP requests to GET, PUT, POSTAffect Foglight Performance‌ Foglight™ is a complicated system, and DELETE dataits runtime performance depends on many variables within the environment. The following parameters have an effect on Foglight REST API Reference Guide performance: • the processing power of the host running the Management Server • the memory of the host running the Management Server • the memory allocated for the Management Server process (heap) • the database backend type (MySQLTM/Oracle®) • the processing power of the host running the database backend • the memory of the host running the database backend • the number of Foglight Agent Managers Foglight’s runtime performance also depends on what it is intended for users who have been assigned monitoring. Critical Areas that Can Affect Foglight Performance‌ It can be difficult to determine that Foglight™ performance is suffering and then identify the API Access and the Administrator roles and who need programmatic access appropriate steps to easily create professional services and better integrate with third-party systemstake. This section introduces guide provides information about the various things that can have an effect on overall performance and describes the applicable performance-related options. The areas that can have an effect on overall performance are: • Hardware and Operating System Tuning • Management Server Tuning • Java Virtual Machine Tuning • Backend Database Tuning • High Availability (HA) Tuning • Agent Tuning Identifying Performance Problems‌ There are two main methods you can use to proactively check the performance of a Foglight™ installation: 1 You can carry out a performance health check to quickly verify whether or not Foglight REST APIsis functioning properly. For more information, see the following topicsAppendix: • Glossary • Prerequisites • OverviewPerformance Health Check on page 42.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Web Component Guide Updated - November 2018 Software April 2022 Foglight Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances 6.1.0 Introducing the Web Component Framework 8 Configuring Views 8 Browser Interface Views 9 The Browser Interface 9 Anatomy of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brandTypical Dashboard 10 The Web Component Framework (WCF) 10 The Design Tab 11 The Web Component Framework 13 Core Concepts 13 Modules 13 Observations 16 Context 19 Parameters in Bindings 19 On Null Values 20 Renderers 20 Default Values 20 Data Sources, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POSTData Types, and DELETE data. Data Objects 20 Paths 21 Properties 21 Using the Web Component Framework 21 The Foglight REST API Reference Guide is intended for users who have been assigned Web Component Framework Editor 21 An Example Page 22 Managing Dashboards 23 Definitions Panes 23 Data and Data Sources Pages 24 Definitions Pane 24 Customizing the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topicsUI Quickly 25 Finding Pages: • Glossary • Prerequisites • OverviewBookmarks 25 Additional Documentation 25

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Getting Started Guide Updated - November 2018 Software April 2023 Foglight Version - 5.9.x Getting Started Glossary 6.3.0 Components 5 Foglight Management Server 5 Foglight browser interface 6 Prerequisites Customizable dashboards 6 Foglight command-line interface 6 Foglight Agent Manager 7 Foglight cartridges 7 Foglight agents 7 Foglight architecture overview 8 Installation and Setup Overview 7 REST APIs App 10 APP — Get App information Part 1: Installing the Management Server 10 Security Part 2: Starting Foglight and logging in 11 Security — Login Part 3: Installing cartridges 11 Security — Logout Part 4: Installing and running the Agent Manager 12 Security — Set Auth Token for Part 5: Deploying and creating agents 13 Starting Points 14 Before you get started 14 Insufficient roles 14 Working in a given user 12 Security — Delete Auth Token for current or a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID diagnostic time range 15 Agent — Get all active agents 15 Agent — Get all agents Foglight Evolve Environment Overview 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms Foglight Operator’s Welcome page 21 Alarm — Push alarms by properties Foglight Administrator’s Welcome page 22 Alarm — Push alarms by query Service Operations Console 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry Hosts dashboard 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule Next steps 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us 27 We are more than just a name 45 27 Our brand, our vision. Together 45 27 Contacting Quest 45 27 Technical support resources 45 Getting Started‌ The Foglight REST API is an 27 Components‌ Quest Software Inc.’s Foglight® solution simplifies application programming interface (API) that uses HTTP requests performance monitoring and reduces the skills and effort required to GETmanage applications, PUT, POSTthe user experience, and DELETE the supporting infrastructure. Unlike other solutions, Foglight uses a single code base, and has a model-driven design that couples fast deployment and accelerated time-to-value. It offers the modular flexibility required to deliver a range of capabilities and sophistication to meet the needs of any organization, from those still focused on technology-centric monitoring to those that have completed the transition to application-centric or transactional monitoring. Foglight performs equally well in physical, virtual, and mixed infrastructure environments, providing visibility into issues affecting the application and end-user experience. Intuitive workflows help you quickly move from the symptom to the root cause in the application, database, infrastructure, or network to resolve issues, reducing mean time to resolution. Predefined and drag-and-drop dashboards provide insight that is tailored to each stakeholder. By offering comprehensive visibility into your monitored environment, Foglight helps ensure that cross-functional teams collaborate on and prioritize issues that matter most to the business. Foglight comprises several different components, which are described individually. You will be installing and using these components as you perform the steps in the installation and setup process and get started using Foglight. • Foglight Management Server • Foglight browser interface • Foglight command-line interface • Foglight Agent Manager • Foglight cartridges • Foglight agents • Foglight architecture overview Foglight Management Server‌ Foglight Management Server is the central component of Foglight. The Management Server receives information from agents, stores and processes data, and makes it available in the browser interface. The Foglight REST API Reference Guide is intended database stores all system, application, and performance data. Over time, it becomes an invaluable source of historical information for users who have been assigned planning future system capacity requirements and for doing point-in-time analysis. Foglight browser interface‌ Foglight has a browser interface that displays data collected from your monitored environment. It allows you to view this data in various formats and levels of detail. The browser interface consists of three areas: • A navigation panel that: ▪ Lists all of the API Access and dashboards that are available to the Administrator roles and who need programmatic current user. ▪ Provides access to easily create professional services the Administration home page, which presents a summary of information about Foglight from an administrative perspective and better integrate with third-party systems. This section introduces allows you to navigate to the Foglight REST APIspages where you perform administrative tasks. For more information, see • A display area in which you can view and create dashboards and reports. • An action panel that: ▪ Lists the following topics: • Glossary • Prerequisites • Overviewvarious actions that you can perform on the dashboard that is currently displayed. ▪ Contains views and data that can be added to a dashboard or report that you are creating. ▪ Provides access to the online help.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API for Exchange User and Reference Guide Updated - November January 2018 Software Foglight Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 5.9.2 Cartridge Version - 5.7.2 Navigation basics 9 Foglight browser interface panels 9 Navigation panel 10 APP — Get App information Display panel 10 Security Action panel 10 Drill down actions 11 Security — Login Breadcrumb trail 11 Security — Logout Time range 11 Lists 11 Sorting content 12 Security — Set Auth Token Hiding columns 12 Filtering content 12 Alarms and state indicators 14 Mouse-over actions 14 Foglight for Exchange roles 14 Exploring the Foglight for Exchange dashboards 16 Accessing the Foglight for Exchange dashboards 16 Exchange Alarms dashboard 17 Exchange Environment dashboard 18 Exchange Environment > Health Check tab 18 Exchange Environment > Monitoring tab 20 Exchange Environment > Administration tab 23 Exchange Environment > Reports tab 24 Exchange Environment > FAQts tab 26 Exchange Explorer dashboard 28 Exchange Infrastructure view 29 Exchange Explorer Primary view 29 Exchange Rule Management dashboard 32 Managing Exchange agents 34 Agent Status dashboard 34 Exchange agent management 34 Tasks list 34 Agent Management view 35 Exchange agent properties 40 Configuration 42 Monitor 43 Data Collection Scheduler 45 Reporting on your Exchange environment 47 Foglight for Exchange reports 47 Foglight for Exchange views 50 Foglight for Exchange 5.7.2 User and Reference Guide 4 Contents Exchange Roles Environment Summary (All Exchange Roles) view 51 Client Access Role Environment Summary view 53 Edge Transport Role Environment Summary view 54 Hub Transport Role Environment Summary view 54 Mailbox Role Environment Summary view 55 Unified Messaging Role Environment Summary view 56 Exchange Roles Explorer Summary (All Roles) view 57 Client Access Role Explorer Summary view 58 Edge Transport Role Explorer Summary view 59 Hub Transport Role Explorer Summary view 60 Mailbox Role Explorer Summary view 61 Unified Messaging Role Explorer Summary view 62 Exchange Server views 63 Exchange Servers Environment Summary (All Exchange Servers) view 64 Exchange Server Environment Summary view 64 Exchange Servers Explorer Summary (All Exchange Servers) view 66 Exchange Server Explorer Summary view 67 Resource Utilization Details view 69 Exchange Server Roles view 70 Exchange Server AD Health view 71 Exchange Server Managed Availability view 72 Site views 73 Exchange Sites Environment Summary (All Sites) view 74 Exchange Site Environment Summary view 74 Exchange Sites Explorer Summary (All Sites) view 75 Exchange Site Explorer Summary view 76 Cluster views 78 Exchange Cluster Environment Summary view 78 Exchange Clusters Explorer Summary (All Clusters) view 80 Exchange Cluster Explorer Summary view 80 Description of Embedded views 82 Agent State view 84 Alarms view 84 Auto Attendant Calls view 85 Auto Attendant Directory Access view 85 Auto Attendant General view 86 Auto Attendant Transfers view 86 Cached LDAP Searches/sec view 87 CAS AB Load view 87 CAS AB Service view 88 CAS ActiveSync view 88 CAS Control Panel Load view 89 CAS Load view 90 CAS OAB Download view 91 CAS RPC Client Access view 91 CAS RPC Client Access Load view 92 CAS RPC HTTP view 92 Foglight for Exchange 5.7.2 User and Reference Guide 5 Contents Client Access Features view 93 Cluster Database Details view 94 Cluster Storage Group Details view 96 Cluster Summary and Resource Information view 97 Cluster Summary view 98 Clusters Listing view 100 CPU view 100 Disk view 101 Domain Controllers view 102 Edge Agent view 102 Edge Transport Features view 103 Exchange Roles Server Summary view 105 Exchange Server Roles view (reference information) 108 Exchange Servers in This Cluster view 118 Exchange Servers view (Exchange Cluster Environment Summary) 119 Exchange Servers view 119 Host Monitor view 120 Hub Transport Features view 120 IP Address view 122 Mailbox Features view 122 Mailbox Store Assistant view 125 Managed Availability Recovery Action Results view 126 Memory view 126 Network view 127 Processes LDAP Read Time view 127 Resource Utilization view 128 Roles Listing view 129 Roles Explorer view 129 Role Features State view 131 Roles Top 3 view 132 Server Health view 134 Server Listing view 134 Servers in Site view 134 Servers In This Site view 135 Site By Category view 135 Site Listing view 136 Store Calendar Attendant view 136 Store Client Search view 137 Store Content Indexing view 137 Store Database view 138 Store Public Load view 138 Store Resource Booking view 138 Store RPC Client Throttling view 139 Store Transport view 139 Store User Load view 140 Summary and Resource Information view 140 Top 3 CPU Consumers view 140 Top 3 Memory Consumers view 141 Transport Dumpster view 142 Transport Edge Sync view 142 Transport Extensibility Agent view 143 Transport Load Store Drivers view 143 Transport Queues view 144 UM Availability view 144 UM Call Answer General view 145 UM Call Answer view 146 UM Fax view 147 UM General Current view 148 UM General view 149 UM Subscriber Access Calendar view 151 UM Subscriber Access Directory view 151 UM Subscriber Access General view 152 UM Subscriber Access Message view 153 Unified Messaging Features view 154 Windows Services view 155 Foglight for Exchange rules 156 Rules dashboard 156 Exchange Rule Management dashboard 157 Managing Foglight for Exchange rules 159 Rules reference 160 Running diagnostic tests 161 Diagnostic Tests dashboard 161 Tasks list 161 About Diagnostic Test Types pane 164 Diagnostic Tests list 164 Diagnostic Tests reference 166 Internal Mailbox 166 Remote Forest Mailbox 166 Replication Health 167 Troubleshooting 168 Configuring the agent to log on as a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 service 168 Managing Exchange metrics 170 Agent 14 Status and Agent — Get agent by agent ID 15 Properties dashboards 170 Exchange Metrics Management dashboard 171 Managing Exchange metrics 173 Using the Metrics Management dashboard 173 Using the Agent — Get all active agents 15 Status and Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Properties dashboards 175 About Us We are more than just a name 45 Our brand176 Navigation basics‌ This guide has been prepared to assist you in becoming familiar with Foglight for Exchange. It provides basic navigation techniques, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The describes the dashboards, views and reports included with Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POSTfor Exchange, and DELETE dataprovides information about the rules that are available for your monitored system. This section describes the basic techniques used to navigate through Foglight for Exchange. It is intended to introduce you to the layout of the Foglight user interface and how to navigate through the dashboards and views provided with Foglight for Exchange: • Foglight browser interface panels • Drill down actions • Breadcrumb trail • Time range • Lists • Alarms and state indicators • Mouse-over actions • Foglight for Exchange roles For more information about Foglight navigation, see the Foglight User Guide or online help. Foglight browser interface panels‌ Depending on who you log in as, you may see either the contents of the first bookmark (the Welcome page is the default) listed under Bookmarks, or a home page. For further details about these Foglight pages, see the Foglight User Guide or online help. Typically the browser interface is divided into three panels: • Navigation panel • Display panel • Action panel Navigation panel‌ The navigation panel, at the left of the browser interface, operates like a drawer and is open by default. To close the navigation panel, click the arrow to the far left of the Foglight browser interface. Click the arrow again to open the navigation panel. The navigation panel contains an expandable view of all the dashboards available to the current user. To access a specific dashboard, open the appropriate module (for example, Exchange) and select the dashboard to view it in the display panel. The navigation panel also provides access to the Foglight REST API Reference Guide is intended Administration and Configuration areas, and may provide access to some cartridge-specific navigational views (for users who example, the Exchange Infrastructure view for the Exchange Explorer dashboard.) If you do not see any dashboards in the navigation panel, the user ID with which you signed in may not have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIsa group. For more informationdetails, see the Foglight User Guide or online help. Display panel‌ The display panel is the large panel in the middle of the browser interface and is used to view current dashboards and reports, as well as to create new dashboards and reports. You can increase the size of the display panel by resizing the navigation panel, or if open, by closing the action panel. Action panel‌ The action panel, at the right of the browser interface, operates like a drawer and is closed by default. To open the action panel, click the arrow to the far right of the Foglight browser interface. Click the arrow again to close the action panel. The action panel lists the actions and tasks you can perform within the currently displayed dashboard. It also contains the views and data that you can add to a dashboard or report, and provides access to the online help files. Use the graphical and text links in views to drill down to additional details that may assist you in diagnosing problems. Depending on the link, you drill down to a different dashboard or smaller view called a popup that appears over the dashboard you are currently viewing.‌ You can drill down from many different parts of a view, including names of monitored components (such as Exchange servers or Exchange roles), the view in Explorer links in a dashboard, and items like charts, tables, cylinders and icons. NOTE: When your cursor is positioned over a drillable component, the cursor will change to a selector icon, typically a hand with a pointing finger. For example, in the Exchange Alarms dashboard, click on a server name. This displays a dialog allowing you to select either the Explorer or the Quick View. Select the Quick View link to display the selected server’s summary information on the Exchange Environment dashboard. Breadcrumb trail‌ As you drill down into more detailed views within a dashboard, the names of the previous views are displayed in a breadcrumb trail at the top of the current dashboard. In addition to providing you with context, this breadcrumb trail displays the name of the current view and provides a simple mechanism for returning to any of its parent levels. The following topics: • Glossary • Prerequisites • Overviewbreadcrumb trail was created while drilling down from the Exchange Environment dashboard into the Rule Management dashboard. Each item within the breadcrumb trail is a link to a previously viewed parent level.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Guide Updated - November 2018 August 2017 Software Version - 5.9.x 5.9.1 Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 9 APP — Get App information 9 Security 10 Security 11 Security — Login 11 10 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview11

Trademarks. Quest, the Quest logo, and Join the Innovation Where next meets now are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference for Citrix XenDesktop and XenApp User Guide Updated - November 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • OverviewApril 2022

Trademarks. Quest, the Quest logo, and Join the Innovation Where next meets now are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Creating Actions Field Guide Updated - November 2018 Software April 2022 Foglight Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview6.1.0

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Getting Started Guide Updated - November 2018 May 2017 Software Version - 5.9.x Getting Started Glossary 5.7.5.8 Components 5 Foglight Management Server 5 Foglight browser interface 6 Prerequisites Customizable dashboards 6 Foglight command-line interface 6 Foglight Agent Manager 7 Foglight cartridges 7 Foglight agents 7 Foglight architecture overview 8 Installation and Setup Overview 7 REST APIs App 10 APP — Get App information Part 1: Installing the Management Server 10 Security Part 2: Starting Foglight and logging in 11 Security — Login Part 3: Installing cartridges 11 Security — Logout Part 4: Installing and running the Agent Manager 12 Security — Set Auth Token Part 5: Deploying and creating agents 13 Starting Points 15 Before you get started 15 Insufficient roles 15 Working in a current or a diagnostic time range 16 Foglight for a given user 12 Security — Delete Auth Token Virtualization Environment Overview 17 Foglight for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms Storage Management Environment Overview 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data Foglight Operator’s Welcome page 24 Cartridge — Get all non-core cartridges’ data 24 Registry Foglight Administrator’s Welcome page 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule Service Operations Console 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API Hosts dashboard 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Next steps 29 About Us 30 We are more than just a name 45 30 Our brand, our vision. Together 45 30 Contacting Quest 45 30 Technical support resources 45 Getting Started‌ The Foglight REST API is an 30 Components‌ Quest Software Inc.’s Foglight™ solution simplifies application programming interface (API) that uses HTTP requests performance monitoring and reduces the skills and effort required to GETmanage applications, PUT, POSTthe user experience, and DELETE the supporting infrastructure. Unlike other solutions, Foglight uses a single code base, and has a model-driven design that couples fast deployment and accelerated time-to-value. It offers the modular flexibility required to deliver a range of capabilities and sophistication to meet the needs of any organization, from those still focused on technology-centric monitoring to those that have completed the transition to application-centric or transactional monitoring. Foglight performs equally well in physical, virtual, and mixed infrastructure environments, providing visibility into issues affecting the application and end-user experience. Intuitive workflows help you quickly move from the symptom to the root cause in the application, database, infrastructure, or network to resolve issues, reducing mean time to resolution. Predefined and drag-and-drop dashboards provide insight that is tailored to each stakeholder. By offering comprehensive visibility into your monitored environment, Foglight helps ensure that cross-functional teams collaborate on and prioritize issues that matter most to the business. Foglight comprises several different components, which are described individually. You will be installing and using these components as you perform the steps in the installation and setup process and get started using Foglight. • Foglight Management Server • Foglight browser interface • Foglight command-line interface • Foglight Agent Manager • Foglight cartridges • Foglight agents • Foglight architecture overview Foglight Management Server‌ Foglight Management Server is the central component of Foglight. The Management Server receives information from agents, stores and processes data, and makes it available in the browser interface. The Foglight REST API Reference Guide is intended database stores all system, application, and performance data. Over time, it becomes an invaluable source of historical information for users who have been assigned planning future system capacity requirements and for doing point-in-time analysis. Foglight browser interface‌ Foglight has a browser interface that displays data collected from your monitored environment. It allows you to view this data in various formats and levels of detail. The browser interface consists of three areas: • A navigation panel that: ▪ Lists all of the API Access and dashboards that are available to the Administrator roles and who need programmatic current user. ▪ Provides access to easily create professional services the Administration home page, which presents a summary of information about Foglight from an administrative perspective and better integrate with third-party systems. This section introduces allows you to navigate to the Foglight REST APIspages where you perform administrative tasks. For more information, see • A display area in which you can view and create dashboards and reports. • An action panel that: ▪ Lists the following topics: • Glossary • Prerequisites • Overviewvarious actions that you can perform on the dashboard that is currently displayed. ▪ Contains views and data that can be added to a dashboard or report that you are creating. ▪ Provides access to the online help.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference User Guide Updated - November 2018 December 2017 Software Version - 5.9.x 5.9.2 Getting Started Glossary with Foglight 6 Prerequisites Getting Started 6 Overview Logging in to Foglight 6 Starting from the Welcome Page 7 REST APIs App Navigating Foglight 8 Using the Navigation Panel 8 Using the Breadcrumb Trail 9 Using Drilldowns 9 Using Bookmarks 9 Opening a New Window 10 APP — Get App Running a Report 10 Choosing a Home Page 10 Getting Started FAQ 11 Working with Dashboards 11 Viewing, Acknowledging, and Clearing Alarms 46 Viewing Alarms 47 Filtering the Alarm List 47 Viewing Alarm Details 48 Acknowledging an Alarm 50 Clearing an Alarm 51 Monitoring Your Domains 52 Viewing detailed information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for domain or subdomain 52 Investigating Problems in a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current Domain 53 Investigating a Domain or Xxxxxxxxx’s State 53 Investigating a Subdomain’s Health 53 Investigating a Xxxxxxxxx’s Alarms 54 Investigating Problems with a Subdomain’s Agents 54 Monitoring Your Services 55 Selecting the Services You Want to Monitor 56 Service Dependencies 56 Monitoring a Service 57 Investigating service level compliance and availability 57 Investigating alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances 58 Drilling down into a service 58 Viewing the state of and drilling down into a type 43 User Information 44 User Information — Get current user information 44 About Us We are tier 58 Viewing more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional details about your services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview59

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Getting Started Guide Updated - November May 2018 Software Version - 5.9.x Getting Started Glossary Components 5 Foglight Management Server 5 Foglight browser interface 6 Prerequisites Customizable dashboards 6 Foglight command-line interface 6 Foglight Agent Manager 7 Foglight cartridges 7 Foglight agents 7 Foglight architecture overview 8 Installation and Setup Overview 7 REST APIs App 10 APP — Get App information Part 1: Installing the Management Server 10 Security Part 2: Starting Foglight and logging in 11 Security — Login Part 3: Installing cartridges 11 Security — Logout Part 4: Installing and running the Agent Manager 12 Security — Set Auth Token Part 5: Deploying and creating agents 13 Starting Points 15 Before you get started 15 Insufficient roles 15 Working in a current or a diagnostic time range 16 Foglight for a given user 12 Security — Delete Auth Token Virtualization Environment Overview 17 Foglight for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms Storage Management Environment Overview 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data Foglight Operator’s Welcome page 24 Cartridge — Get all non-core cartridges’ data 24 Registry Foglight Administrator’s Welcome page 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule Service Operations Console 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API Hosts dashboard 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Next steps 29 About Us 30 We are more than just a name 45 30 Our brand, our vision. Together 45 30 Contacting Quest 45 30 Technical support resources 45 Getting Started‌ The Foglight REST API is an 30 Components‌ Quest Software Inc.’s Foglight® solution simplifies application programming interface (API) that uses HTTP requests performance monitoring and reduces the skills and effort required to GETmanage applications, PUT, POSTthe user experience, and DELETE the supporting infrastructure. Unlike other solutions, Foglight uses a single code base, and has a model-driven design that couples fast deployment and accelerated time-to-value. It offers the modular flexibility required to deliver a range of capabilities and sophistication to meet the needs of any organization, from those still focused on technology-centric monitoring to those that have completed the transition to application-centric or transactional monitoring. Foglight performs equally well in physical, virtual, and mixed infrastructure environments, providing visibility into issues affecting the application and end-user experience. Intuitive workflows help you quickly move from the symptom to the root cause in the application, database, infrastructure, or network to resolve issues, reducing mean time to resolution. Predefined and drag-and-drop dashboards provide insight that is tailored to each stakeholder. By offering comprehensive visibility into your monitored environment, Foglight helps ensure that cross-functional teams collaborate on and prioritize issues that matter most to the business. Foglight comprises several different components, which are described individually. You will be installing and using these components as you perform the steps in the installation and setup process and get started using Foglight. • Foglight Management Server • Foglight browser interface • Foglight command-line interface • Foglight Agent Manager • Foglight cartridges • Foglight agents • Foglight architecture overview Foglight Management Server‌ Foglight Management Server is the central component of Foglight. The Management Server receives information from agents, stores and processes data, and makes it available in the browser interface. The Foglight REST API Reference Guide is intended database stores all system, application, and performance data. Over time, it becomes an invaluable source of historical information for users who have been assigned planning future system capacity requirements and for doing point-in-time analysis. Foglight browser interface‌ Foglight has a browser interface that displays data collected from your monitored environment. It allows you to view this data in various formats and levels of detail. The browser interface consists of three areas: • A navigation panel that: ▪ Lists all of the API Access and dashboards that are available to the Administrator roles and who need programmatic current user. ▪ Provides access to easily create professional services the Administration home page, which presents a summary of information about Foglight from an administrative perspective and better integrate with third-party systems. This section introduces allows you to navigate to the Foglight REST APIspages where you perform administrative tasks. For more information, see • A display area in which you can view and create dashboards and reports. • An action panel that: ▪ Lists the following topics: • Glossary • Prerequisites • Overviewvarious actions that you can perform on the dashboard that is currently displayed. ▪ Contains views and data that can be added to a dashboard or report that you are creating. ▪ Provides access to the online help.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Data Model Guide Updated - November May 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App The Foglight data model 8 What are models? 8 Who needs to know about models? 9 Modeling process overview 9 Where can I see the models? 10 APP — Get App information 10 Security Topology type definitions in XML 11 Security — Login Schema browser 11 Security — Logout Data dashboard 11 How are models organized? 12 Security — Set Auth Token for Where can I see the data model hierarchy? 12 What internal models are created? 13 What other models are created? 13 What is in “Model Roots”? 13 How are Foglight 4 agents represented? 13 Why might I need to navigate models? 14 How do I create a given user 12 Security — Delete Auth Token for model? 14 How do I delete a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user model? 14 Agent What are domains? 14 Agent — Get agent by agent ID Example: the Host Model structure 15 Agent — Get all active agents 15 Agent — Get all agents What is a data source? 16 Agent — Get all inactive agents 16 Alarm What are “KnowledgeItems”? 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms Data modeling tutorials 19 Alarm — Get history alarms Modeling example: The org chart 19 Alarm — Get topology object current alarms Defining the org structure types 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ Populating the model using a script 27 Connecting “Employees” to Host objects 29 Visualizing the data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named 29 Appendix: Groovy scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id createOrg Groovy script 30 Appendix: Internal database schema 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType acl_class Table 39 acl_entry Table 39 acl_object_identity Table 39 acl_sid Table 40 agent_client_defaults Table 40 agent_config_binder Table 40 agent_dc_manager_schedule_ids Table 40 agent_dc_manager_state Table 41 agent_manager_state Table 41 alarm_alarm Table 42 TopologyType — Get type information alarm_annotations Table 42 TopologyType — Get type super type’s information auditing_log Table 43 TopologyType — Get all instances of a type baseline_config Table 43 User Information baseline_config_properties Table 44 User Information — Get current user information baseline_engine_profile Table 44 baseline_observation_profile Table 44 cartridge_cartridge_relation Table 45 cartridge_components Table 45 cartridge_installed_cartridges Table 46 cartridge_items Table 46 credential_data Table 47 credential_lockbox Table 47 credential_mapping Table 48 credential_mapping_entry Table 48 credential_order Table 48 credential_policy Table 49 current_version Table 49 database_instance_id Table 49 database_version Table 50 derivation_calculation Table 50 derivation_complex_definition Table 50 derivation_definition Table 51 fgl4_migration_agent Table 51 fgl4_migration_data_span Table 51 fgl4_migration_dcm Table 51 fgl4_migration_host Table 51 fgl4_migration_host_mapping Table 51 fgl4_migration_log Table 52 fgl4_migration_server Table 52 incident_affected_objects Table 52 incident_incident Table 52 incident_linked_alarms Table 53 incident_problem_ticket Table 53 incident_problem_tickets Table 53 licensing_licenses Table 53 mgmt_object_size Table 54 mgmt_observation_size Table 54 mgmt_timeslice Table 55 mgmt_timeslice_data_avail Table 55 model_association Table 56 model_property_formula Table 56 model_query_criteria Table 56 obs_binary_* Tables 57 obs_metric_aggregate_* Tables 57 obs_metric_scalar_* Tables 58 obs_string_* Tables 58 pcm_encoded_data Table 59 persistable_config_model Table 59 persistable_script Table 60 persistence_column_mapping Table 60 persistence_db_column Table 61 persistence_db_schema Table 61 persistence_db_table Table 61 persistence_grouping_policy Table 62 persistence_lifecycle Table 62 persistence_lifecycle_period Table 63 persistence_obs_key_purge_age Table 63 persistence_obs_purge Table 63 persistence_obs_purge_age Table 64 persistence_observation_index Table 64 persistence_operation Table 64 persistence_retention_policy Table 65 persistence_rollup_progress Table 65 persistence_rollup_retry Table 66 persistence_storage_config_xml Table 66 persistence_storage_manager Table 66 persistence_timeslice_table Table 67 persistence_topobj_purge_age Table 67 persistence_type_hierarchy Table 67 registry_performance_calendar Table 68 registry_registry_value Table 68 registry_registry_variable Table 68 report_output Table 69 report_schedule Table 69 rule_action_handler Table 70 rule_action_message Table 70 rule_action_registry_reference Table 71 rule_action_variable_reference Table 71 rule_blackout_schedules Table 71 rule_effective_schedules Table 71 rule_expression Table 72 rule_firing_strategy Table 72 rule_messages Table 72 rule_rule Table 72 rule_sev_to_clear_actn_hndlr Table 73 rule_sev_to_fire_actn_hndlr Table 74 rule_severity Table 74 rule_severity_expression Table 74 rule_severity_messages Table 75 schedule_named_schedule Table 75 script_annt Table 75 script_annt_attr Table 76 script_argument Table 76 script_argument_annt Table 76 script_argument_annt_attr Table 77 script_example Table 77 script_return_annt_attr Table 78 sec_group Table 78 sec_group_nesting Table 78 sec_group_role_match Table 78 sec_grouprole Table 78 sec_jaas_source Table 79 sec_object Table 79 sec_object_mask Table 80 sec_object_permission Table 80 sec_object_type Table 80 sec_permission Table 81 sec_permission_def Table 81 sec_policy Table 81 sec_resource Table 82 sec_role Table 82 sec_user_alias Table 82 sec_user_obj_permission Table 82 sec_user_res_permission Table 83 sec_usergroup Table 83 sec_userrole Table 83 sec_x_attribute Table 84 sec_x_attribute_value Table 84 tagging_service_mapping Table 84 threshold_bound Table 84 threshold_config Table 85 topology_activity_calendar Table 85 topology_activity_upgrade Table 86 topology_object Table 86 topology_object_history Table 87 topology_property Table 87 topology_property_annotation Table 87 topology_property_history Table 88 topology_property_name Table 88 topology_property_value Table 88 topology_service_state Table 89 topology_type Table 89 topology_type_annotation Table 89 topology_type_history Table 90 upgrade_pending_operations Table 90 wcf_groups_by_cartridges Table 90 wcf_resources Table 91 About Us 92 We are more than just a name 45 92 Our brand, our vision. Together 45 92 Contacting Quest 45 92 Technical support resources 45 Getting Started‌ 92 The Foglight REST API data model‌ This topic provides an introduction to models and discusses the Foglight data model. • What are models? • Who needs to know about models? • Where can I see the models? • How are models organized? • What are domains? • What is an application programming interface (API) a data source? • What are “KnowledgeItems”? What are models?‌ In general, models are abstractions that uses HTTP requests capture the essence of the objects they are supposed to GETrepresent. A good model looks and behaves like the real thing, PUTat least in certain ways. If a model were perfect in every respect, POSTit would be indistinguishable from the real thing. Thus, we could pose questions, submit these in some way to the model, and DELETE dataobtain the same, or almost the same, results as we would by doing those things to the real object. If the object under consideration undergoes a change, the model would have to change accordingly in order to faithfully represent that object. The Foglight REST API Reference Guide data model used in the Management Server is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access constructed to easily create professional services and better integrate with third-party systemsdo just that. This section introduces you The data sent to the Foglight REST APIsManagement Server changes with time, not only because the measurements on properties change, but because the objects themselves may come and go. For more informationSo, see a data model for use with the following topics: Management Server must be designed to accommodate the creation of objects, by placing them in a well-designed model hierarchy. Objects have relationships among themselves, and a good model accounts for those relationships. To the Management Server, models are collections of related data objects. The totality of data objects in existence at any one time is referred to as the “data model”. • Glossary Objects are created by transforming the raw data collected by agents (collection models) or when services are created, deleted, or modified (service models). • Prerequisites • OverviewObjects have properties, such as lists and metrics (time series values). Properties may be simple values, but often they are other objects. Being objects, they can have properties that are objects, and these objects may have the starting object as a property. Thus, the relationships form a graph, not a tree.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Guide Web Component Tutorial Updated - November 2018 March 2017 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 5.7.5.8 Using the Web Component Tutorial 7 REST APIs App Browser Interface Views 7 Why Configure the Default Views? 7 What is the Web Component Framework? 8 Simple Dashboard Creation 10 APP — Get App information How to Use this Tutorial 10 Security 11 Security — Login 11 Security — Logout Tutorial 1: Drag and Drop 12 Security — Set Auth Token Creating a Custom Dashboard by Drag and Drop 12 Customizing Dashboards 17 Add View 17 Add Text 18 Edit Page Layout 21 Tutorial 2: Creating a Dashboard 31 Constructing the Tutorial Module 32 Configuring a Query 33 Configuring a Row-Oriented Table 35 Configuring Table Columns 36 Building the Dashboard 37 Adding the Table to the Dashboard 39 Summary 40 Tutorial 3: Adding a Drilldown Page 42 Preliminary Setup 42 Adding a Column of Aggregate Alarms to the Table 43 Adding a Dependent Page 45 Adding a Context-Sensitive Dependent Page for the Table of Hosts 46 Summary 49 Tutorial 4: Adding Views 52 Designing the Page 53 Preliminary Setup 53 Defining the Alarms Query 54 Configuring a Table of Alarms 55 Configuring a Chart Component 59 Configuring a Label with an Action 61 Configuring the Drilldown Page 63 Configuring a Drop-Down List 64 Flowing Monitored Hosts to Host Details T3 66 Adding a Customizer 66 Adding Nested Views 67 Summary 68 Tutorial 6: Reports 80 Configuring a Query 81 Creating a Basic Report Page 81 Creating a More Elaborate Hosts Table 84 Adding a Header 89 Adding a Footer 90 Adding an Iterator for a given user 12 Security — Delete Auth Token Multi-Page Report 92 Choosing the Iterated View 93 Summary 93 Tutorial 7: Creating a Form 97 About this Tutorial 97 Defining the Enumerated Types for Manager and Staff 100 Defining the Manager and Staff Types 101 Defining the Company Type 102 Defining the Functions for Adding and Removing a given user 13 Security — Set Auth Token Manager 103 Defining the Labels 104 Defining the Bean Input Components 104 Defining the Grid Layout 106 Defining the Dialog 108 Defining the Table of Managers 109 Defining the Top-Level Dashboard 112 Summary 113 Tutorial 8: Renderers 116 Text Renderer 118 Date Renderer 119 Number Bar Renderer and Number Unit Renderer 120 Configuring the Labels 121 Tutorial 9: Adding Questions and Answers 123 Working with Associations and Question Viewers 123 Building Associations for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all nonYour Question Viewer 125 Creating a Domain 126 Creating Categories 127 Creating Questions 127 Populating the Question Viewer with Questions and Answers 129 Building a Mini-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Viewer 133 Summary 135 Tutorial 10: Sending Messages to Other Users 136 Creating Message Associations 136 Creating Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Functions 137 About Us 143 We are more than just a name 45 143 Our brand, our vision. Together 45 143 Contacting Quest 45 143 Technical support resources 45 Getting Started‌ The Foglight REST API is an 143 Using the Web Component Tutorial‌ With Foglight™, application programming interface (API) that uses HTTP requests to GETand IT managers can understand end-user service levels for their critical business applications, PUT, POSTnotify stakeholders when those service levels are violated, and DELETE dataassign problem resolution tasks to the appropriate domain expert. In addition to Foglight's core performance management capabilities, Foglight offers specialized monitoring for all application tiers including: End-User Response, Application, Web Servers, Application Servers, Databases, and Operating Systems. That is a lot of capability, and the volume of data being collected can be overwhelming. The Foglight REST API Reference Guide views in the browser interface attempt to organize the data into meaningful summaries, with drilldowns to increasingly specific information about a chosen component, such as a single host or a particular database instance. It is intended for users who have been assigned likely that you organize the API Access top-level screens around the concept of services, and choose them to show a view that should be useful to a broad range of users—those with typical environments. In all likelihood your environment is not quite typical, and as you gain familiarity with the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces browser interface, you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overviewwill imagine ways that they could be improved.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API for Active Directory User and Reference Guide Updated - November 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • OverviewApril 2022

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API for Active Directory User and Reference Guide Updated - November 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • OverviewDecember 2017

Trademarks. Quest, the Quest logo, and Join the Innovation Where next meets now are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Creating Actions Field Guide Updated - November 2018 Software April 2023 Foglight Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview6.3.0

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Infrastructure Utilities User and Reference Guide Updated - November 2018 Software May 2021 Foglight Version - 6.0.0 Foglight Web Monitor Version 5.9.x Getting Started Glossary Foglight Net Monitor Version 5.9.x Introduction to this guide 6 Prerequisites 6 Overview Monitoring Web transactions 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout Configuring credentials for Web sites requiring user or proxy authentication 7 Configuring credentials to access Web sites requiring user authentication 9 Configuring credentials for accessing Web sites through proxy servers 12 Security — Set Auth Token Monitoring HTTPs URLs in FIPS-compliant mode 16 Monitoring URLs that require a client certificate 16 Exploring your collection of monitored Web sites 17 Expanding your collection of monitored sites 18 Removing Web sites from the existing collection 21 Moving multiple transactions as a group 21 Removing stale transactions from the Performance Browser dashboard 22 Viewing and editing individual Web transaction details 23 Investigating the performance of Web transactions and monitoring locations 26 Exploring the FAQts tab 27 Drilling down on transactions 27 Drilling down on locations via the Locations tab 29 Exploring Web Monitor services 30 Generating reports 33 Configuring Web Monitor agent properties 34 Settings 34 Data Collection Scheduler 35 View reference 36 Web Monitor Performance Browser views 36 Web Monitor Transaction Management views 59 Web Monitor Service Operation Console and Foglight for a given user 12 Security — Delete Auth Token APM Transactions views 63 Monitoring network devices 67 Configuring the ICMP service for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 monitoring 67 Configuring the Agent 14 Agent — Get Manager ICMP service 68 Configuring OS-Level ICMP services 69 Managing monitored network devices 69 Expanding your collection of monitored network devices 71 Removing network devices from the existing collection 74 Viewing and editing individual network device details 74 Investigating the performance of network devices 77 Exploring individual network devices 78 Tracing data packets between monitoring locations and network devices 79 Exploring the FAQ tab 80 Generating reports 81 Configuring the agent by properties 81 Configuring Net Monitor agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 82 View reference 84 Net Monitor Performance Browser views 86 About Us 104 We are more than just a name 45 104 Our brand, our vision. Together 45 104 Contacting Quest 45 104 Technical support resources 45 Getting Started‌ The 104 Introduction to this guide‌ Welcome to the Infrastructure Utilities User and Reference Guide. This User and Reference Guide provides agent configuration instructions and information on investigating the performance of monitored Web sites and monitored network devices. It describes the dashboards included with Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POSTWeb Monitor and Foglight Net Monitor, and DELETE datacontains instructions for configuring monitoring agents that collect information from monitored systems. The Foglight REST API Reference Guide This guide is intended for users any user who have been assigned wants to know more about the API Access monitoring agent properties and the Administrator roles and who need programmatic access dashboards included with these utilities. It is also meant for those users that want to easily create professional services and better integrate learn about the rules that are included with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • OverviewInfrastructure utilities.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Upgrade Guide Updated - November January 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 5.9.2 Understand product versions 7 REST APIs App Components compatibility 7 Compatible cartridges list 7 Foglight cartridge upgrade issues 9 Foglight appliance upgrade issues 9 Best practices 10 APP Foglight Management Server 11 Foglight Agent Manager 11 Embedded Agent Manager 11 Agent Manager client installation cartridges 11 Client-side Agent Managers 11 Application Monitoring cartridges 12 Application Performance Monitoring cartridges 12 Application Management cartridges 13 Database cartridges 14 Foglight for DB2 LUW 14 Foglight for Oracle 14 Foglight for SQL Server 14 Foglight for Sybase 15 End User Management cartridges 15 End User cartridges 15 Infrastructure Management cartridges 15 Foglight for Infrastructure 16 Foglight for Active Directory 16 Foglight for Apache 16 Foglight for Exchange 16 Foglight Net Monitor 16 Foglight for PowerVM 17 Foglight for SNMP 17 Foglight Web Monitor 17 Integration cartridges 17 Foglight for Integration 17 Foglight for NMS Integration 17 Virtualization cartridges 18 Foglight Experience Monitor appliance 18 Foglight Experience Viewer appliance 18 Upgrade use cases 18 Scenario 1 — Get App information 10 Security 11 Security New release 19 Scenario 2 — Login 11 Security New Management Server features or defect fixes 19 Scenario 3 — Logout 12 Security — Set Auth Token Agent Manager client-side feature dependency or defect fix 19 Dependency and compatibility matrices 19 Prepare for an upgrade 24 Migrate to Windows SSO from VSJ SSO 26 Upgrade the Management Server 27 Host services compatibility 30 Start the embedded Agent Manager 30 Upgrade a given user 12 Security — Delete Auth Token Management Server in a federated environment 30 Upgrade the Management Server in a High Availability (HA) environment 31 Upgrade the Management Server with an Oracle RAC database 31 Oracle database users 32 Database changes 32 Upgrade the Foglight Agent Manager 34 Upgrade the Agent Manager 34 Upgrade concentrators 35 Upgrade installations with multiple state instances 35 Upgrade a 32-bit FglAM installation on a 64-bit operating system 36 Agent Manager upgrade issues 36 FglAM vm.config file migration fails under multi-state installations 36 Upgrade from an Agent Manager version earlier than 5.5.4 37 Certificate migration from version 5.6.2.1 or earlier 37 Upgrade the Application Monitoring cartridges 39 Upgrade the Application Performance Monitoring cartridges 39 Upgrade Foglight for Application Operations 39 Upgrade Foglight for Java EE Technologies 40 Upgrade Foglight for JMX 42 Upgrade Foglight for Microsoft .NET 42 Upgrade the Application Management cartridges 44 Upgrade Foglight for IBM WebSphere MQ Server 44 Upgrade Foglight for PeopleSoft 45 Upgrade Foglight for Siebel 47 Upgrade Foglight PagerDuty Integration 47 Upgrade the Database cartridges 49 Upgrade the Cartridge for DB2 LUW 49 Upgrade Foglight for DB2 LUW 49 Upgrade Foglight for Oracle 50 Upgrade Foglight for SQL Server 50 Upgrade Foglight for Sybase 51 Upgrade the End User Management cartridges 53 Upgrade End User cartridges 53 Upgrade the End User cartridges 53 Using the Agent Manager with FTR agents 56 Upgrade Foglight for Hyper-V 65 Upgrade Foglight Net Monitor 66 Upgrade Foglight Integration for OpenManage Essentials 66 Upgrade Foglight for OpenStack 66 Upgrade Foglight for PowerVM 67 Upgrade Foglight Resource Optimizer 68 Upgrade Foglight for SNMP 70 Upgrading Foglight for Storage Management cartridge 71 Upgrade Foglight for vCloud Director 72 Upgrade Foglight Web Monitor 72 Upgrade Foglight for VMware 73 Upgrade Foglight for VMware Horizon View 74 Upgrade Foglight for Citrix XenDesktop and XenApp 75 Upgrade the Integration cartridges 77 Upgrade Foglight for Integration 77 Upgrade Foglight for NMS Integration 77 Upgrade the cartridges in a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 federated or High Availability (HA) environment 78 Upgrade cartridges in a federated environment 78 Upgrade cartridges in a High Availability environment 79 Appendix: Deploying an agent package using the browser interface 80 Deploying an agent package through the Agent 14 Managers dashboard 80 Deploying an agent package through the Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Status dashboard 81 About Us 82 We are more than just a name 45 82 Our brand, our vision. Together 45 82 Contacting Quest 45 82 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview82 Understand product versions‌

Trademarks. Quest, the Quest logo, and Join the Innovation Where next meets now are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API for VMware User and Reference Guide Updated - November 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • OverviewApril 2022

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference for Capacity Management User Guide Updated - November 2018 Software April 2017 Foglight Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 5.7.5.8 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • OverviewVersion - 5.6.15.4

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API for Apache User and Reference Guide Updated - November 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • OverviewApril 2022

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Guide Updated - November June 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Web Component Guide Updated - November 2018 March 2017 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances 5.7.5.8 Introducing the Web Component Framework 8 Configuring Views 8 Browser Interface Views 9 The Browser Interface 9 Anatomy of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brandTypical Dashboard 10 The Web Component Framework (WCF) 10 The Design Tab 11 The Web Component Framework 13 Core Concepts 13 Modules 13 Observations 16 Context 19 Parameters in Bindings 19 On Null Values 20 Renderers 20 Default Values 20 Data Sources, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POSTData Types, and DELETE data. Data Objects 20 Paths 21 Properties 21 Using the Web Component Framework 21 The Foglight REST API Reference Guide is intended for users who have been assigned Web Component Framework Editor 21 An Example Page 22 Managing Dashboards 23 Definitions Panes 23 Data and Data Sources Pages 24 Definitions Pane 24 Customizing the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topicsUI Quickly 25 Finding Pages: • Glossary • Prerequisites • OverviewBookmarks 25 Additional Documentation 25

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference for Office 365 User Guide Updated - November 2018 May 2017 Foglight Version - 5.7.5.8 Software Version - 5.9.x 5.7.1 Getting Started Glossary started with Foglight for Office 365 5 Installation requirements 5 Data collection 5 Dashboard location 6 Prerequisites 6 Overview Administering monitoring agents and collected data 7 REST Accessing the Administration tab 7 Agents management table 8 Agents management toolbar 9 Deploy the Foglight for Office 365 agent package 9 Managing Foglight for Office 365 agents 10 Add and configure Foglight for Office 365 agents 10 Activate, deactivate, and delete agents 12 Start and stop data collection 13 Configure domain credentials 13 Set up permissions to use the Office 365 APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token 13 Configuring Foglight for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user Office 365 agent properties 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active Managing ADFS agents 15 Agent — Get all Add and configure ADFS agents 16 Agent — Get all inactive Edit ADFS agents 16 Alarm properties 17 Alarm — Acknowledge alarm by alarm ID Configuring ADFS agent properties 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms Monitoring your environment 20 Alarm — Get topology object history alarms Accessing the Monitoring tab 20 Alarm — Push alarms Foglight for Office 365 Environment Overview 20 Foglight for Office 365 Environment Quick View 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data Foglight for Office 365 views 24 Cartridge — Get all non-core cartridges’ data Exchange Online views 24 Registry Environment Summary - Exchange Online (All Objects) view 24 Environment Summary - Exchange Online (Selected Object) view 25 Registry — Get all registries’ data Explorer Summary - Exchange Online (Selected Object) view 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id ADFS views 27 Script Environment Summary - ADFS (All Objects) view 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Environment Summary - ADFS (Selected Object) view 27 About Us 31 We are more than just a name 45 31 Our brand, our vision. Together 45 31 Contacting Quest 45 31 Technical support resources 45 31 Getting Started‌ The started with Foglight REST API is an application programming interface for‌ Office 365 Microsoft® Exchange Online (APISaaS) offers many different reports that uses HTTP requests can help you determine the overall status and health of your organization. It also offers tools to GET, PUT, POSThelp Exchange Online administrators troubleshoot specific events (such as a message not arriving to its intended recipients), and DELETE dataaudit reports to aid with compliance requirements. The Foglight™ for Office 365™ is designed to show performance and availability metrics provided by Microsoft® Exchange online (SaaS). This information is presented in the Office 365 Environment dashboard. This guide is designed to familiarize you with the key features of Foglight REST API Reference Guide is intended for users who have been assigned Office 365. It describes the API Access dashboards and views included with Foglight for Office 365, and provides information about administering the Foglight for Office 365 and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systemsADFS (Active Directory® Federation Services) agents. This section introduces you to the Foglight REST APIsfor Office 365 environment and provides essential foundational information. For more information, see review the following topics: • Glossary Installation requirements • Prerequisites Data collection • OverviewDashboard location Installation requirements‌ Foglight for Office 365 is part of the Foglight for Exchange release package, and is automatically installed when deploying the Foglight for Exchange agent package. For information about system requirements, version compatibility, and installation instructions, see the Foglight for Exchange Release Notes. Data collection‌ Before starting using Foglight for Office 365 to collect data, ensure you have an administrative account with Microsoft® Office 365™. For example, go to this web page to create an Office 365™ Business Premium Trial account: xxxxx://xxxxxx.xxxxxx.xxx/Signup?OfferId=467eab54-127b-42d3-b046- 3844b860bebf&dl=O365_BUSINESS_PREMIUM&culture=en-US&country=US&ali=1&wa=wsignin1.0&alo=1 The Office 365 Environment dashboard automatically displays the Microsoft® Exchange Online (SaaS) virtual machine hosts that Foglight for Office 365 monitors. To access the dashboard:‌ • On the navigation panel, under Dashboards, click the Office 365 > Office 365 Environment. The Office 365 Environment dashboard is displayed. It includes the following tabs: ▪ Administration. Allows you to perform administrative tasks. For details, see Administering monitoring agents and collected data. ▪ Monitoring. Displays a summary of the Exchange Online services being monitored and their current state. For details, see Monitoring your environment. Figure 1. Office 365 Environment dashboard location Administering monitoring agents‌‌ and collected data The Administration tab of the Office 365 Environment dashboard allows you to perform administrative tasks, including: • Deploy the Foglight for Office 365 agent package • Create, edit, activate, deactivate, and delete Foglight for Office 365 agents and ADFS (Active Directory® Federation Services) agents • Start and stop collecting data • Configure domain credentials and set up permissions necessary to use the Office 365™ APIs This section includes the following topics: • Accessing the Administration tab • Deploy the Foglight for Office 365 agent package • Managing Foglight for Office 365 agents • Configuring Foglight for Office 365 agent properties • Managing ADFS agents • Configuring ADFS agent properties Accessing the Administration tab‌ To access the Administration tab: 1 On the navigation panel, under Dashboards, click Office 365 > Office 365 Environment. The Office 365 Environment dashboard is displayed. 2 Click the Administration tab. The Administration tab includes the following components, and allows you to perform administrative tasks, as follows: • Tasks list:

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference User Guide Updated - November May 2018 Software Version - 5.9.x Getting Started Glossary with Foglight 6 Prerequisites Getting Started 6 Overview Logging in to Foglight 6 Starting from the Welcome Page 7 REST APIs App Navigating Foglight 8 Using the Navigation Panel 8 Using the Breadcrumb Trail 9 Using Drilldowns 9 Using Bookmarks 9 Opening a New Window 10 APP — Get App Running a Report 10 Choosing a Home Page 10 Getting Started FAQ 11 Working with Dashboards 11 Viewing, Acknowledging, and Clearing Alarms 46 Viewing Alarms 47 Filtering the Alarm List 47 Viewing Alarm Details 48 Acknowledging an Alarm 50 Clearing an Alarm 51 Monitoring Your Domains 52 Viewing detailed information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for domain or subdomain 52 Investigating Problems in a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current Domain 53 Investigating a Domain or Subdomain’s State 53 Investigating a Subdomain’s Health 53 Investigating a Subdomain’s Alarms 54 Investigating Problems with a Subdomain’s Agents 54 Monitoring Your Services 55 Selecting the Services You Want to Monitor 56 Service Dependencies 56 Monitoring a Service 57 Investigating service level compliance and availability 57 Investigating alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances 58 Drilling down into a service 58 Viewing the state of and drilling down into a type 43 User Information 44 User Information — Get current user information 44 About Us We are tier 58 Viewing more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional details about your services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview59

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API User and Reference Guide Updated - November 2018 Software March 2017 Foglight Version - 5.9.x Getting Started Glossary 5.7.5.8 Cartridge Version - 5.8.5.8 Using Foglight for SNMP to monitor devices 5 Installing or upgrading Foglight for SNMP 5 Foglight for SNMP navigation basics 6 Prerequisites 6 Understand monitoring with both host and SNMP agents 7 Multiple Foglight Agent Manager instances 8 SNMP discovery 8 SNMP discovery on Linux requirements 8 Running SNMP discovery 10 Ineligible devices 14 SNMP communities and credentials 14 Accessing the Manage all credentials wizard 15 Managing SNMP V1 or V2c community strings 15 Managing the SNMP V3 credentials 16 Changing an SNMP device credential 17 Managing monitor configurations 18 Configuring SNMP agent properties 19 Changing the GenericSNMPTrapAgent port 22 Viewing SNMP monitored hosts 23 Hosts monitored by both an Infrastructure and SNMP agent 24 Hosts monitored only by SNMP 24 Hosts monitored only by an Infrastructure agent 25 Generating reports 25 Foglight for SNMP reference 26 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule tab 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query Networking tab 29 Disk Volumes tab 37 Topology — Push data Running Processes tab 37 Installed Applications tab 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Custom Properties tab 38 About Us 40 We are more than just a name 45 40 Our brand, our vision. Together 45 40 Contacting Quest 45 40 Technical support resources 45 Getting Started‌ The 40 Using Foglight REST API is an application programming interface (API) for SNMP to monitor‌ devices Foglight for SNMP supports and extends the physical host and device monitoring capabilities of the Foglight for Infrastructure cartridge to a broader set of platforms that uses HTTP requests the Infrastructure agent does not currently support. Use Foglight for SNMP to GETcollect data from all types of devices, PUTsuch as desktops, POSTservers, routers, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access switches, across Microsoft®Windows®, Linux®, Oracle Solaris®, HP-UX™, and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party AIX® operating systems. This section introduces When you enable SNMP on a device and provide the correct credentials, Foglight for SNMP can monitor that device and collect data from it. When you deploy Foglight for SNMP, you can view the performance of the monitored platforms and devices. Foglight for SNMP gives you the capability to ensure consistent platform and device performance by reviewing the performance statistics. Better management of your hosts and devices can be achieved when you are alerted to potential problems before users are affected. Starting with version 5.8.5.3, the SNMP agent package that collects data is no longer deployed during installation. Using multiple Foglight Agent Managers is now supported, so after you install the Foglight REST APIsfor SNMP cartridge on the Management Server, run an SNMP discovery to select an Agent Manager. For more information, see Running SNMP discovery. Getting started with Foglight for SNMP Review the following topicstopics to learn about the dashboards, understand any requirements, and complete an SNMP Discovery to start monitoring devices and collecting data: • Glossary Installing or upgrading Foglight for SNMP • Prerequisites Understand monitoring with both host and SNMP agents • OverviewMultiple Foglight Agent Manager instances • Running SNMP discovery Installing or upgrading Foglight for SNMP‌ Foglight for Infrastructure must be installed before installing Foglight for SNMP. For more information, see the

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Guide Web Component Tutorial Updated - November 2018 Software April 2022 Foglight Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 6.1.0 Using the Web Component Tutorial 7 REST APIs App Browser Interface Views 7 Why Configure the Default Views? 7 What is the Web Component Framework? 8 Simple Dashboard Creation 10 APP — Get App information How to Use this Tutorial 10 Security 11 Security — Login 11 Security — Logout Tutorial 1: Drag and Drop 12 Security — Set Auth Token Creating a Custom Dashboard by Drag and Drop 12 Customizing Dashboards 17 Add View 17 Add Text 18 Edit Page Layout 21 Tutorial 2: Creating a Dashboard 31 Constructing the Tutorial Module 32 Configuring a Query 33 Configuring a Row-Oriented Table 35 Configuring Table Columns 36 Building the Dashboard 37 Adding the Table to the Dashboard 39 Summary 40 Tutorial 3: Adding a Drilldown Page 42 Preliminary Setup 42 Adding a Column of Aggregate Alarms to the Table 43 Adding a Dependent Page 45 Adding a Context-Sensitive Dependent Page for the Table of Hosts 46 Summary 49 Tutorial 4: Adding Views 52 Designing the Page 53 Preliminary Setup 53 Defining the Alarms Query 54 Configuring a Table of Alarms 55 Configuring a Chart Component 59 Configuring a Label with an Action 61 Configuring the Drilldown Page 63 Configuring a Drop-Down List 64 Flowing Monitored Hosts to Host Details T3 66 Adding a Customizer 66 Adding Nested Views 67 Summary 68 Tutorial 6: Reports 80 Configuring a Query 81 Creating a Basic Report Page 81 Creating a More Elaborate Hosts Table 84 Adding a Header 89 Adding a Footer 90 Adding an Iterator for a given user 12 Security — Delete Auth Token Multi-Page Report 92 Choosing the Iterated View 93 Summary 93 Tutorial 7: Creating a Form 97 About this Tutorial 97 Defining the Enumerated Types for Manager and Staff 100 Defining the Manager and Staff Types 101 Defining the Company Type 102 Defining the Functions for Adding and Removing a given user 13 Security — Set Auth Token Manager 103 Defining the Labels 104 Defining the Bean Input Components 104 Defining the Grid Layout 106 Defining the Dialog 108 Defining the Table of Managers 109 Defining the Top-Level Dashboard 112 Summary 113 Tutorial 8: Renderers 116 Text Renderer 118 Date Renderer 119 Number Bar Renderer and Number Unit Renderer 120 Configuring the Labels 121 Tutorial 9: Adding Questions and Answers 123 Working with Associations and Question Viewers 123 Building Associations for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all nonYour Question Viewer 125 Creating a Domain 126 Creating Categories 127 Creating Questions 127 Populating the Question Viewer with Questions and Answers 129 Building a Mini-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Viewer 133 Summary 135 Tutorial 10: Sending Messages to Other Users 136 Creating Message Associations 136 Creating Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Functions 137 About Us 143 We are more than just a name 45 143 Our brand, our vision. Together 45 143 Contacting Quest 45 143 Technical support resources 45 Getting Started‌ The Foglight REST API is an 143 Using the Web Component Tutorial‌ With Foglight®, application programming interface (API) that uses HTTP requests to GETand IT managers can understand end-user service levels for their critical business applications, PUT, POSTnotify stakeholders when those service levels are violated, and DELETE dataassign problem resolution tasks to the appropriate domain expert. In addition to Foglight's core performance management capabilities, Foglight offers specialized monitoring for all application tiers including: End-User Response, Application, Web Servers, Application Servers, Databases, and Operating Systems. That is a lot of capability, and the volume of data being collected can be overwhelming. The Foglight REST API Reference Guide views in the browser interface attempt to organize the data into meaningful summaries, with drilldowns to increasingly specific information about a chosen component, such as a single host or a particular database instance. It is intended for users who have been assigned likely that you organize the API Access top-level screens around the concept of services, and choose them to show a view that should be useful to a broad range of users—those with typical environments. In all likelihood your environment is not quite typical, and as you gain familiarity with the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces browser interface, you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overviewwill imagine ways that they could be improved.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference for Office 365 User Guide Updated - November January 2018 Foglight Version - 5.9.2 Software Version - 5.9.x 5.7.2 Getting Started Glossary started with Foglight for Office 365 5 Installation requirements 5 Data collection 5 Dashboard location 6 Prerequisites 6 Overview Administering monitoring agents and collected data 7 REST Accessing the Administration tab 7 Agents management table 8 Agents management toolbar 9 Deploy the Foglight for Office 365 agent package 9 Managing Foglight for Office 365 agents 10 Add and configure Foglight for Office 365 agents 10 Activate, deactivate, and delete agents 12 Start and stop data collection 13 Configure domain credentials 13 Set up permissions to use the Office 365 APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token 13 Configuring Foglight for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user Office 365 agent properties 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active Managing ADFS agents 15 Agent — Get all Add and configure ADFS agents 16 Agent — Get all inactive Edit ADFS agents 16 Alarm properties 17 Alarm — Acknowledge alarm by alarm ID Configuring ADFS agent properties 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms Monitoring your environment 20 Alarm — Get topology object history alarms Accessing the Monitoring tab 20 Alarm — Push alarms Foglight for Office 365 Environment Overview 20 Foglight for Office 365 Environment Quick View 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data Foglight for Office 365 views 24 Cartridge — Get all non-core cartridges’ data Exchange Online views 24 Registry Environment Summary - Exchange Online (All Objects) view 24 Environment Summary - Exchange Online (Selected Object) view 25 Registry — Get all registries’ data Explorer Summary - Exchange Online (Selected Object) view 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id ADFS views 27 Script Environment Summary - ADFS (All Objects) view 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Environment Summary - ADFS (Selected Object) view 27 About Us 31 We are more than just a name 45 31 Our brand, our vision. Together 45 31 Contacting Quest 45 31 Technical support resources 45 31 Getting Started‌ The started with Foglight REST API is an application programming interface for‌ Office 365 Microsoft® Exchange Online (APISaaS) offers many different reports that uses HTTP requests can help you determine the overall status and health of your organization. It also offers tools to GET, PUT, POSThelp Exchange Online administrators troubleshoot specific events (such as a message not arriving to its intended recipients), and DELETE dataaudit reports to aid with compliance requirements. The Foglight® for Office 365™ is designed to show performance and availability metrics provided by Microsoft® Exchange online (SaaS). This information is presented in the Office 365 Environment dashboard. This guide is designed to familiarize you with the key features of Foglight REST API Reference Guide is intended for users who have been assigned Office 365. It describes the API Access dashboards and views included with Foglight for Office 365, and provides information about administering the Foglight for Office 365 and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systemsADFS (Active Directory® Federation Services) agents. This section introduces you to the Foglight REST APIsfor Office 365 environment and provides essential foundational information. For more information, see review the following topics: • Glossary Installation requirements • Prerequisites Data collection • OverviewDashboard location Installation requirements‌ Foglight for Office 365 is part of the Foglight for Exchange release package, and is automatically installed when deploying the Foglight for Exchange agent package. For information about system requirements, version compatibility, and installation instructions, see the Foglight for Exchange Release Notes. Data collection‌ Before starting using Foglight for Office 365 to collect data, ensure you have an administrative account with Microsoft® Office 365™. For example, go to this web page to create an Office 365™ Business Premium Trial account: xxxxx://xxxxxx.xxxxxx.xxx/Signup?OfferId=467eab54-127b-42d3-b046- 3844b860bebf&dl=O365_BUSINESS_PREMIUM&culture=en-US&country=US&ali=1&wa=wsignin1.0&alo=1 The Office 365 Environment dashboard automatically displays the Microsoft® Exchange Online (SaaS) virtual machine hosts that Foglight for Office 365 monitors. To access the dashboard:‌ • On the navigation panel, under Dashboards, click the Office 365 > Office 365 Environment. The Office 365 Environment dashboard is displayed. It includes the following tabs: ▪ Administration. Allows you to perform administrative tasks. For details, see Administering monitoring agents and collected data. ▪ Monitoring. Displays a summary of the Exchange Online services being monitored and their current state. For details, see Monitoring your environment. Figure 1. Office 365 Environment dashboard location Administering monitoring agents‌‌ and collected data The Administration tab of the Office 365 Environment dashboard allows you to perform administrative tasks, including: • Deploy the Foglight for Office 365 agent package • Create, edit, activate, deactivate, and delete Foglight for Office 365 agents and ADFS (Active Directory® Federation Services) agents • Start and stop collecting data • Configure domain credentials and set up permissions necessary to use the Office 365™ APIs This section includes the following topics: • Accessing the Administration tab • Deploy the Foglight for Office 365 agent package • Managing Foglight for Office 365 agents • Configuring Foglight for Office 365 agent properties • Managing ADFS agents • Configuring ADFS agent properties Accessing the Administration tab‌ To access the Administration tab: 1 On the navigation panel, under Dashboards, click Office 365 > Office 365 Environment. The Office 365 Environment dashboard is displayed. 2 Click the Administration tab. The Administration tab includes the following components, and allows you to perform administrative tasks, as follows: • Tasks list:

Trademarks. Quest, the Quest logo, and Join the Innovation Where next meets now are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Creating Actions Field Guide Updated - November 2018 Software April 2023 Foglight Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview6.3.0

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Web Component Guide Updated - November May 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances Introducing the Web Component Framework 8 Configuring Views 8 Browser Interface Views 9 The Browser Interface 9 Anatomy of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brandTypical Dashboard 10 The Web Component Framework (WCF) 10 The Design Tab 11 The Web Component Framework 13 Core Concepts 13 Modules 13 Observations 16 Context 19 Parameters in Bindings 19 On Null Values 20 Renderers 20 Default Values 20 Data Sources, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POSTData Types, and DELETE data. Data Objects 20 Paths 21 Properties 21 Using the Web Component Framework 21 The Foglight REST API Reference Guide is intended for users who have been assigned Web Component Framework Editor 21 An Example Page 22 Managing Dashboards 23 Definitions Panes 23 Data and Data Sources Pages 24 Definitions Pane 24 Customizing the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topicsUI Quickly 25 Finding Pages: • Glossary • Prerequisites • OverviewBookmarks 25 Additional Documentation 25

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Guide Web Component Tutorial Updated - November May 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview Using the Web Component Tutorial 7 REST APIs App Browser Interface Views 7 Why Configure the Default Views? 7 What is the Web Component Framework? 8 Simple Dashboard Creation 10 APP — Get App information How to Use this Tutorial 10 Security 11 Security — Login 11 Security — Logout Tutorial 1: Drag and Drop 12 Security — Set Auth Token Creating a Custom Dashboard by Drag and Drop 12 Customizing Dashboards 17 Add View 17 Add Text 18 Edit Page Layout 21 Tutorial 2: Creating a Dashboard 31 Constructing the Tutorial Module 32 Configuring a Query 33 Configuring a Row-Oriented Table 35 Configuring Table Columns 36 Building the Dashboard 37 Adding the Table to the Dashboard 39 Summary 40 Tutorial 3: Adding a Drilldown Page 42 Preliminary Setup 42 Adding a Column of Aggregate Alarms to the Table 43 Adding a Dependent Page 45 Adding a Context-Sensitive Dependent Page for the Table of Hosts 46 Summary 49 Tutorial 4: Adding Views 52 Designing the Page 53 Preliminary Setup 53 Defining the Alarms Query 54 Configuring a Table of Alarms 55 Configuring a Chart Component 59 Configuring a Label with an Action 61 Configuring the Drilldown Page 63 Configuring a Drop-Down List 64 Flowing Monitored Hosts to Host Details T3 66 Adding a Customizer 66 Adding Nested Views 67 Summary 68 Tutorial 6: Reports 80 Configuring a Query 81 Creating a Basic Report Page 81 Creating a More Elaborate Hosts Table 84 Adding a Header 89 Adding a Footer 90 Adding an Iterator for a given user 12 Security — Delete Auth Token Multi-Page Report 92 Choosing the Iterated View 93 Summary 93 Tutorial 7: Creating a Form 97 About this Tutorial 97 Defining the Enumerated Types for Manager and Staff 100 Defining the Manager and Staff Types 101 Defining the Company Type 102 Defining the Functions for Adding and Removing a given user 13 Security — Set Auth Token Manager 103 Defining the Labels 104 Defining the Bean Input Components 104 Defining the Grid Layout 106 Defining the Dialog 108 Defining the Table of Managers 109 Defining the Top-Level Dashboard 112 Summary 113 Tutorial 8: Renderers 116 Text Renderer 118 Date Renderer 119 Number Bar Renderer and Number Unit Renderer 120 Configuring the Labels 121 Tutorial 9: Adding Questions and Answers 123 Working with Associations and Question Viewers 123 Building Associations for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all nonYour Question Viewer 125 Creating a Domain 126 Creating Categories 127 Creating Questions 127 Populating the Question Viewer with Questions and Answers 129 Building a Mini-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Viewer 133 Summary 135 Tutorial 10: Sending Messages to Other Users 136 Creating Message Associations 136 Creating Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Functions 137 About Us 143 We are more than just a name 45 143 Our brand, our vision. Together 45 143 Contacting Quest 45 143 Technical support resources 45 Getting Started‌ The Foglight REST API is an 143 Using the Web Component Tutorial‌ With Foglight®, application programming interface (API) that uses HTTP requests to GETand IT managers can understand end-user service levels for their critical business applications, PUT, POSTnotify stakeholders when those service levels are violated, and DELETE dataassign problem resolution tasks to the appropriate domain expert. In addition to Foglight's core performance management capabilities, Foglight offers specialized monitoring for all application tiers including: End-User Response, Application, Web Servers, Application Servers, Databases, and Operating Systems. That is a lot of capability, and the volume of data being collected can be overwhelming. The Foglight REST API Reference Guide views in the browser interface attempt to organize the data into meaningful summaries, with drilldowns to increasingly specific information about a chosen component, such as a single host or a particular database instance. It is intended for users who have been assigned likely that you organize the API Access top-level screens around the concept of services, and choose them to show a view that should be useful to a broad range of users—those with typical environments. In all likelihood your environment is not quite typical, and as you gain familiarity with the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces browser interface, you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overviewwill imagine ways that they could be improved.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference User Guide Updated - November 2018 March 2017 Software Version - 5.9.x 5.7.5.8 Getting Started Glossary with Foglight 6 Prerequisites Getting Started 6 Overview Logging in to Foglight 6 Starting from the Welcome Page 7 REST APIs App Navigating Foglight 8 Using the Navigation Panel 8 Using the Breadcrumb Trail 9 Using Drilldowns 9 Using Bookmarks 9 Opening a New Window 10 APP — Get App information Running a Report 10 Security Choosing a Home Page 10 Getting Started FAQ 11 Security — Login Working with Dashboards 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Federation Field Guide Updated - November 2018 Software April 2022 Foglight Version - 5.9.x Getting Started Glossary 6.1.0 Federation overview 5 Use cases 5 Capabilities 6 Prerequisites 6 Overview Known issues 7 REST APIs App Requirements 8 Scalability expectations 9 Managing federation 10 APP — Get App information Understanding federation communication channels 10 Topology synchronization 10 Metric pull on demand 11 Alarm service communication channel 12 Planning for federation 13 Communication ports 13 HA considerations 14 Configuring a federated environment 14 Setting up a federated environment 14 Federation configuration changes 16 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for settings 17 Query limitations 18 Custom script queries 19 Upgrading cartridges on a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms federated system 19 Alarm — Get history alarms Selectively disabling federation services 19 Alarm — Get topology object current alarms Deploying cartridge components 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms Troubleshooting 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Frequently asked questions 21 About Us 27 We are more than just a name 45 27 Our brand, our vision. Together 45 27 Contacting Quest 45 27 Technical support resources 45 Getting Started‌ The 27 Federation overview‌ Federation is a Foglight® feature that addresses the needs of customers who monitor large-scale environments that are naturally partitioned into logical units. Each partition is traditionally served by one Foglight REST API is Management Server instance and its distributed clients/agents. This document presents an application programming interface (API) that uses HTTP requests to GET, PUT, POST, overview of the federation feature and DELETE dataprovides guidelines for configuring Federation Masters and Federated Children. The Foglight REST API Reference Guide intended audience for this document is intended for users who have been assigned the API Access and Quest SC/PSO (System Consultant/Professional Services Organization) personnel working in the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systemsfield. This section introduces you to describes a number of cases where the Foglight REST APIsfederation feature is used. For more informationIn addition, see a list of federation capabilities, known issues, and requirements are provided. • Use cases • Capabilities • Known issues • Requirements • Scalability expectations Use cases‌ Federation enables the use of one Foglight® Management Server to operate, while using other Management Servers as the data source. As illustrated in the following topics: • Glossary • Prerequisites • Overviewfigure, a Foglight user can visualize the data from one or more stand-alone Management Servers (the Federated Children) from a single, central Management Server (the Federation Master). This allows users to meet both local and central monitoring requirements.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest Dell is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Guide Updated - November 2018 April 2017 Software Version - 5.9.x 5.7.5.8 Getting Started Glossary 6 Prerequisites 6 Overview 7 6 REST APIs App 10 9 APP — Get App information 9 Security 10 Security 11 Security — Login 11 10 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview11

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Guide Updated - November 2018 December 2017 Software Version - 5.9.x 5.9.2 Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 22 Cartridge — Get all core cartridges’ data 24 23 Cartridge — Get all non-core cartridges’ data 23 Registry 24 Registry 25 Registry — Get all registries’ data 25 24 Remote client 25 24 Remote client — Get all remote clients’ data 25 Rule 26 25 Rule — Get all rules’ data 26 25 Rule — Get rule by id 27 26 Script 27 26 Script — Run Script 26 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 30 Subscribe alarm — Disconnect SSE 31 30 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 31 Subscribe alarm — Subscribe all alarms 33 32 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 34 Topology — Get topology object by ids 35 Topology — Observations query 36 35 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API User and Reference Guide Updated - November 2018 May 2017 Software Version - 5.9.x Getting Started Glossary 5.7.3 About Foglight for Hyper-V 6 Prerequisites About your monitored environment 6 Overview Prerequisites: Foglight for Hyper-V roles 7 REST APIs App Prerequisites: Foglight for Hyper-V configuration 7 Foglight for Hyper-V WinRM GPO script 8 Agent administration 9 Accessing theAdministration tab 9 Tasks area 10 APP — Get App information Agents view commands 10 Security Agent tabs 11 Security — Login 11 Security — Logout Configuring monitoring agents 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get Configuring agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology properties 21 Reviewing object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ instances and deleting expired data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id Instances and Limits view 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts Performance monitoring with the Hyper-V Environment dashboard 29 Accessing the Hyper-V Environment dashboard 29 Monitoring tab 30 Subscribe Virtual Environment view 31 Quick-View 34 Alarms view 34 Cluster monitoring 35 Server monitoring 43 SOFS Server monitoring 52 SCVMM server monitoring 59 Virtual machine monitoring 76 Storage monitoring 83 Virtual switch monitoring 93 About frequently asked questions 101 About reports 102 Report templates 103 Foglight Chargeback 104 Foglight for Capacity Management 104 Foglight Resource Optimizer for Hyper-V Environments 105 Performance investigation with the Hyper-V Explorer 107 About the Hyper-V Explorer 107 Accessing the Hyper-V Explorer 108 About the Hyper-V Explorer topology 110 Hyper-V Explorer Topology tab 111 Hyper-V Explorer Summary 111 Hyper-V Explorer Summary tab 112 Hyper-V Explorer Summary (All Clusters) tab 119 Hyper-V Explorer Summary (All Virtual Machines) tab 123 Hyper-V Explorer Monitor 125 Hyper-V Explorer Monitor tab 126 Hyper-V Explorer FAQts 136 Hyper-V Explorer FAQts tab 136 Hyper-V Explorer Event Analytics 137 Hyper-V Explorer Event Analytics tab 138 Hyper-V Explorer Storage 141 Hyper-V Explorer Storage tab (clusters) 141 Hyper-V Explorer Storage tab (Hyper-V servers) 143 Hyper-V Explorer Storage tab (virtual machines) 144 Hyper-V Explorer Processes 146 Hyper-V Explorer Cost 147 Hyper-V Explorer Cost tab 147 Hyper-V server and virtual machine administration 149 Accessing the Hyper-V Explorer Administration tab 151 Hyper-V Explorer Administration tab 153 Shutting down and rebooting Hyper-V servers 157 Creating, re-configuring, and moving virtual machines 158 Pausing, powering off virtual machines, and shutting down their guest OS 160 Cloning, deleting, and saving virtual machines 161 Creating, managing, and reverting to virtual machine snapshots 162 Automating Hyper-V administration with workflows 164 Foglight for Hyper-V alarms 167 Accessing the Hyper-V Alarms dashboard 167 Alarm overview 168 Alarm table 168 Setting the alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe sensitivity level 169 Finding alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 using the action panel 170 Appendix: Hyper-V Agent error codes 172 About Us 174 We are more than just a name 45 174 Our brand, our vision. Together 45 174 Contacting Quest 45 174 Technical support resources 45 Getting Started‌ The 174 About Foglight REST API is an for Hyper-V‌ Foglight™ for Hyper-V monitors a Microsoft® Hyper-V® virtual infrastructure. Better management of services can be achieved when you are alerted of infrastructure problems before end users are affected. This ensures consistent application programming interface (API) that uses HTTP requests to GETperformance at established service levels. Foglight for Hyper-V monitors the health of your virtual system by tracking resource consumption such as CPU, PUT, POSTnetwork, and DELETE datamemory consumption for individual clusters, servers and virtual machines in your integrated environment. • About your monitored environment • Prerequisites: Foglight for Hyper-V roles • Prerequisites: Foglight for Hyper-V configuration • Foglight for Hyper-V WinRM GPO script About your monitored environment‌ Microsoft® Hyper-V® provides an innovative mechanism for organizing a virtual infrastructure using a unique combination of physical and logical components. Foglight™ for Hyper-V accommodates environments of all sizes that leverage the Hyper-V virtualization platform by examining and enhancing the Hyper-V eminently knowledgeable view of the virtual world. Microsoft Hyper-V allows for the configuration of a hierarchical organizational structure that resides primarily within the virtual domain. This enables organizations to easily configure physical Hyper-V servers and virtual machines to reside in logical groups that dictate various aspects of the virtual infrastructure, like physical object location, resource allocations and limitations for virtual machines, and high availability settings for physical and virtual components. A Hyper-V infrastructure contains a collection of physical and virtual objects. The Foglight REST API Reference Guide is intended physical objects within the virtual infrastructure are those with which you can physically interact. The virtual components or objects that make up the virtual environment cannot exist without the presence of underlying physical components, such as Hyper-V servers. In addition, virtual objects, such as clusters and virtual machines, allow for users who have been assigned the API Access advanced configuration of resource management and the Administrator roles and who need programmatic access to easily create professional services and better integrate with thirdof high availability settings. Each Hyper-party systems. This section introduces you to the Foglight REST APIs. For more information, see V infrastructure contains a collection of the following topicsobject types: • Glossary • Prerequisites • OverviewClusters. A cluster object is a group of Hyper-V servers that share common storage resources and network configurations.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Federation Field Guide Updated - November 2018 April 2017 Software Version - 5.9.x Getting Started Glossary 5.7.5.8 Federation overview 5 Use cases 5 Capabilities 6 Prerequisites 6 Overview Known issues 7 REST APIs App Requirements 8 Scalability expectations 9 Managing federation 10 APP — Get App information Understanding federation communication channels 10 Topology synchronization 10 Metric pull on demand 11 Alarm service communication channel 12 Planning for federation 13 Communication ports 13 HA considerations 14 Configuring a federated environment 14 Setting up a federated environment 15 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for settings 16 Query limitations 17 Custom script queries 17 Upgrading cartridges on a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm federated system 17 Alarm — Acknowledge alarm by alarm ID Selectively disabling federation services 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID Deploying cartridge components 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms Troubleshooting 19 Alarm — Get history alarms Frequently asked questions 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us 25 We are more than just a name 45 25 Our brand, our vision. Together 45 25 Contacting Quest 45 25 Technical support resources 45 Getting Started‌ The 25 Federation overview‌ Federation is a Foglight™ feature that addresses the needs of customers who monitor large-scale environments that are naturally partitioned into logical units. Each partition is traditionally served by one Foglight REST API is Management Server instance and its distributed clients/agents. This document presents an application programming interface (API) that uses HTTP requests to GET, PUT, POST, overview of the federation feature and DELETE dataprovides guidelines for configuring Federation Masters and Federated Children. The Foglight REST API Reference Guide intended audience for this document is intended for users who have been assigned the API Access and Quest SC/PSO (System Consultant/Professional Services Organization) personnel working in the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systemsfield. This section introduces you to describes a number of cases where the Foglight REST APIsfederation feature is used. For more informationIn addition, see a list of federation capabilities, known issues, and requirements are provided. • Use cases • Capabilities • Known issues • Requirements • Scalability expectations Use cases‌ Federation enables the use of one Foglight™ Management Server to operate, while using other Management Servers as the data source. As illustrated in the following topics: • Glossary • Prerequisites • Overviewfigure, a Foglight user can visualize the data from one or more stand-alone Management Servers (the Federated Children) from a single, central Management Server (the Federation Master). This allows users to meet both local and central monitoring requirements.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API for Hyper-V User and Reference Guide Updated - November June 2018 Software Version - 5.9.x Getting Started Glossary 5.7.6 About Foglight for Hyper-V 6 Prerequisites About your monitored environment 6 Overview Prerequisites: Foglight for Hyper-V roles 7 REST APIs App Prerequisites: Foglight for Hyper-V configuration 7 User privileges required for monitoring agents 7 Configurations required for collecting data from VMs resided on SMB server 8 Foglight for Hyper-V WinRM GPO script 8 Agent administration 10 APP — Get App information Accessing the Administration tab 10 Security Administration area 11 Security — Login Agents view commands 11 Security — Logout Agent tabs 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user Configuring monitoring agents 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get Configuring agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ Reviewing object instances and deleting expired data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API Instances and Limits view 28 Script — Run named scripts Performance monitoring with the Hyper-V Environment dashboard 30 Subscribe Accessing the Hyper-V Environment dashboard 30 Monitoring tab 31 Gauge charts 31 Virtual Environment view 33 Quick-View 36 Alarms view 36 Cluster monitoring 37 Server monitoring 45 SOFS Server monitoring 54 SCVMM server monitoring 60 Virtual machine monitoring 77 Storage monitoring 85 Virtual switch monitoring 94 About frequently asked questions 102 About reports 103 Report templates 104 Foglight Chargeback 105 Foglight for Capacity Management 105 Foglight Resource Optimizer for Hyper-V Environments 106 Performance investigation with the Hyper-V Explorer 108 About the Hyper-V Explorer 108 Accessing the Hyper-V Explorer 109 About the Hyper-V Explorer topology 111 Hyper-V Explorer Topology tab 112 Hyper-V Explorer Summary tab 113 Hyper-V Explorer Summary (All Clusters) tab 120 Hyper-V Explorer Summary (All Servers) tab 122 Hyper-V Explorer Summary (All Virtual Machines) tab 124 Hyper-V Explorer Monitor 126 Hyper-V Explorer Monitor tab 127 Hyper-V Explorer FAQts 137 Hyper-V Explorer FAQts tab 137 Hyper-V Explorer Event Analytics 138 Hyper-V Explorer Event Analytics tab 139 Hyper-V Explorer Storage 142 Hyper-V Explorer Storage tab (clusters) 142 Hyper-V Explorer Storage tab (Hyper-V servers) 144 Hyper-V Explorer Storage tab (virtual machines) 145 Hyper-V Explorer Processes 147 Hyper-V Explorer Cost 148 Hyper-V Explorer Cost tab 148 Hyper-V server and virtual machine administration 150 Accessing the Hyper-V Explorer Administration tab 152 Hyper-V Explorer Administration tab 154 Shutting down and rebooting Hyper-V servers 158 Creating, re-configuring, and moving virtual machines 159 Pausing, powering off virtual machines, and shutting down their guest OS 161 Cloning, deleting, and saving virtual machines 162 Creating, managing, and reverting to virtual machine snapshots 163 Automating Hyper-V administration with workflows 165 Foglight for Hyper-V alarms 168 Accessing the Hyper-V Alarms dashboard 168 Alarm overview 169 Alarm table 169 Setting the alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe sensitivity level 170 Finding alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 using the action panel 171 Appendix: Hyper-V Agent error codes 173 About Us 175 We are more than just a name 45 175 Our brand, our vision. Together 45 175 Contacting Quest 45 175 Technical support resources 45 Getting Started‌ The 175 About Foglight REST API is an for Hyper-V‌ Foglight® for Hyper-V monitors a Microsoft® Hyper-V® virtual infrastructure. Better management of services can be achieved when you are alerted of infrastructure problems before end users are affected. This ensures consistent application programming interface (API) that uses HTTP requests to GETperformance at established service levels. Foglight for Hyper-V monitors the health of your virtual system by tracking resource consumption such as CPU, PUT, POSTnetwork, and DELETE datamemory consumption for individual clusters, servers and virtual machines in your integrated environment. • About your monitored environment • Prerequisites: Foglight for Hyper-V roles • Prerequisites: Foglight for Hyper-V configuration • Foglight for Hyper-V WinRM GPO script About your monitored environment‌ Microsoft® Hyper-V® provides an innovative mechanism for organizing a virtual infrastructure using a unique combination of physical and logical components. Foglight® for Hyper-V accommodates environments of all sizes that leverage the Hyper-V virtualization platform by examining and enhancing the Hyper-V eminently knowledgeable view of the virtual world. Microsoft Hyper-V allows for the configuration of a hierarchical organizational structure that resides primarily within the virtual domain. This enables organizations to easily configure physical Hyper-V servers and virtual machines to reside in logical groups that dictate various aspects of the virtual infrastructure, like physical object location, resource allocations and limitations for virtual machines, and high availability settings for physical and virtual components. A Hyper-V infrastructure contains a collection of physical and virtual objects. The Foglight REST API Reference Guide is intended physical objects within the virtual infrastructure are those with which you can physically interact. The virtual components or objects that make up the virtual environment cannot exist without the presence of underlying physical components, such as Hyper-V servers. In addition, virtual objects, such as clusters and virtual machines, allow for users who have been assigned the API Access advanced configuration of resource management and the Administrator roles and who need programmatic access to easily create professional services and better integrate with thirdof high availability settings. Each Hyper-party systems. This section introduces you to the Foglight REST APIs. For more information, see V infrastructure contains a collection of the following topicsobject types: • Glossary • Prerequisites • OverviewClusters. A cluster object is a group of Hyper-V servers that share common storage resources and network configurations.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Infrastructure Utilities User and Reference Guide Updated - November August 2018 Software Foglight Version - 5.9.x Getting Started Glossary Foglight Web Monitor Version 5.9.x Foglight Net Monitor Version 5.9.x Introduction to this guide 6 Prerequisites 6 Overview Monitoring Web transactions 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout Configuring credentials for Web sites requiring user or proxy authentication 7 Configuring credentials to access Web sites requiring user authentication 9 Configuring credentials for accessing Web sites through proxy servers 12 Security — Set Auth Token Monitoring URLs that require a client certificate 16 Exploring your collection of monitored Web sites 17 Expanding your collection of monitored sites 18 Removing Web sites from the existing collection 20 Moving multiple transactions as a group 21 Removing stale transactions from the Performance Browser dashboard 22 Viewing and editing individual Web transaction details 23 Investigating the performance of Web transactions and monitoring locations 26 Exploring the FAQts tab 26 Drilling down on transactions 27 Drilling down on locations via the Locations tab 28 Exploring Web Monitor services 29 Generating reports 32 Configuring Web Monitor agent properties 33 Settings 33 Data Collection Scheduler 35 View reference 35 Web Monitor Performance Browser views 35 Web Monitor Transaction Management views 58 Web Monitor Service Operation Console and Foglight for a given user 12 Security — Delete Auth Token APM Transactions views 62 Monitoring network devices 66 Configuring the ICMP service for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 monitoring 66 Configuring the Agent 14 Agent — Get Manager ICMP service 67 Configuring OS-Level ICMP services 68 Managing monitored network devices 68 Expanding your collection of monitored network devices 70 Removing network devices from the existing collection 73 Viewing and editing individual network device details 73 Investigating the performance of network devices 76 Exploring individual network devices 77 Tracing data packets between monitoring locations and network devices 78 Exploring the FAQ tab 79 Generating reports 80 Configuring the agent by properties 80 Configuring Net Monitor agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 81 View reference 83 Net Monitor Devices Management views 83 About Us 103 We are more than just a name 45 103 Our brand, our vision. Together 45 103 Contacting Quest 45 103 Technical support resources 45 Getting Started‌ The 103 Introduction to this guide‌ Welcome to the Infrastructure Utilities User and Reference Guide. This User and Reference Guide provides agent configuration instructions and information on investigating the performance of monitored Web sites and monitored network devices. It describes the dashboards included with Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POSTWeb Monitor and Foglight Net Monitor, and DELETE datacontains instructions for configuring monitoring agents that collect information from monitored systems. The Foglight REST API Reference Guide This guide is intended for users any user who have been assigned wants to know more about the API Access monitoring agent properties and the Administrator roles dashboards included with these utilities. It is also meant for those users that want to learn about the rules that are included with the Infrastructure utilities. Foglight Log Monitor is an infrastructure utility shipped with Foglight for Infrastructure which monitors log files and who need programmatic access identifies activities that can potentially lead to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIsperformance issues. For more informationinformation about Foglight Log Monitor, see the following topics: • Glossary • Prerequisites • OverviewFoglight for Infrastructure Release Notes and User and Reference Guide.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Creating Actions Field Guide Updated - November 2018 January 2019 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances Table of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • OverviewContents

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Foglight™ for vCloud Director User and Reference Guide Updated - November 2018 April 2017 Software Version - 5.9.x 5.7.3 Getting Started Glossary 6 Prerequisites Before you Begin 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned Introducing the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • OverviewvCloud Directory Infrastructure 6

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Chargeback User Guide Updated - November 2018 Software April 2017 Foglight Version - 5.9.x 5.7.5.8 Cartridge Version - 5.7.3 Using Foglight Chargeback 5 Foglight Chargeback Host Support 5 Understanding Chargeback Models 5 Tiered Flat Rate Model 5 Measured Resource Utilization Model 6 Add Ons Model 9 Chargeback Roles 10 Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout Workflow Basics 12 Security — Set Auth Token Exploring the Chargeback Dashboard 13 Summary View 13 Host Groups View 21 Tiered Flat Rate (TFR Assignments) View 24 Measured Resource Utilization (MRU Assignments) View 27 Add Ons View 30 Example Use Case for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID Chargeback 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us 38 We are more than just a name 45 38 Our brand, our vision. Together 45 38 Contacting Quest 45 38 Technical support resources 45 Getting Started‌ The 38 Using Foglight REST API Chargeback‌ Foglight™ Chargeback generates detailed reports on who spends what inside your IT infrastructure. You are an IT manager with hundreds, if not thousands of virtual machines (VM) or physical machines (PM) in your IT Infrastructure. Virtual machines can be added quickly and appear to be free of cost. As customers add workloads to their virtual environments, determining the true cost of each virtual machine is an application programming interface (API) that uses HTTP requests important component in managing server sprawl. As IT budgets become more constrained, chief information officers are asked to GETinform senior management what the IT infrastructure is actually costing, PUTbroken down by departments, POSTfor example, accounting and human resources. Organizations spend hundreds of thousands of dollars procuring high-end hosts, virtualization software, and DELETE datastorage area network (SAN) disk storage. IT finance needs a way to determine actual resource utilization and fairly charge internal departments for their system utilization. • Foglight Chargeback Host Support • Understanding Chargeback Models • Exploring the Chargeback Dashboard • Example Use Case for Chargeback Foglight Chargeback Host Support‌ Foglight™ Chargeback gathers data from both Hyper-V and VMware virtualization software. To gather data and build chargeback reports using Foglight Chargeback, you must install one or both of the following: • Foglight for VMware • Foglight for Hyper-V Understanding Chargeback Models‌ Foglight™ Chargeback supports industry standard models to determine IT infrastructure costs. These models provide IT managers with the ability to monitor and report the costs associated with host machine usage within data centers. Foglight Chargeback provides the following models: • Tiered Flat Rate Model on page 5 • Measured Resource Utilization Model on page 6 • Add Ons Model on page 9 Tiered Flat Rate Model‌ The Tiered Flat Rate chargeback model can be thought of as charging a flat rate for host machine cost. Another way to look at it would be your telephone xxxx. You are charged a flat rate to use the phone each month regardless of usage. A tier is a level of expense for a host machine. The Foglight REST API Reference Guide Tiered Flat Rate model divides IT costs into levels of expense. For example, an organization has decided to build a new virtual infrastructure, mandating that any new server Pros and Cons of Using the Tiered Flat Rate Model The Tiered Flat Rate model assesses costs as a monthly flat rate. As the costs are calculated in this manner, changes to tier definitions take place immediately and can be applied in a retroactive manner. For example, running a Tiered Flat Rate report with the tiers configured in different ways will generate different costs against the same historical time period. When using the Tiered Flat Rate model, a department is intended charged a flat rate for users who their tier of VMs (for example, Tier 1 is one vCPU, $100/month) and know what their costs will be each month. The drawback of using the Tiered Flat Rate model is getting departments to agree on tier rates. For example, if the VM is turned off, the department is still charged. Measured Resource Utilization Model‌ IMPORTANT: Measured Resource Usage Full and Partial Cost calculations begin initial generation of data after servers have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIstemplates. For more informationThese calculations are based on current usage assessments. The Measured Resource Usage costs are not retroactive. The historical data may not provide the precision needed to generate accurate hourly costs of the past usage. If any changes are made to a Measured Resource Usage Host Template, see the changes take effect in the costs on the next hourly calculation. These changes are not retroactive. The costs have already been calculated based on the previous configuration. The Measured Resource Utilization Model (MRU) can be thought of as the charges you would get from the power company; you are charged for what you use. With the MRU model, each VM is only charged for what it uses of its server's resources. MRU calculations are performed by determining each virtual machine's actual utilization and applying the appropriate cost-unit calculation for each resource based on the resource weighting configuration. The MRU model provides methods for calculating costs based on the following topicstypes of usage: • Glossary Full Cost Recovery on page 7 • Prerequisites • OverviewPartial Cost Recovery on page 7

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Performance Tuning Field Guide Updated - November 2018 April 2017 Software Version - 5.9.x 5.7.5.8 Overview 7 Characteristics of Poor Performance in Foglight 7 Parameters that Affect Foglight Performance 7 Critical Areas that Can Affect Foglight Performance 8 Identifying Performance Problems 8 Hardware and Operating System Tuning 9 Running on Virtual Hardware 10 Performance Challenges 10 CPU 11 Memory 11 Shares 12 Disk 12 Management Server Tuning 13 Dashboard Default Timeout 14 Java Virtual Machine Tuning 16 Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 16 Foglight JVM Configuration 16 JVM Options 17 Common Symptoms and Tuning Resolutions 19 JVM Code Cache 20 Backend Database Tuning 22 Initial Database Configuration Settings 22 Monitoring and Managing Database Size 22 Backup and Recovery Recommendations 22 init.ora Configuration 22 Database Maintenance Recommendations 23 MySQL Tuning 23 Case 23 Oracle Tuning 24 How the Management Server Uses the Database 24 Index Management 24 Memory 25 Block Size 25 Oracle Striping 25 Oracle Tablespaces 25 Microsoft SQL Server Tuning 28 Troubleshooting 28 Management Server Load Preventing Database Connections 28 High Availability (HA) Tuning 31 Tuning Connection Issues in an HA Implementation 31 Managing Hosts with Multiple Network Interfaces 32 JDK with IPv6 on Linux 33 Management Server Automatically Restarted 33 Other JGroup Related Issues and Information 33 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value Tuning 34 Topology — Get topology object by id Changes and Topology Churn 34 Canonical Data Transformations (CDTs) 35 Agent Weight / Environment Complexity 35 Large Topologies 36 Sampling Frequency 36 XML-HTTP Agent Adapter 36 Dropped Agent Manager Log Messages 37 Java EE Technologies 37 Store and Forward Processing 38 About Store and Forward Processing in Foglight 38 Store and Forward Processing and the Foglight Management Server 38 Store and Forward Processing and the Foglight Agent Manager 39 Viewing the Settings that Control the Size of Stored Data 39 Examples 40 Example 1: Reporting on Disk Usage 41 Example 2: Calculating Service Availability Metrics 41 Appendix: Performance Health Check 42 Is the Server Getting the Right Amount of Memory? 42 Management Server Memory is Healthy if 42 Management Server Memory Checks 43 Possible Actions 43 Is the Server Getting Enough CPU? 43 Management Server CPU is Healthy if 43 Management Server CPU Checks 43 Extended Browser Interface Checks 44 Possible Actions 44 Is the Database too Slow? 44 The Database is Healthy if 44 Database Checks 45 Possible Actions 45 Is the Database Growth Reasonable? 45 Database Growth is Healthy if 46 Possible Actions 46 Is There Too Much Data to Process? 46 Data Volume is Healthy if 46 Data Volume Checks 46 Possible Actions 46 Is the Model Stable? 47 Model Checks 47 Possible Actions 47 Are Too Many Alarms Firing? 47 The Number of Alarms is in a Healthy State if. 47 Alarms Checks 48 Possible Actions 48 Is the Business Logic Properly Tuned? 48 Business Logic is Healthy if. 48 Business Logic Checks 48 Possible Actions 48 Are There Too Many User Requests? 49 User Activity Is Healthy If. 49 Possible Actions 49 Appendix: Analyzing a Support Bundle 50 Server Log 50 Topology — Get topology object by ids 35 Sync 50 Topology — Observations query 36 Limits 50 Diagnostic Snapshot 51 Memory Consumption 51 Threads, Deadlocks, and Overall CPU Usage 51 Useful Information 51 ---- jboss.system:type=ServerInfo 51 ---- jboss.jca:service=ManagedConnectionPool,name=jdbc/nitrogen 52 ---- jboss.web:type=RequestProcessor,* 52 ---- com.quest.nitro:service=Derivation 52 ---- com.quest.nitro:service=Topology — TopologyObject query 37 53 ---- com.quest.nitro:service=DataCacheEviction 54 Analyzing a Performance Report 55 Server Rule Information 55 System-wide Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Changes 56 JVM Memory Usage 56 Management Server Garbage Collectors 58 JDBC Connection Pool 59 Derivation Rulette 60 About Us 61 We are more than just a name 45 61 Our brand, our vision. Together 45 61 Contacting Quest 45 61 Technical support resources 45 Getting Started‌ The Foglight REST API 61 Overview‌ Performance is a measure of the efficiency of an application programming running in an environment or of the overall efficiency of multiple applications running in the same environment. You tune performance in order to optimize it. • Characteristics of Poor Performance in Foglight • Parameters that Affect Foglight Performance • Critical Areas that Can Affect Foglight Performance • Identifying Performance Problems Characteristics of Poor Performance in Foglight‌ The following items characterize poor performance in the Foglight™ environment: • poor performing (slow) browser interface • missing data • high CPU load for the Foglight Management Server process • high CPU load for the database backend process • excessive memory utilization (APIor out of memory) • long-running SQL statements Parameters that uses HTTP requests to GET, PUT, POSTAffect Foglight Performance‌ Foglight™ is a complicated system, and DELETE dataits runtime performance depends on many variables within the environment. The following parameters have an effect on Foglight REST API Reference Guide performance: • the processing power of the host running the Management Server • the memory of the host running the Management Server • the memory allocated for the Management Server process (heap) • the database backend type (MySQLTM/Oracle®) • the processing power of the host running the database backend • the memory of the host running the database backend • the number of Foglight Agent Managers Foglight’s runtime performance also depends on what it is intended for users who have been assigned monitoring. Critical Areas that Can Affect Foglight Performance‌ It can be difficult to determine that Foglight™ performance is suffering and then identify the API Access and the Administrator roles and who need programmatic access appropriate steps to easily create professional services and better integrate with third-party systemstake. This section introduces guide provides information about the various things that can have an effect on overall performance and describes the applicable performance-related options. The areas that can have an effect on overall performance are: • Hardware and Operating System Tuning • Management Server Tuning • Java Virtual Machine Tuning • Backend Database Tuning • High Availability (HA) Tuning • Agent Tuning Identifying Performance Problems‌ There are two main methods you can use to proactively check the performance of a Foglight™ installation: 1 You can carry out a performance health check to quickly verify whether or not Foglight REST APIsis functioning properly. For more information, see the following topicsAppendix: • Glossary • Prerequisites • OverviewPerformance Health Check on page 42.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Data Model Guide Updated - November May 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App The Foglight data model 8 What are models? 8 Who needs to know about models? 9 Modeling process overview 9 Where can I see the models? 10 APP — Get App information 10 Security Topology type definitions in XML 11 Security — Login Schema browser 11 Security — Logout Data dashboard 11 How are models organized? 12 Security — Set Auth Token for Where can I see the data model hierarchy? 12 What internal models are created? 13 What other models are created? 13 What is in “Model Roots”? 13 How are Foglight 4 agents represented? 13 Why might I need to navigate models? 14 How do I create a given user 12 Security — Delete Auth Token for model? 14 How do I delete a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user model? 14 Agent What are domains? 14 Agent — Get agent by agent ID Example: the Host Model structure 15 Agent — Get all active agents 15 Agent — Get all agents What is a data source? 16 Agent — Get all inactive agents 16 Alarm What are “KnowledgeItems”? 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms Data modeling tutorials 19 Alarm — Get history alarms Modeling example: The org chart 19 Alarm — Get topology object current alarms Defining the org structure types 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ Populating the model using a script 27 Connecting “Employees” to Host objects 29 Visualizing the data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named 29 Appendix: Groovy scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id createOrg Groovy script 30 Appendix: Internal database schema 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType acl_class Table 39 acl_entry Table 39 acl_object_identity Table 39 acl_sid Table 40 agent_client_defaults Table 40 agent_config_binder Table 40 agent_dc_manager_schedule_ids Table 40 agent_dc_manager_state Table 41 agent_manager_state Table 41 alarm_alarm Table 42 TopologyType — Get type information alarm_annotations Table 42 TopologyType — Get type super type’s information auditing_log Table 43 TopologyType — Get all instances of a type baseline_config Table 43 User Information baseline_config_properties Table 44 User Information — Get current user information baseline_engine_profile Table 44 baseline_observation_profile Table 44 cartridge_cartridge_relation Table 45 cartridge_components Table 45 cartridge_installed_cartridges Table 46 cartridge_items Table 46 credential_data Table 47 credential_lockbox Table 47 credential_mapping Table 48 credential_mapping_entry Table 48 credential_order Table 48 credential_policy Table 49 current_version Table 49 database_instance_id Table 49 database_version Table 50 derivation_calculation Table 50 derivation_complex_definition Table 50 derivation_definition Table 51 fgl4_migration_agent Table 51 fgl4_migration_data_span Table 51 fgl4_migration_dcm Table 51 fgl4_migration_host Table 51 fgl4_migration_host_mapping Table 51 fgl4_migration_log Table 52 fgl4_migration_server Table 52 incident_affected_objects Table 52 incident_incident Table 52 incident_linked_alarms Table 53 incident_problem_ticket Table 53 incident_problem_tickets Table 53 licensing_licenses Table 53 mgmt_object_size Table 54 mgmt_observation_size Table 54 mgmt_timeslice Table 55 mgmt_timeslice_data_avail Table 55 model_association Table 56 model_property_formula Table 56 model_query_criteria Table 56 obs_binary_* Tables 57 obs_metric_aggregate_* Tables 57 obs_metric_scalar_* Tables 58 obs_string_* Tables 58 pcm_encoded_data Table 59 persistable_config_model Table 59 persistable_script Table 60 persistence_column_mapping Table 60 persistence_db_column Table 61 persistence_db_schema Table 61 persistence_db_table Table 61 persistence_grouping_policy Table 62 persistence_lifecycle Table 62 persistence_lifecycle_period Table 63 persistence_obs_key_purge_age Table 63 persistence_obs_purge Table 63 persistence_obs_purge_age Table 64 persistence_observation_index Table 64 persistence_operation Table 64 persistence_retention_policy Table 65 persistence_rollup_progress Table 65 persistence_rollup_retry Table 66 persistence_storage_config_xml Table 66 persistence_storage_manager Table 66 persistence_timeslice_table Table 67 persistence_topobj_purge_age Table 67 persistence_type_hierarchy Table 67 registry_performance_calendar Table 68 registry_registry_value Table 68 registry_registry_variable Table 68 report_output Table 69 report_schedule Table 69 rule_action_handler Table 70 rule_action_message Table 70 rule_action_registry_reference Table 71 rule_action_variable_reference Table 71 rule_blackout_schedules Table 71 rule_effective_schedules Table 71 rule_expression Table 72 rule_firing_strategy Table 72 rule_messages Table 72 rule_rule Table 72 rule_sev_to_clear_actn_hndlr Table 73 rule_sev_to_fire_actn_hndlr Table 74 rule_severity Table 74 rule_severity_expression Table 74 rule_severity_messages Table 75 schedule_named_schedule Table 75 script_annt Table 75 script_annt_attr Table 76 script_argument Table 76 script_argument_annt Table 76 script_argument_annt_attr Table 77 script_example Table 77 script_return_annt_attr Table 78 sec_group Table 78 sec_group_nesting Table 78 sec_group_role_match Table 78 sec_grouprole Table 78 sec_jaas_source Table 79 sec_object Table 79 sec_object_mask Table 80 sec_object_permission Table 80 sec_object_type Table 80 sec_permission Table 81 sec_permission_def Table 81 sec_policy Table 81 sec_resource Table 82 sec_role Table 82 sec_user_alias Table 82 sec_user_obj_permission Table 82 sec_user_res_permission Table 83 sec_usergroup Table 83 sec_userrole Table 83 sec_x_attribute Table 84 sec_x_attribute_value Table 84 tagging_service_mapping Table 84 threshold_bound Table 84 threshold_config Table 85 topology_activity_calendar Table 85 topology_activity_upgrade Table 86 topology_object Table 86 topology_object_history Table 87 topology_property Table 87 topology_property_annotation Table 87 topology_property_history Table 88 topology_property_name Table 88 topology_property_value Table 88 topology_service_state Table 89 topology_type Table 89 topology_type_annotation Table 89 topology_type_history Table 90 upgrade_pending_operations Table 90 wcf_groups_by_cartridges Table 90 wcf_resources Table 91 About Us 92 We are more than just a name 45 92 Our brand, our vision. Together 45 92 Contacting Quest 45 92 Technical support resources 45 Getting Started‌ 92 The Foglight REST API data model‌ This topic provides an introduction to models and discusses the Foglight data model. • What are models? • Who needs to know about models? • Where can I see the models? • How are models organized? • What are domains? • What is an application programming interface (API) a data source? • What are “KnowledgeItems”? What are models?‌ In general, models are abstractions that uses HTTP requests capture the essence of the objects they are supposed to GETrepresent. A good model looks and behaves like the real thing, PUTat least in certain ways. If a model were perfect in every respect, POSTit would be indistinguishable from the real thing. Thus, we could pose questions, submit these in some way to the model, and DELETE dataobtain the same, or almost the same, results as we would by doing those things to the real object. If the object under consideration undergoes a change, the model would have to change accordingly in order to faithfully represent that object. The Foglight REST API Reference Guide data model used in the Management Server is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access constructed to easily create professional services and better integrate with third-party systemsdo just that. This section introduces you The data sent to the Foglight REST APIsManagement Server changes with time, not only because the measurements on properties change, but because the objects themselves may come and go. For more informationSo, see a data model for use with the following topics: Management Server must be designed to accommodate the creation of objects, by placing them in a well-designed model hierarchy. Objects have relationships among themselves, and a good model accounts for those relationships. To the Management Server, models are collections of related data objects. The totality of data objects in existence at any one time is referred to as the “data model”. • Glossary Objects are created by transforming the raw data collected by agents (collection models) or when services are created, deleted, or modified (service models). • Prerequisites • OverviewObjects have properties, such as lists and metrics (time series values). Properties may be simple values, but often they are other objects. Being objects, they can have properties that are objects, and these objects may have the starting object as a property. Thus, the relationships form a graph, not a tree.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Getting Started Guide Updated - November 2018 Software April 2022 Foglight Version - 5.9.x Getting Started Glossary 6.1.0 Components 5 Foglight Management Server 5 Foglight browser interface 6 Prerequisites Customizable dashboards 6 Foglight command-line interface 6 Foglight Agent Manager 7 Foglight cartridges 7 Foglight agents 7 Foglight architecture overview 8 Installation and Setup Overview 7 REST APIs App 10 APP — Get App information Part 1: Installing the Management Server 10 Security Part 2: Starting Foglight and logging in 11 Security — Login Part 3: Installing cartridges 11 Security — Logout Part 4: Installing and running the Agent Manager 12 Security — Set Auth Token for Part 5: Deploying and creating agents 13 Starting Points 14 Before you get started 14 Insufficient roles 14 Working in a given user 12 Security — Delete Auth Token for current or a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID diagnostic time range 15 Agent — Get all active agents 15 Agent — Get all agents Foglight Evolve Environment Overview 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms Foglight Operator’s Welcome page 21 Alarm — Push alarms by properties Foglight Administrator’s Welcome page 22 Alarm — Push alarms by query Service Operations Console 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry Hosts dashboard 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule Next steps 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us 27 We are more than just a name 45 27 Our brand, our vision. Together 45 27 Contacting Quest 45 27 Technical support resources 45 Getting Started‌ The Foglight REST API is an 27 Components‌ Quest Software Inc.’s Foglight® solution simplifies application programming interface (API) that uses HTTP requests performance monitoring and reduces the skills and effort required to GETmanage applications, PUT, POSTthe user experience, and DELETE the supporting infrastructure. Unlike other solutions, Foglight uses a single code base, and has a model-driven design that couples fast deployment and accelerated time-to-value. It offers the modular flexibility required to deliver a range of capabilities and sophistication to meet the needs of any organization, from those still focused on technology-centric monitoring to those that have completed the transition to application-centric or transactional monitoring. Foglight performs equally well in physical, virtual, and mixed infrastructure environments, providing visibility into issues affecting the application and end-user experience. Intuitive workflows help you quickly move from the symptom to the root cause in the application, database, infrastructure, or network to resolve issues, reducing mean time to resolution. Predefined and drag-and-drop dashboards provide insight that is tailored to each stakeholder. By offering comprehensive visibility into your monitored environment, Foglight helps ensure that cross-functional teams collaborate on and prioritize issues that matter most to the business. Foglight comprises several different components, which are described individually. You will be installing and using these components as you perform the steps in the installation and setup process and get started using Foglight. • Foglight Management Server • Foglight browser interface • Foglight command-line interface • Foglight Agent Manager • Foglight cartridges • Foglight agents • Foglight architecture overview Foglight Management Server‌ Foglight Management Server is the central component of Foglight. The Management Server receives information from agents, stores and processes data, and makes it available in the browser interface. The Foglight REST API Reference Guide is intended database stores all system, application, and performance data. Over time, it becomes an invaluable source of historical information for users who have been assigned planning future system capacity requirements and for doing point-in-time analysis. Foglight browser interface‌ Foglight has a browser interface that displays data collected from your monitored environment. It allows you to view this data in various formats and levels of detail. The browser interface consists of three areas: • A navigation panel that: ▪ Lists all of the API Access and dashboards that are available to the Administrator roles and who need programmatic current user. ▪ Provides access to easily create professional services the Administration home page, which presents a summary of information about Foglight from an administrative perspective and better integrate with third-party systems. This section introduces allows you to navigate to the Foglight REST APIspages where you perform administrative tasks. For more information, see • A display area in which you can view and create dashboards and reports. • An action panel that: ▪ Lists the following topics: • Glossary • Prerequisites • Overviewvarious actions that you can perform on the dashboard that is currently displayed. ▪ Contains views and data that can be added to a dashboard or report that you are creating. ▪ Provides access to the online help.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference User Guide Updated - November 2018 December 2017 Software Version - 5.9.x 5.9.2 Getting Started Glossary with Foglight 6 Prerequisites Getting Started 6 Overview Logging in to Foglight 6 Starting from the Welcome Page 7 REST APIs App Navigating Foglight 8 Using the Navigation Panel 8 Using the Breadcrumb Trail 9 Using Drilldowns 9 Using Bookmarks 9 Opening a New Window 10 APP — Get App Running a Report 10 Choosing a Home Page 10 Getting Started FAQ 11 Working with Dashboards 11 Viewing, Acknowledging, and Clearing Alarms 46 Viewing Alarms 47 Filtering the Alarm List 47 Viewing Alarm Details 48 Acknowledging an Alarm 50 Clearing an Alarm 51 Monitoring Your Domains 52 Viewing detailed information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for domain or subdomain 52 Investigating Problems in a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current Domain 53 Investigating a Domain or Subdomain’s State 53 Investigating a Subdomain’s Health 53 Investigating a Subdomain’s Alarms 54 Investigating Problems with a Subdomain’s Agents 54 Monitoring Your Services 55 Selecting the Services You Want to Monitor 56 Service Dependencies 56 Monitoring a Service 57 Investigating service level compliance and availability 57 Investigating alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances 58 Drilling down into a service 58 Viewing the state of and drilling down into a type 43 User Information 44 User Information — Get current user information 44 About Us We are tier 58 Viewing more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional details about your services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview59

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference User Guide Updated - November 2018 March 2017 Software Version - 5.9.x 5.7.5.8 Getting Started Glossary with Foglight 6 Prerequisites Getting Started 6 Overview Logging in to Foglight 6 Starting from the Welcome Page 7 REST APIs App Navigating Foglight 8 Using the Navigation Panel 8 Using the Breadcrumb Trail 9 Using Drilldowns 9 Using Bookmarks 9 Opening a New Window 10 APP — Get App information Running a Report 10 Security Choosing a Home Page 10 Getting Started FAQ 11 Security — Login Working with Dashboards 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Foglight™ for OpenStack® User and Reference Guide Updated - November 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • OverviewApr 2017

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Upgrade Guide Updated - November July 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview Understand product versions 7 REST APIs App Components compatibility 7 Compatible cartridges list 7 Foglight cartridge upgrade issues 9 Foglight appliance upgrade issues 9 Best practices 10 APP Foglight Management Server 11 Foglight Agent Manager 11 Embedded Agent Manager 11 Agent Manager client installation cartridges 11 Client-side Agent Managers 11 Application Monitoring cartridges 12 Application Performance Monitoring cartridges 12 Application Management cartridges 13 Database cartridges 14 Foglight for DB2 LUW 14 Foglight for Oracle 14 Foglight for SQL Server 14 Foglight for Sybase 15 End User Management cartridges 15 End User cartridges 15 Infrastructure Management cartridges 15 Foglight for Infrastructure 16 Foglight for Active Directory 16 Foglight for Apache 16 Foglight for Exchange 16 Foglight Net Monitor 16 Foglight for PowerVM 17 Foglight for SNMP 17 Foglight Web Monitor 17 Integration cartridges 17 Foglight for Integration 17 Foglight for NMS Integration 17 Virtualization cartridges 18 Foglight Experience Monitor appliance 18 Foglight Experience Viewer appliance 18 Upgrade use cases 18 Scenario 1 — Get App information 10 Security 11 Security New release 19 Scenario 2 — Login 11 Security New Management Server features or defect fixes 19 Scenario 3 — Logout 12 Security — Set Auth Token Agent Manager client-side feature dependency or defect fix 19 Dependency and compatibility matrices 19 Prepare for an upgrade 24 Migrate to Windows SSO from VSJ SSO 26 Upgrade the Management Server 27 Host services compatibility 30 Start the embedded Agent Manager 30 Upgrade a given user 12 Security — Delete Auth Token Management Server in a federated environment 30 Upgrade the Management Server in a High Availability (HA) environment 31 Upgrade the Management Server with an Oracle RAC database 31 Oracle database users 32 Database changes 32 Upgrade the Foglight Agent Manager 34 Upgrade the Agent Manager 34 Upgrade concentrators 35 Upgrade installations with multiple state instances 35 Upgrade a 32-bit FglAM installation on a 64-bit operating system 36 Agent Manager upgrade issues 36 FglAM vm.config file migration fails under multi-state installations 36 Upgrade from an Agent Manager version earlier than 5.5.4 37 Certificate migration from version 5.6.2.1 or earlier 37 Upgrade the Application Monitoring cartridges 39 Upgrade the Application Performance Monitoring cartridges 39 Upgrade Foglight for Application Operations 39 Upgrade Foglight for Java EE Technologies 40 Upgrade Foglight for JMX 42 Upgrade Foglight for Microsoft .NET 42 Upgrade the Application Management cartridges 44 Upgrade Foglight for IBM WebSphere MQ Server 44 Upgrade Foglight for PeopleSoft 45 Upgrade Foglight for Siebel 47 Upgrade Foglight PagerDuty Integration 47 Upgrade the Database cartridges 49 Upgrade the Cartridge for DB2 LUW 49 Upgrade Foglight for DB2 LUW 49 Upgrade Foglight for Oracle 50 Upgrade Foglight for SQL Server 50 Upgrade Foglight for Sybase 51 Upgrade the End User Management cartridges 53 Upgrade End User cartridges 53 Upgrade the End User cartridges 53 Using the Agent Manager with FTR agents 56 Upgrade Foglight for Hyper-V 65 Upgrade Foglight Net Monitor 66 Upgrade Foglight Integration for OpenManage Essentials 66 Upgrade Foglight for OpenStack 66 Upgrade Foglight for PowerVM 67 Upgrade Foglight Resource Optimizer 68 Upgrade Foglight for SNMP 70 Upgrading Foglight for Storage Management cartridge 71 Upgrade Foglight Web Monitor 72 Upgrade Foglight for VMware 72 Upgrade Foglight for VMware Horizon View 73 Upgrade Foglight for Citrix XenDesktop and XenApp 75 Upgrade the Integration cartridges 76 Upgrade Foglight for Integration 76 Upgrade Foglight for NMS Integration 76 Upgrade the cartridges in a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 federated or High Availability (HA) environment 77 Upgrade cartridges in a federated environment 77 Upgrade cartridges in a High Availability environment 78 Appendix: Deploying an agent package using the browser interface 79 Deploying an agent package through the Agent 14 Managers dashboard 79 Deploying an agent package through the Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Status dashboard 80 About Us 81 We are more than just a name 45 81 Our brand, our vision. Together 45 81 Contacting Quest 45 81 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview81 Understand product versions‌

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Change Analyzer User and Reference Guide Updated - November 2018 Software April 2022 Foglight Version - 5.9.x Getting Started Glossary 6.1.0 Cartridge Version - 6.1.0 Get started with Foglight Change Analyzer 6 Prerequisites Installation requirements 6 Overview Credentials requirements 7 REST APIs App Data collection 7 Dashboard location 7 Navigation basics 8 Interact with Foglight Change Analyzer 9 Change Summary 10 APP — Get App information 10 Security Analyze Changes 11 Security — Login 11 Security — Logout VM Performance 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user Impact Analysis 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms VM Configuration Comparison 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms Change History 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties Users and Permissions 22 Alarm — Push alarms by query Settings 23 Cartridge — Get all cartridges’ data Scheduled Actions 23 Cartridge — Get all core cartridges’ data Change Alarms 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule Highest Impact Changes 26 Rule — Get all rules’ data 26 Rule — Get rule by id Reference 27 Script Analyze Changes view 27 Script — Publish custom REST API Purpose 27 Description of view elements 27 Change Summary view 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID Purpose 29 Description of view elements 32 Subscribe alarm — Subscribe all alarms Change History view 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value Purpose 34 Topology — Get topology object by id Description of view elements 34 Impact Analysis view 35 Topology — Get topology object by ids Purpose 35 Topology — Observations query Description of view elements 36 Topology — TopologyObject query 37 Topology — Push data Users and Permissions view 38 TopologyType Purpose 38 Description of view elements 38 VM Configuration Comparison view 39 Purpose 39 Description of view elements 39 VM Performance view 41 Purpose 41 Description of view elements 41 Foglight Change Analyzer reports 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 44 Our brand, our vision. Together 45 44 Contacting Quest 45 44 Technical support resources 45 Getting Started‌ The 44 Get started with Foglight REST API is an application programming interface (API) that uses HTTP requests Change‌ Analyzer Foglight® Change Analyzer allows you to GETtrack changes in your virtual environment and understand their potential impact on performance and availability. It captures and reports on changes to VMs, PUThosts, POSTclusters, datastores, and DELETE dataresource pools within a selected environment. The It also allows you to compare VMs to a “gold standard” VM or template and alerts you when changes cause their configurations to drift from the standard. This guide provides information about Foglight REST API Reference Guide Change Analyzer. Read it to acquire an overall understanding of the workings and capabilities of Foglight Change Analyzer and use it as a reference whenever you require specific information about this product. This guide is intended for users IT managers who have been assigned want to monitor virtual infrastructure changes and diagnose issues in the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systemsvirtual environment. This section introduces you to the Foglight REST APIsChange Analyzer environment, and provides you with essential foundational information. To get started with Foglight Change Analyzer see these topics: • Installation requirements • Credentials requirements • Data collection • Dashboard location • Navigation basics This version of Foglight Change Analyzer works with Foglight for VMware. Support for additional virtualization environments will be added in future releases. For more informationdetailed information about the Foglight VMware® environment, see the Foglight for VMware User and Reference Guide. Installation requirements‌ Foglight Change Analyzer comes installed on Foglight for Virtualization, Enterprise Edition or Foglight Evolve and can be installed on a Foglight Management Server. Foglight Change Analyzer requires the following topicscartridges for data collection: • Glossary • Prerequisites • Overview1 vUsage-Feedback-5_8_0.xxx

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Foglight™ Change Analyzer User and Reference Guide Updated - November 2018 April 2017 Software Version - 5.9.x Getting Started Glossary 5.7.3 Get started with Foglight Change Analyzer 6 Prerequisites Installation requirements 6 Overview Credentials requirements 7 REST APIs App Data collection 7 Dashboard location 7 Navigation basics 8 Interact with Foglight Change Analyzer 9 Change Summary 10 APP — Get App information 10 Security Analyze Changes 11 Security — Login 11 Security — Logout VM Performance 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user Impact Analysis 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms VM Configuration Comparison 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms Change History 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties Users and Permissions 22 Alarm — Push alarms by query Settings 23 Cartridge — Get all cartridges’ data Scheduled Actions 23 Cartridge — Get all core cartridges’ data Change Alarms 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule Highest Impact Changes 26 Rule — Get all rules’ data 26 Rule — Get rule by id Reference 27 Script Analyze Changes view 27 Script — Publish custom REST API Purpose 27 Description of view elements 27 Change Summary view 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID Purpose 29 Description of view elements 32 Subscribe alarm — Subscribe all alarms Change History view 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value Purpose 34 Topology — Get topology object by id Description of view elements 34 Impact Analysis view 35 Topology — Get topology object by ids Purpose 35 Topology — Observations query Description of view elements 36 Topology — TopologyObject query 37 Topology — Push data Users and Permissions view 38 TopologyType Purpose 38 Description of view elements 38 VM Configuration Comparison view 39 Purpose 39 Description of view elements 39 VM Performance view 41 Purpose 41 Description of view elements 41 Foglight Change Analyzer reports 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 44 Our brand, our vision. Together 45 44 Contacting Quest 45 44 Technical support resources 45 Getting Started‌ The 44 Get started with Foglight REST API is an application programming interface (API) that uses HTTP requests Change‌ Analyzer Foglight™ Change Analyzer allows you to GETtrack changes in your virtual environment and understand their potential impact on performance and availability. It captures and reports on changes to VMs, PUThosts, POSTclusters, datastores, and DELETE dataresource pools within a selected environment. The It also allows you to compare VMs to a “gold standard” VM or template and alerts you when changes cause their configurations to drift from the standard. This guide provides information about Foglight REST API Reference Guide Change Analyzer. Read it to acquire an overall understanding of the workings and capabilities of Foglight Change Analyzer and use it as a reference whenever you require specific information about this product. This guide is intended for users IT managers who have been assigned want to monitor virtual infrastructure changes and diagnose issues in the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systemsvirtual environment. This section introduces you to the Foglight REST APIsChange Analyzer environment, and provides you with essential foundational information. To get started with Foglight Change Analyzer see these topics: • Installation requirements • Credentials requirements • Data collection • Dashboard location • Navigation basics This version of Foglight Change Analyzer works with Foglight for VMware. Support for additional virtualization environments will be added in future releases. For more informationdetailed information about the Foglight VMware® environment, see the Foglight for VMware User and Reference Guide. Installation requirements‌ Foglight Change Analyzer comes installed on Foglight for Virtualization, Enterprise Edition and can be installed on a Foglight Management Server. Foglight Change Analyzer requires the following topicscartridges for data collection: • Glossary • Prerequisites • Overview1 DRP-5_7_0.xxx

Trademarks. Quest, the Quest logo, and Join the Innovation Where next meets now are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered registereMay 2021d trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API for Infrastructure User and Reference Guide Updated - November 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • OverviewApril 2022

Trademarks. Quest, the Quest logo, and Join the Innovation Where next meets now are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered registereMay 2021d trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API for Infrastructure User and Reference Guide Updated - November 2018 Software May 2021 Foglight Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 6.0.0 Cartridge Version - 6.0.0 Using Foglight for Infrastructure 7 REST APIs App Host availability alerting 7 Virtual hosts and reported metrics 8 Exploring the Infrastructure Environment dashboard 8 Accessing the Infrastructure dashboard 9 Selecting a service 9 Running a report for the Infrastructure Environment 9 Exploring the Monitoring tab 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token Exploring monitored hosts 14 Exploring the FAQ Question Viewer 16 Exploring the Administration tab 18 Using Foglight for Infrastructure agents 29 Configuring Multiple Instances for Monitoring using Silent Installation 30 Using the PowerVM HMC agent 32 Using the UnixAgentPlus 32 Monitoring remote hosts 32 Deploying Foglight for Infrastructure agents 33 Creating agent instances 33 Defining credentials 33 Activating the agent 34 Monitoring the infrastructure 34 Adding a monitored host 34 Adding multiple monitored hosts 43 About the WindowsAgent 49 Supported platforms 50 Agent properties 50 About the UnixAgentPlus 55 Supported platforms 56 Agent properties 56 About the UnixAgent 62 Supported platforms 62 Agent properties 62 About the MultiHostProcessMonitorAgent 68 Supported platforms 68 Agent properties 68 Monitoring log files with Foglight Log Monitor 73 Configuring monitoring agents 73 Investigating log records 77 Configuring agent properties 79 Configuring File Log Monitor agent properties 79 Configuring Windows Event Log Monitor agent properties 85 Configuring connections to remote Windows platforms 89 Foglight Log Monitor command shell types 89 Before you begin 92 Introducing the PowerVM infrastructure 92 Managing PowerVM HMC agents 93 Configuring HMC user accounts 93 Configuring PowerVM HMC agent credentials 93 Creating PowerVM HMC agents 94 Reviewing and editing PowerVM HMC agent properties 95 Monitoring your PowerVM environment 97 Exploring the Infrastructure Environment dashboard 97 Investigating the collective use of all HMC resources 103 Viewing HMC details 105 Identifying top consumers of managed server resources 106 Viewing individual managed server details 108 Identifying top consumers of PowerVM partition resources 110 Viewing individual PowerVM partition details 111 Identifying top consumers of PowerVM virtual I/O server resources 114 Viewing individual PowerVM VIOS details 115 Investigating additional managed server, partition, and VIOS details 117 Reviewing frequently asked questions 139 Advanced system configuration and troubleshooting 145 Advanced system configuration for WinRM 145 Adding a non-administrative user to user groups 145 Setting WinRM RootSDDL for a given non-administrative user 12 Security — Delete Auth Token 146 Granting permission to the namespace 147 Granting permission to the service 147 Additional WinRM configuration in FIPS-compliant mode 148 Configuring default local user credentials for a given user 13 Security — Set Auth Token Infrastructure Agents 149 Reference 153 Foglight for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get Infrastructure views 153 Quick View 153 Summary view 154 Resource Utilizations view 156 Host Monitor views 158 Processes views 162 Foglight Log Monitor views 164 Rules 168 Metrics 168 AIX metrics 168 HP-UX metrics 169 Linux metrics 170 Solaris metrics 171 Windows metrics 172 AIXUsedMemoryDetails topology object current alarms 20 Alarm — Get 174 CPUCounts topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get 174 Host topology object by id 35 Topology — Get 175 HostCPUs topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type 177 HostNetwork topology object 178 HostProcess topology object 180 HostProcessInstance topology object 182 HostService topology object 184 HostTopProcessEntry topology object 185 LPARNetworkInterfaceDetails topology object 185 LPARPhysicalDiskDetails topology object 185 LogicalDisk topology object 186 MSCluster topology object 188 MSClusterNode topology object 189 MSClusterResource topology object 189 MSClusterResourceGroup topology object 189 MSHostedResourceGroup topology object 190 Memory topology object 190 NetworkInterface topology object 192 NetworkInterfaceDetails topology object 194 NixHostProcessInstance topology object 195 OperatingSystem topology object 195 PhysicalDisk topology object 196 PowerVMVIOS topology object 198 PowerVMVIOSCPUs topology object 199 PowerVMVIOSMemory topology object 200 PowerVMVIOSNetwork topology object 200 PowerVMVIOSStorage topology object 201 Processor topology object 201 WinHostProcessInstance topology object 203 Appendix: Building regular expressions in Foglight 204 What is a regular expression? 204 Where can I find regular expressions? 204 Regular expression basics 205 Building a simple pattern 206 Building a pattern that matches a specific character 207 Building a pattern that matches multiple characters 207 Using advanced quantifiers 207 Using special characters and regular expression flags 208 Grouping elements in a pattern 208 Additional information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 209 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 210 Technical support resources 45 Getting Started‌ The 210 Using Foglight REST API is an application programming interface (API) that uses HTTP requests for Infrastructure‌‌ This User and Reference Guide describes the dashboards included with Foglight for Infrastructure and contains instructions for configuring Foglight for Infrastructure Agents, used by the cartridge to GETmonitor the health of your system infrastructure. It also provides reference information about views, PUT, POSTrules, and DELETE datametrics that are included with Foglight for Infrastructure. The Foglight REST API Reference Guide This guide is intended for any user who wants to know more about the Agent properties and dashboards included with Foglight for Infrastructure. It is also meant for users who have been assigned want to learn about the API Access rules that are included with Foglight for Infrastructure, and the Administrator roles data collected by monitoring agents. Foglight Log Monitor is an Infrastructure utility shipped with Foglight. Foglight Log Monitor allows you to monitor the contents of the log files on your system and who need programmatic access to easily create professional services and better integrate with third-party systemsidentify activities that can lead to performance problems. Better management of your system can be achieved when you are alerted of potential problems before the system stability is affected. This section introduces ensures consistent performance of your system at established service levels. This guide describes the dashboards included with Foglight Log Monitor. Foglight for Infrastructure monitors your infrastructure environment and helps you analyze performance issues affecting various hosts. It may be used by itself to monitor physical hosts, or in combination with other agents to monitor virtual hosts. It contains the Foglight REST APIsfollowing major components: • Infrastructure Environment dashboard: provides a visual representation of the hosts being monitored in your environment. For more information, see Exploring the Infrastructure Environment dashboard. • Foglight for Infrastructure agents: collect information about the monitored hosts. Agents communicate with the Foglight Management Server using the Foglight Agent Manager. For more information, see: Using Foglight for Infrastructure agents, About the WindowsAgent, About the UnixAgentPlus, About the UnixAgent, and About the MultiHostProcessMonitorAgent. For more information about Foglight for Infrastructure, see the following topics: • Glossary Host availability alerting • Prerequisites Virtual hosts and reported metrics Host availability alerting‌ Foglight for Infrastructure 5.8.5.3 has changed the way it alerts users about host availability. It is now able to identify and report the following three states for a monitored host: • OverviewMONITORED. This is the default state. It is set on the Host object for each successful collection topology submission. • UNMONITORED. It is set on the Host object when the agent fails to authenticate, or is otherwise unable to connect to the monitored host. • UNAVAILABLE. It is set on the Host object when agent is configured to validate host availability with ping (by setting the Use ping to validate host availability property for that agent to “True”), and a ping command is unsuccessful. For details about configuring agent properties, see About the WindowsAgent, About the UnixAgentPlus, About the UnixAgent, and About the MultiHostProcessMonitorAgent.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference for NetVault User and Administration Guide Updated - November 2018 Software April 2022 Foglight Version - 5.9.x 6.1.0 Cartridge Version - 6.1.0 Understanding Foglight for NetVault 5 About Foglight for NetVault 5 Key benefits 5 Architecture 6 Getting Started Glossary 6 Prerequisites Creating a NetVault Agent 6 Overview Managing certificates 7 REST APIs App Configuring data collection interval 9 Heat Map Analytics 10 APP — Get App information Scatter Plot Analytics 10 Security Recommended additional reading 11 Security — Login 11 Security — Logout Using Foglight for NetVault 12 Security — Set Auth Token for a given user Monitoring NetVault Backup Servers 12 Security — Delete Auth Token for a given user Summary - All Servers view 12 Individual Server Summary view 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm Monitoring NetVault Backup Clients 17 Alarm — Acknowledge alarm by alarm ID Summary - All Clients view 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID Individual Client Summary view 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms Monitoring NetVault Backup Policies 19 Alarm — Get history alarms Summary - All Policies view 19 Alarm — Get topology object current alarms Individual Policy Summary view 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms Monitoring NetVault Backup Devices 21 Alarm — Push alarms by properties Summary - All Devices view 21 Individual Device Summary view 21 Viewing NetVault Backup Jobs 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us 23 We are more than just a name 45 23 Our brand, our vision. Together 45 23 Contacting Quest 45 23 Technical support resources 45 23 Understanding Foglight for NetVault‌ • About Foglight for NetVault • Key benefits • Architecture • Getting Started About Foglight for NetVault‌ Foglight® for NetVault®, by the means of NetVault Restful APIs, integrates Foglight for Virtualization Enterprise Edition (hereafter referred to as FVE) with the NetVault Server, and provides the following capabilities to effectively monitor large-scale NetVault deployments, including: • Monitor NetVault infrastructure, including the NetVault Server and its affiliated clients. • Provide and display a subset of status to FVE on demand, including Job status, Client status, Device/Storage status and statistics, and status of data being protected. • Show NetVault reports and alarm notifications. Key benefits‌ Foglight for NetVault offers these benefits for the customer environment: • Better status visibility and monitoring for the complete NetVault environment. • Single place to view the status and monitor multiple NetVault Servers and associated NetVault clients. • Consolidated views of what is protected in a NetVault environment. • Environment/equipment status and monitoring to help diagnose problems that can affect NetVault functionality and performance, especially where the cause of a problem is outside of NetVault control or visibility. • Collection and display of historical status, events, performance, logs, and so on. • More data and longer retention of data than what is stored by NetVault Servers. • Better analysis of issues that require some history of data, for example: ▪ Problems that were not noticed or reported until sometime after the occurrence. ▪ Problems that are developed over time. ▪ Problems that are sporadic or periodic. Architecture‌ Figure 1. Components of Foglight for NetVault Foglight for NetVault consists of three main components: • Foglight Management Server and Foglight Database Repository — Responsible for managing, alerting, and viewing the collected data. Both components can be set to run on the same machine or reside on separate machines. • Agent Manager — Hosts the monitoring NetVault agents. • NetVault Backup Server — Provides the core services for protecting your data and administers backup and restore jobs for all assigned clients. Various types of physical and virtual storage devices can be locally attached to the server. Getting Started‌ • Creating a NetVault Agent • Managing certificates • Configuring data collection interval • Heat Map Analytics • Scatter Plot Analytics • Recommended additional reading Creating a NetVault Agent‌ Each NetVault Agent monitors the assets inside the selected NetVault Backup environment. To enable the data collection for Foglight for NetVault, create a NetVault user with the “Monitor Presets” privilege, as well as grant this user with the access to the client groups and media groups that you want to monitor. NOTE: Make sure to assign the minimum required privilege to your NetVault agent and the agent user; otherwise this agent can not start data collection. 2 On the navigation panel, under Homes, click NetVault Environment. The Foglight REST API is an application programming interface (API) that uses HTTP requests to GETNetVault Environment dashboard opens. 3 In the NetVault Environment dashboard, PUT, POSTclick Administration, and DELETE datathen click Create Agent. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • OverviewNetVault Agent Wizard dialog box opens.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Chargeback User Guide Updated - November 2018 Software April 2017 Foglight Version - 5.9.x 5.7.5.8 Cartridge Version - 5.7.3 Using Foglight Chargeback 5 Foglight Chargeback Host Support 5 Understanding Chargeback Models 5 Tiered Flat Rate Model 5 Measured Resource Utilization Model 6 Add Ons Model 9 Chargeback Roles 10 Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout Workflow Basics 12 Security — Set Auth Token Exploring the Chargeback Dashboard 13 Summary View 13 Host Groups View 21 Tiered Flat Rate (TFR Assignments) View 24 Measured Resource Utilization (MRU Assignments) View 27 Add Ons View 30 Example Use Case for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID Chargeback 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us 38 We are more than just a name 45 38 Our brand, our vision. Together 45 38 Contacting Quest 45 38 Technical support resources 45 Getting Started‌ The 38 Using Foglight REST API Chargeback‌ Foglight™ Chargeback generates detailed reports on who spends what inside your IT infrastructure. You are an IT manager with hundreds, if not thousands of virtual machines (VM) or physical machines (PM) in your IT Infrastructure. Virtual machines can be added quickly and appear to be free of cost. As customers add workloads to their virtual environments, determining the true cost of each virtual machine is an application programming interface (API) that uses HTTP requests important component in managing server sprawl. As IT budgets become more constrained, chief information officers are asked to GETinform senior management what the IT infrastructure is actually costing, PUTbroken down by departments, POSTfor example, accounting and human resources. Organizations spend hundreds of thousands of dollars procuring high-end hosts, virtualization software, and DELETE datastorage area network (SAN) disk storage. IT finance needs a way to determine actual resource utilization and fairly charge internal departments for their system utilization. • Foglight Chargeback Host Support • Understanding Chargeback Models • Exploring the Chargeback Dashboard • Example Use Case for Chargeback Foglight Chargeback Host Support‌ Foglight™ Chargeback gathers data from both Hyper-V and VMware virtualization software. To gather data and build chargeback reports using Foglight Chargeback, you must install one or both of the following: • Foglight for VMware • Foglight for Hyper-V Understanding Chargeback Models‌ Foglight™ Chargeback supports industry standard models to determine IT infrastructure costs. These models provide IT managers with the ability to monitor and report the costs associated with host machine usage within data centers. Foglight Chargeback provides the following models: • Tiered Flat Rate Model on page 5 • Measured Resource Utilization Model on page 6 • Add Ons Model on page 9 Tiered Flat Rate Model‌ The Tiered Flat Rate chargeback model can be thought of as charging a flat rate for host machine cost. Another way to look at it would be your telephone bill. You are charged a flat rate to use the phone each month regardless of usage. A tier is a level of expense for a host machine. The Foglight REST API Reference Guide Tiered Flat Rate model divides IT costs into levels of expense. For example, an organization has decided to build a new virtual infrastructure, mandating that any new server Pros and Cons of Using the Tiered Flat Rate Model The Tiered Flat Rate model assesses costs as a monthly flat rate. As the costs are calculated in this manner, changes to tier definitions take place immediately and can be applied in a retroactive manner. For example, running a Tiered Flat Rate report with the tiers configured in different ways will generate different costs against the same historical time period. When using the Tiered Flat Rate model, a department is intended charged a flat rate for users who their tier of VMs (for example, Tier 1 is one vCPU, $100/month) and know what their costs will be each month. The drawback of using the Tiered Flat Rate model is getting departments to agree on tier rates. For example, if the VM is turned off, the department is still charged. Measured Resource Utilization Model‌ IMPORTANT: Measured Resource Usage Full and Partial Cost calculations begin initial generation of data after servers have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIstemplates. For more informationThese calculations are based on current usage assessments. The Measured Resource Usage costs are not retroactive. The historical data may not provide the precision needed to generate accurate hourly costs of the past usage. If any changes are made to a Measured Resource Usage Host Template, see the changes take effect in the costs on the next hourly calculation. These changes are not retroactive. The costs have already been calculated based on the previous configuration. The Measured Resource Utilization Model (MRU) can be thought of as the charges you would get from the power company; you are charged for what you use. With the MRU model, each VM is only charged for what it uses of its server's resources. MRU calculations are performed by determining each virtual machine's actual utilization and applying the appropriate cost-unit calculation for each resource based on the resource weighting configuration. The MRU model provides methods for calculating costs based on the following topicstypes of usage: • Glossary Full Cost Recovery on page 7 • Prerequisites • OverviewPartial Cost Recovery on page 7

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Creating Actions Field Guide Updated - November May 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview5.9.x

Trademarks. Quest, the Quest logo, and Join the Innovation Where next meets now are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Upgrade Guide Updated - November 2018 Software April 2022 Foglight Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 6.1.0 Understand product versions 7 REST APIs App Components compatibility 7 Compatible cartridges list 7 Foglight cartridge upgrade issues 9 Foglight appliance upgrade issues 9 Best practices 10 APP Foglight Management Server 11 Foglight Agent Manager 11 Embedded Agent Manager 11 Agent Manager client installation cartridges 11 Client-side Agent Managers 11 Application Monitoring cartridges 12 Application Performance Monitoring cartridges 12 Application Management cartridges 12 Database cartridges 13 Foglight for Azure SQL Database 13 Foglight for DB2 LUW 13 Foglight for Oracle 13 Foglight for SQL Server 13 Foglight for SAP ASE 13 End User Management cartridges 14 End User cartridges 14 Infrastructure Management cartridges 14 Foglight for Infrastructure 14 Foglight for Active Directory 15 Foglight for Exchange 15 Integration cartridges 15 Virtualization cartridges 15 Foglight Experience Monitor appliance 16 Foglight Experience Viewer appliance 16 Upgrade use cases 16 Scenario 1 — Get App New release 16 Scenario 2 — New Management Server features or defect fixes 17 Scenario 3 — Agent Manager client-side feature dependency or defect fix 17 Dependency and compatibility matrices 17 Prepare for an upgrade 20 Upgrade order 20 Where to find upgrade information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token 20 Update the Java Runtime Environment 21 Upgrade the Foglight Management Server 22 Migrate to Windows SSO from VSJ SSO 22 Upgrade a 32-bit FglAM installation on a 64-bit operating system 32 Agent Manager upgrade issues 32 FglAM vm.config file migration fails under multi-state installations 32 Upgrade from an Agent Manager version earlier than 5.5.4 33 Certificate migration from version 5.6.2.1 or earlier 33 Upgrade the Database cartridges 35 Upgrade Foglight for a given user 12 Security — Delete Auth Token DB2 LUW 35 Upgrade Foglight for a given user 13 Security — Set Auth Token Oracle 36 Upgrade Foglight for current user 13 Security — Delete Auth Token SQL Server 36 Upgrade Foglight for current user 14 SAP ASE 37 Upgrade Foglight for Azure SQL Database 38 Upgrading the Infrastructure Management cartridges 39 Upgrade Foglight for Active Directory 39 Upgrade Foglight for Exchange 40 Upgrade Foglight for Office 365 41 Upgrade Foglight for Infrastructure 42 Upgrade Foglight Change Analyzer 43 Upgrade Foglight for Hyper-V 43 Upgrade Foglight Resource Optimizer 44 Upgrade Foglight for Storage Management cartridge 46 Upgrade Foglight for VMware 47 Upgrade Foglight for VMware Horizon View 48 Upgrade Foglight for Citrix XenDesktop and XenApp 49 Upgrade Foglight for Container Management 50 Upgrade Foglight Hybrid Cloud Manager 51 Upgrade Foglight Capacity Director 52 Upgrade Foglight Cost Director 53 Upgrade Foglight Cloud Migration 53 Upgrade Quest Protect 54 Upgrade Foglight for vCloud Director 54 Upgrade Foglight for NetVault 55 Understand product versions‌ This guide provides instructions on how to upgrade to the latest version of the Foglight® Management Server and the Foglight Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all nonManager. This guide also provides upgrade instructions for the cartridges and cartridge-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We related components that are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The included with Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data6.1.0. The latest version of the Foglight REST API Reference Guide Management Server is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems6.1.0. This section introduces you to the Foglight REST APIs. For more informationprovides information about important changes made in this release, see the following topicsproduct versions, and components compatibility: • Glossary Components compatibility • Prerequisites • OverviewCompatible cartridges list Components compatibility‌‌

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Federation Field Guide Updated - November 2018 August 2017 Software Version - 5.9.x Getting Started Glossary 5.9.1 Federation overview 5 Use cases 5 Capabilities 6 Prerequisites 6 Overview Known issues 7 REST APIs App Requirements 8 Scalability expectations 9 Managing federation 10 APP — Get App information Understanding federation communication channels 10 Topology synchronization 10 Metric pull on demand 11 Alarm service communication channel 12 Planning for federation 13 Communication ports 13 HA considerations 14 Configuring a federated environment 14 Setting up a federated environment 14 Federation configuration changes 16 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for settings 17 Query limitations 18 Custom script queries 19 Upgrading cartridges on a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms federated system 19 Alarm — Get history alarms Selectively disabling federation services 19 Alarm — Get topology object current alarms Deploying cartridge components 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms Troubleshooting 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 Frequently asked questions 21 About Us 27 We are more than just a name 45 27 Our brand, our vision. Together 45 27 Contacting Quest 45 27 Technical support resources 45 Getting Started‌ The 27 Federation overview‌ Federation is a Foglight™ feature that addresses the needs of customers who monitor large-scale environments that are naturally partitioned into logical units. Each partition is traditionally served by one Foglight REST API is Management Server instance and its distributed clients/agents. This document presents an application programming interface (API) that uses HTTP requests to GET, PUT, POST, overview of the federation feature and DELETE dataprovides guidelines for configuring Federation Masters and Federated Children. The Foglight REST API Reference Guide intended audience for this document is intended for users who have been assigned the API Access and Quest SC/PSO (System Consultant/Professional Services Organization) personnel working in the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systemsfield. This section introduces you to describes a number of cases where the Foglight REST APIsfederation feature is used. For more informationIn addition, see a list of federation capabilities, known issues, and requirements are provided. • Use cases • Capabilities • Known issues • Requirements • Scalability expectations Use cases‌ Federation enables the use of one Foglight™ Management Server to operate, while using other Management Servers as the data source. As illustrated in the following topics: • Glossary • Prerequisites • Overviewfigure, a Foglight user can visualize the data from one or more stand-alone Management Servers (the Federated Children) from a single, central Management Server (the Federation Master). This allows users to meet both local and central monitoring requirements.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365, SharePoint, Silverlight, SQL Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Foglight™ Change Analyzer User and Reference Guide Updated - November 2018 April 2017 Software Version - 5.9.x Getting Started Glossary 5.7.3 Get started with Foglight Change Analyzer 6 Prerequisites Installation requirements 6 Overview Credentials requirements 7 REST APIs App Data collection 7 Dashboard location 7 Navigation basics 8 Interact with Foglight Change Analyzer 9 Change Summary 10 APP — Get App information 10 Security Analyze Changes 11 Security — Login 11 Security — Logout VM Performance 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user Impact Analysis 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms VM Configuration Comparison 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms Change History 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties Users and Permissions 22 Alarm — Push alarms by query Settings 23 Cartridge — Get all cartridges’ data Scheduled Actions 23 Cartridge — Get all core cartridges’ data Change Alarms 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule Highest Impact Changes 26 Rule — Get all rules’ data 26 Rule — Get rule by id Reference 27 Script Analyze Changes view 27 Script — Publish custom REST API Purpose 27 Description of view elements 27 Change Summary view 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID Purpose 29 Description of view elements 32 Subscribe alarm — Subscribe all alarms Change History view 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value Purpose 34 Topology — Get topology object by id Description of view elements 34 Impact Analysis view 35 Topology — Get topology object by ids Purpose 35 Topology — Observations query Description of view elements 36 Topology — TopologyObject query 37 Topology — Push data Users and Permissions view 38 TopologyType Purpose 38 Description of view elements 38 VM Configuration Comparison view 39 Purpose 39 Description of view elements 39 VM Performance view 41 Purpose 41 Description of view elements 41 Foglight Change Analyzer reports 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 44 Our brand, our vision. Together 45 44 Contacting Quest 45 44 Technical support resources 45 Getting Started‌ The 44 Get started with Foglight REST API is an application programming interface (API) that uses HTTP requests Change‌ Analyzer Foglight™ Change Analyzer allows you to GETtrack changes in your virtual environment and understand their potential impact on performance and availability. It captures and reports on changes to VMs, PUThosts, POSTclusters, datastores, and DELETE dataresource pools within a selected environment. The It also allows you to compare VMs to a “gold standard” VM or template and alerts you when changes cause their configurations to drift from the standard. This guide provides information about Foglight REST API Reference Guide Change Analyzer. Read it to acquire an overall understanding of the workings and capabilities of Foglight Change Analyzer and use it as a reference whenever you require specific information about this product. This guide is intended for users IT managers who have been assigned want to monitor virtual infrastructure changes and diagnose issues in the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systemsvirtual environment. This section introduces you to the Foglight REST APIsChange Analyzer environment, and provides you with essential foundational information. To get started with Foglight Change Analyzer see these topics: • Installation requirements • Credentials requirements • Data collection • Dashboard location • Navigation basics This version of Foglight Change Analyzer works with Foglight for VMware. Support for additional virtualization environments will be added in future releases. For more informationdetailed information about the Foglight VMware® environment, see the Foglight for VMware User and Reference Guide. Installation requirements‌ Foglight Change Analyzer comes installed on Foglight for Virtualization, Enterprise Edition and can be installed on a Foglight Management Server. Foglight Change Analyzer requires the following topicscartridges for data collection: • Glossary • Prerequisites • Overview1 DRP-5_7_0.xxx

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference for Capacity Management User Guide Updated - November 2018 Software April 2017 Foglight Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 5.7.5.8 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • OverviewVersion - 5.6.15.4

Trademarks. Quest, the Quest logo, and Join the Innovation Where next meets now are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Upgrade Guide Updated - November 2018 October 2021 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 6.0.0 Understand product versions 7 REST APIs App Components compatibility 7 Compatible cartridges list 7 Foglight cartridge upgrade issues 9 Foglight appliance upgrade issues 9 Best practices 10 APP Foglight Management Server 11 Foglight Agent Manager 11 Embedded Agent Manager 11 Agent Manager client installation cartridges 11 Client-side Agent Managers 11 Application Monitoring cartridges 12 Application Performance Monitoring cartridges 12 Application Management cartridges 12 Database cartridges 13 Foglight for Azure SQL Database 13 Foglight for DB2 LUW 13 Foglight for Oracle 13 Foglight for SQL Server 13 Foglight for SAP ASE 13 End User Management cartridges 14 End User cartridges 14 Infrastructure Management cartridges 14 Foglight for Infrastructure 14 Foglight for Active Directory 15 Foglight for Exchange 15 Integration cartridges 15 Virtualization cartridges 15 Foglight Experience Monitor appliance 16 Foglight Experience Viewer appliance 16 Upgrade use cases 16 Scenario 1 — Get App New release 16 Scenario 2 — New Management Server features or defect fixes 17 Scenario 3 — Agent Manager client-side feature dependency or defect fix 17 Dependency and compatibility matrices 17 Prepare for an upgrade 20 Upgrade order 20 Where to find upgrade information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token 20 Update the Java Runtime Environment 21 Upgrade the Foglight Management Server 22 Migrate to Windows SSO from VSJ SSO 22 Upgrade a 32-bit FglAM installation on a 64-bit operating system 32 Agent Manager upgrade issues 32 FglAM vm.config file migration fails under multi-state installations 32 Upgrade from an Agent Manager version earlier than 5.5.4 33 Certificate migration from version 5.6.2.1 or earlier 33 Upgrade the Database cartridges 35 Upgrade Foglight for a given user 12 Security — Delete Auth Token DB2 LUW 35 Upgrade Foglight for a given user 13 Security — Set Auth Token Oracle 36 Upgrade Foglight for current user 13 Security — Delete Auth Token SQL Server 36 Upgrade Foglight for current user 14 SAP ASE 37 Upgrade Foglight for Azure SQL Database 38 Upgrading the Infrastructure Management cartridges 39 Upgrade Foglight for Active Directory 39 Upgrade Foglight for Exchange 40 Upgrade Foglight for Office 365 41 Upgrade Foglight for Infrastructure 42 Upgrade Foglight Change Analyzer 43 Upgrade Foglight for Hyper-V 43 Upgrade Foglight Resource Optimizer 44 Upgrade Foglight for Storage Management cartridge 46 Upgrade Foglight for VMware 47 Upgrade Foglight for VMware Horizon View 48 Upgrade Foglight for Citrix XenDesktop and XenApp 49 Upgrade Foglight for Container Management 50 Upgrade Foglight Hybrid Cloud Manager 51 Upgrade Foglight Capacity Director 52 Upgrade Foglight Cost Director 53 Upgrade Foglight Cloud Migration 53 Upgrade Quest Protect 54 Upgrade Foglight for vCloud Director 54 Upgrade Foglight for NetVault 55 Understand product versions‌ This guide provides instructions on how to upgrade to the latest version of the Foglight® Management Server and the Foglight Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all nonManager. This guide also provides upgrade instructions for the cartridges and cartridge-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We related components that are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The included with Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data6.0.0. The latest version of the Foglight REST API Reference Guide Management Server is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems6.0.0. This section introduces you provides information about important changes made in this release, product versions, and components compatibility: • Components compatibility • Compatible cartridges list Components compatibility‌‌ The Foglight 6.0.0 code line includes a number of critical changes which require particular attention for customers upgrading from a 5.7.x version. Specifically, three primary functional capabilities (server side data handling, Federation, High Availability) that used legacy JBoss components in versions prior to the 5.9.x have been re-written to improve Foglight REST APIsManagement Server security. For more information, see This has the following topics: • Glossary • Prerequisites • Overviewspecific impacts on customers upgrading from a 5.7.x version.

Trademarks. Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit xxxxx://xxx.xxxxx.xxx/legal/trademark-information.aspx. “Apache HTTP Server”, Apache, “Apache Tomcat” and “Tomcat” are trademarks of the Apache Software Foundation. Google is a registered trademark of Google Inc. Android, Chrome, Google Play, and Nexus are trademarks of Google Inc. Red Hat, JBoss, the JBoss logo, and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the U.S. and other countries. CentOS is a trademark of Red Hat, Inc. in the U.S. and other countries. Fedora and the Infinity design logo are trademarks of Red Hat, Inc. Microsoft, .NET, Active Directory, Internet Explorer, Hyper-V, Office 365Xxxxxx 000, SharePointXxxxxXxxxx, SilverlightXxxxxxxxxxx, SQL XXX Server, Visual Basic, Windows, Windows Vista and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. AIX, IBM, PowerPC, PowerVM, and WebSphere are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. Java, Oracle, Oracle Solaris, PeopleSoft, Siebel, Sun, WebLogic, and ZFS are trademarks or registered trademarks of Oracle and/or its affiliates in the United States and other countries. SPARC is a registered trademark of SPARC International, Inc. in the United States and other countries. Products bearing the SPARC trademarks are based on an architecture developed by Oracle Corporation. OpenLDAP is a registered trademark of the OpenLDAP Foundation. HP is a registered trademark that belongs to Hewlett-Packard Development Company, L.P. Linux is a registered trademark of Xxxxx Xxxxxxxx in the United States, other countries, or both. MySQL is a registered trademark of MySQL AB in the United States, the European Union and other countries. Novell and eDirectory are registered trademarks of Novell, Inc., in the United States and other countries. VMware, ESX, ESXi, vSphere, vCenter, vMotion, and vCloud Director are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions. Sybase is a registered trademark of Sybase, Inc. The X Window System and UNIX are registered trademarks of The Open Group. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. “Eclipse”, “Eclipse Foundation Member”, “EclipseCon”, “Eclipse Summit”, “Built on Eclipse”, “Eclipse Ready” “Eclipse Incubation”, and “Eclipse Proposals” are trademarks of Eclipse Foundation, Inc. IOS is a registered trademark or trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. Apple, iPad, iPhone, Mac OS, Safari, Swift, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Ubuntu is a registered trademark of Canonical Ltd. Symantec and Veritas are trademarks or registered trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. OpenSUSE, SUSE, and YAST are registered trademarks of SUSE LCC in the United States and other countries. Citrix, AppFlow, NetScaler, XenApp, and XenDesktop are trademarks of Citrix Systems, Inc. and/or one or more of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries. AlertSite and DéjàClick are either trademarks or registered trademarks of Boca Internet Technologies, Inc. Samsung, Galaxy S, and Galaxy Note are registered trademarks of Samsung Electronics America, Inc. and/or its related entities. MOTOROLA is a registered trademarks of Motorola Trademark Holdings, LLC. The Trademark BlackBerry Bold is owned by Research In Motion Limited and is registered in the United States and may be pending or registered in other countries. Quest is not endorsed, sponsored, affiliated with or otherwise authorized by Research In Motion Limited. Ixia and the Ixia four-petal logo are registered trademarks or trademarks of Ixia. Opera, Opera Mini, and the O logo are trademarks of Opera Software ASA. Tevron, the Tevron logo, and CitraTest are registered trademarks of Tevron, LLC. PostgreSQL is a registered trademark of the PostgreSQL Global Development Group. MariaDB is a trademark or registered trademark of MariaDB Corporation Ab in the European Union and United States of America and/or other countries. Vormetric is a registered trademark of Vormetric, Inc. Intel, Itanium, Pentium, and Xeon are trademarks of Intel Corporation in the U.S. and/or other countries. Debian is a registered trademark of Software in the Public Interest, Inc. OpenStack is a trademark of the OpenStack Foundation. Amazon Web Services, the “Powered by Amazon Web Services” logo, and “Amazon RDS” are trademarks of Xxxxxx.xxx, Inc. or its affiliates in the United States and/or other countries. Infobright, Infobright Community Edition and Infobright Enterprise Edition are trademarks of Infobright Inc. POLYCOM®, RealPresence® Collaboration Server, and RMX® are registered trademarks of Polycom, Inc. All other trademarks and registered trademarks are property of their respective WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. Foglight REST API Reference Guide Updated - November 2018 Software Version - 5.9.x Getting Started Glossary 6 Prerequisites 6 Overview 7 REST APIs App 10 APP — Get App information 10 Security 11 Security — Login 11 Security — Logout 12 Security — Set Auth Token for a given user 12 Security — Delete Auth Token for a given user 13 Security — Set Auth Token for current user 13 Security — Delete Auth Token for current user 14 Agent 14 Agent — Get agent by agent ID 15 Agent — Get all active agents 15 Agent — Get all agents 16 Agent — Get all inactive agents 16 Alarm 17 Alarm — Acknowledge alarm by alarm ID 17 Alarm — Clear alarm by alarm ID 17 Alarm — Get alarm by alarm ID 18 Alarm — Get alarm by rule ID 18 Alarm — Get current alarms 19 Alarm — Get history alarms 19 Alarm — Get topology object current alarms 20 Alarm — Get topology object history alarms 20 Alarm — Push alarms 21 Alarm — Push alarms by properties 22 Alarm — Push alarms by query 23 Cartridge — Get all cartridges’ data 23 Cartridge — Get all core cartridges’ data 24 Cartridge — Get all non-core cartridges’ data 24 Registry 25 Registry — Get all registries’ data 25 Remote client 25 Remote client — Get all remote clients’ data 25 Rule 26 Rule — Get all rules’ data 26 Rule — Get rule by id 27 Script 27 Script — Publish custom REST API 28 Script — Run named scripts 30 Subscribe alarm 31 Subscribe alarm — Disconnect SSE 31 Subscribe alarm — List SSE 31 Subscribe alarm — Subscribe alarms by object ID 32 Subscribe alarm — Subscribe all alarms 33 Topology 33 Topology — Get properties’ value 33 Topology — Get property value 34 Topology — Get topology object by id 35 Topology — Get topology object by ids 35 Topology — Observations query 36 Topology — TopologyObject query 37 Topology — Push data 38 TopologyType 42 TopologyType — Get type information 42 TopologyType — Get type super type’s information 43 TopologyType — Get all instances of a type 43 User Information 44 User Information — Get current user information 44 About Us We are more than just a name 45 Our brand, our vision. Together 45 Contacting Quest 45 Technical support resources 45 Getting Started‌ The Foglight REST API is an application programming interface (API) that uses HTTP requests to GET, PUT, POST, and DELETE data. The Foglight REST API Reference Guide is intended for users who have been assigned the API Access and the Administrator roles and who need programmatic access to easily create professional services and better integrate with third-party systems. This section introduces you to the Foglight REST APIs. For more information, see the following topics: • Glossary • Prerequisites • Overview.