Endpoint Operations Management Agent Plug- in Development Kit vRealize Operations Manager 6.5 VmWare
Endpoint Operations Management Agent Plugin Development Kit vRealize Operations Manager 6.5
Endpoint Operations Management Agent Plug-in Development Kit ou can find the most up-to-date technical documentation on the VMware website at https://docs.vmware.com If you have comments about this docu submit your feedback to docfeedh VMware Inc 3401 Hillview Palo Alto, CA 94304 ww. vmware. com Copyright. 2018 VMware, Inc. All rights reserved. Copyright and trademark information re. Inc
Endpoint Operations Management Agent Plug-in Development Kit VMware, Inc. 2 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have comments about this documentation, submit your feedback to docfeedback@vmware.com Copyright © 2018 VMware, Inc. All rights reserved. Copyright and trademark information. VMware, Inc. 3401 Hillview Ave. Palo Alto, CA 94304 www.vmware.com
Contents About the Endpoint Operations Management Agent Plug-in Development Kit 4 Introduction to Plug-in Development 5 The Role of the Server and Agent in Plug-ins 5 Technical Overview 6 Plug-in Implementations 6 Using Support Classes to Simplify a Plug-in 6 Writing Plug-ins 7 Running and Testing Plug-ins from the Command Line 26 2 Using Auto-Discovery Support Classes in Plug-ins 41 Auto-Discovery Classes 41 Auto-Discovery Interfaces 42 Specifying Auto-Discovery Implementation for a Resource Type 43 Measurement Plug-ins 44 3 Working with Plug-in Descriptors 50 Hierarchy of Managed Object Types 50 Management Functions and Classes for Object Types 51 Inventory and Configuration Data for Object Types 51 Metrics to Collect for Each Object Type 51 Structure of a Plug-in Descriptor 51 Functionality of Plug-in Descriptor Elements 53 4 Plug-In Support Classes 55 Auto-Discovery Support Classes 55 Measurement Support Classes 70 ProductPlugin Class 73 Server Resource Class 73 Service Resource class 8 Config Response Class 80
Contents About the Endpoint Operations Management Agent Plug-in Development Kit 4 1 Introduction to Plug-in Development 5 The Role of the Server and Agent in Plug-ins 5 Technical Overview 6 Plug-in Implementations 6 Using Support Classes to Simplify a Plug-in 6 Writing Plug-ins 7 Running and Testing Plug-ins from the Command Line 26 2 Using Auto-Discovery Support Classes in Plug-ins 41 Auto-Discovery Classes 41 Auto-Discovery Interfaces 42 Specifying Auto-Discovery Implementation for a Resource Type 43 Measurement Plug-ins 44 3 Working with Plug-in Descriptors 50 Hierarchy of Managed Object Types 50 Management Functions and Classes for Object Types 51 Inventory and Configuration Data for Object Types 51 Metrics to Collect for Each Object Type 51 Structure of a Plug-in Descriptor 51 Functionality of Plug-in Descriptor Elements 53 4 Plug-In Support Classes 55 Auto-Discovery Support Classes 55 Measurement Support Classes 70 ProductPlugin Class 73 ServerResource Class 73 ServiceResource Class 80 ConfigResponse Class 80 VMware, Inc. 3
About the Endpoint Operations Management Agent Plug-in Development Kit The Endpoint Operations Management Agent Plug-in Development Kit documents the XML plug-in descriptor that is the basis of every plug-in Endpoint Operations Management supports classes for auto- discovery, measurement, control, and other management functions. It provides information about developing VMware vRealize Operations Manager product plug-ins to manage new object types Intended audience This information is intended for developers who build or customize plug-ins VMware Technical Publications Glossary VMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitions of terms as they are used in VMware technical documentation, go to http://www.vmware.com/support/pubs
About the Endpoint Operations Management Agent Plug-in Development Kit The Endpoint Operations Management Agent Plug-in Development Kit documents the XML plug-in descriptor that is the basis of every plug-in. Endpoint Operations Management supports classes for autodiscovery, measurement, control, and other management functions. It provides information about developing VMware vRealize Operations Manager product plug-ins to manage new object types. Intended Audience This information is intended for developers who build or customize plug-ins. VMware Technical Publications Glossary VMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitions of terms as they are used in VMware technical documentation, go to http://www.vmware.com/support/pubs. VMware, Inc. 4
Introduction to Plug-in Development Plug-ins are the interface between vRealize Operations Manager and products on the network you want to manage You can develop your own plug-ins to extend the functionality of vRealize Operations Manager coverage to products or parts of products not yet covered. For information about the Endpoint Operations Management source code and the plug-ins provided by VMware, see https://github.com/vmware/ep-ops-management What Plug-ins Do Plug-in development requires an understanding of the vRealize Operations Manager inventory model and of the management functions that plug- ins implement. Management functions can include Auto-Discovery Plug-ins can implement auto-discovery of server resources, services resources, and application resources. Custom plug-ins usually just call the vRealize Operations Manager built-in ServerDetector class Monitoring Plug-ins can implement metric collection, defining and collecting metrics and configuring them for display in the vRealize Operations Manager user interface Measurement plug-ins implement monitoring You can use plug-ins discover, collect data from, and control resources; plug-ins cannot be used to change alerting, reporting, or similar, server-side functionality This chapter includes the following topics The Role of the Server and Agent in Plug-ins Technical Overview Plug-in Implementations sing Support Classes to Simplify a Plug-in Writing Plug-ins Running and Testing Plug-ins from the Command Line The role of the server and Agent in Plug-ins Plug-ins exist on the server and you can download them automatically to the agents
Introduction to Plug-in Development 1 Plug-ins are the interface between vRealize Operations Manager and products on the network you want to manage. You can develop your own plug-ins to extend the functionality of vRealize Operations Manager coverage to products or parts of products not yet covered. For information about the Endpoint Operations Management source code and the plug-ins provided by VMware, see https://github.com/vmware/ep-ops-management. What Plug-ins Do Plug-in development requires an understanding of the vRealize Operations Manager inventory model and of the management functions that plug-ins implement. Management functions can include: Auto-Discovery Plug-ins can implement auto-discovery of server resources, services resources, and application resources. Custom plug-ins usually just call the vRealize Operations Manager built-in ServerDetector class. Monitoring Plug-ins can implement metric collection, defining and collecting metrics and configuring them for display in the vRealize Operations Manager user interface. Measurement plug-ins implement monitoring. You can use plug-ins discover, collect data from, and control resources; plug-ins cannot be used to change alerting, reporting, or similar, server-side functionality. This chapter includes the following topics: n The Role of the Server and Agent in Plug-ins n Technical Overview n Plug-in Implementations n Using Support Classes to Simplify a Plug-in n Writing Plug-ins n Running and Testing Plug-ins from the Command Line The Role of the Server and Agent in Plug-ins Plug-ins exist on the server and you can download them automatically to the agents. VMware, Inc. 5