6.1
Table Of Contents
- Endpoint Operations Management Agent Plug-in Development Kit
- Contents
- About the Endpoint Operations Management Agent Plug-in Development Kit
- Introduction to Plug-in Development
- The Role of the Server and Agent in Plug-ins
- Technical Overview
- Plug-in Implementations
- Using Support Classes to Simplify a Plug-in
- Writing Plug-ins
- JMX Plug-in
- Script Plug-ins
- SNMP Plug-in
- JMX-Based Management
- Auto-Discovery of JMX Resources
- Configuration Properties for JMX Monitoring
- Creating a Custom JMX Plug-in
- Defining Service Types to Provide Management via Custom MBeans
- Defining an ObjectName to Access Custom MBeans
- Defining Configuration Properties to Appear in the User Interface
- Defining and Gathering Metrics
- Specifying the Availability Metric for MBeans
- Implementing Control Actions
- Defining the Server Auto-Inventory Element
- Discovering Custom Properties
- Running and Testing Plug-ins from the Command Line
- Using Auto-Discovery Support Classes in Plug-ins
- Working with Plug-in Descriptors
- Plug-In Support Classes
- Index
Supported Element Relationships Element Structures for Various Object Hierarchies
<plugin>
<filter>
<property>
<config>
<option>
<properties>
<help>
<metrics>
<script>
<classpath>
<platform>
<filter>
<property>
<config>
<properties>
<plugin>
<help>
<metrics>
<metric>
<actions>
<classpath>
<script>
<server>
<filter>
<property>
<config>
<option>
<properties>
<plugin>
<help>
<metrics>
<metric>
<actions>
<scan>
<service>
<filter>
<property>
<config>
<option>
<properties>
<plugin>
<help>
<metrics>
<metric>
<actions>
<server>
<service>
<service>
.....
NOTE Server Object - Service Object
Most Endpoint Operations Management plug-ins manage a server object and the
service objects that it contains. The <server> element is the root of the plug-in and
contains a <service> element for each of the service objects that the plug-in
manages. The descriptor for a plug-in that manages multiple versions of a server
object, for example the plug-in for Tomcat 5.5 and 6.0, defines a <server> -
<service> hierarchy for each.
<plugin> (root)
<server>
<service>
<server>
<service>
NOTE Platform Object - Platform Service Object
Non-typical
The system plug-in manages all of the Endpoint Operations Management
supported OS platform objects, and the service objects that run on each platform.
The plug-in descriptor defines a <platform> - <service> hierarchy for each OS
platform object.
<plugin>
<platform>
<service>
.....
<platform>
<service>
.....
NOTE Platform Object - Server Object - Service Object
Non-typical
This structure is valid but uncommon. The only Endpoint Operations Management
plug-ins that manage platform-server-service objects are plug-ins that manage
virtual platform objects.
<plugin>
<platform>
<server>
<service>
NOTE Platform Service Object
If a plug-in manages only a platform service object, the <service> element
appears in the root of the plug-in.
<plugin>
<service>
Functionality of Plug-in Descriptor Elements
The hq-plugin.xml defines the plugin. It defines what the plug-in does and how, including which metrics to
collect, the units of measurement, the type of metric, and other attributes that characterize metric nature and
behavior.
In addition, the xml defines one or more management functions and the class or script that runs each of
them. It also defines the resource data that the plug-in uses, and related user interface behaviors including
whether and where resource properties are displayed in the user interface, defaults and permissible values
for configurable data, and so on.
Chapter 3 Working with Plug-in Descriptors
VMware, Inc. 49