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
Syntax for the metric Method When Using a Resource Properties File
The syntax for running the metric method using a properties file to supply resource configuration data is as
follows.
java -jar bundles/agent-VERSION/pdk/lib/dcs-tools-pdk-VERSION.jar -m metric plugin-
properties/ResourceTypeDirectory/ResourceName.properties -a translate -Dmetric-collect=default -
Dmetric-indicator=true -Dmetric-cat=CATEGORY -Dmetric-iter=ITERATIONS
Argument Description
plugin-
properties/ResourceTypeDirectory/ResourceName.properties
The path to the file generated when the
resource was discovered using the
properties action of the discover method.
The properties file provides the values for:
n
-p PluginName: the product portion of
the plug-in name.
n
-t ResourceType: the object type name
n
The value of the configuration options for
the object
-a translate
Causes metric templates, but not metric
values, to be returned.
If -a translate is not specified, both metric
templates and metric values are returned
You can also use one of the following arguments to limit the metrics that are returned. If you do not use one
of these arguments, all metrics are returned.
Argument Description
-Dmetric-collect=default This option limits the results to metrics that have the defaultOn attribute set to true.
-Dmetric-indicator=true This option limits the results to metrics that have the indicator attribute set to true
-Dmetric-cat=CATEGORY
This option limits the results to metrics of a specific category.
The categories are AVAILABILITY, UTILIZATION, THROUGHPUT, and PERFORMANCE.
-Dmetric-iter=ITERATIONS
This option causes the time (in milliseconds) to collect a metric repeatedly to be reported,
rather than the metric value..
Syntax for the metric Method that Specifies Configuration Data on Command Line
The syntax for running the metric method that supplies resource configuration data on the command line
data is as follows.
java -jar bundles/agent-VERSION/pdk/lib/dcs-tools-pdk-VERSION.jar -m metric -p PluginName -t
ResourceType -a translate -Dmetric-collect=default -Dmetric-indicator=true -Dmetric-cat=CATEGORY
-Dmetric-iter=ITERATIONS -DOption=Value
Argument Description
-p PluginName
Specifies the product portion of the plug-in name.
-t ResourceType
Specifies the resource type name.
-a translate
Causes metric templates, but not metric values, to be returned.
If -a translate is not specified, both metric templates and metric values are returned
Optionally, one of the following options is also specified, to limit the metrics that are returned. If you do not
specify one of these options, all metrics are returned.
Endpoint Operations Management Agent Plug-in Development Kit
32 VMware, Inc.