Overview of the API in Oracle Enterprise Manager Ops Center.
Oracle Enterprise Manager Ops Center APIs allow external systems management solutions to integrate with Oracle Enterprise Manager Ops Center. The APIs are available remotely using TCP/IP through the secure protocol, JMXRemoting over TLS.
The Oracle Enterprise Manager Ops Center Software Developer's Kit (SDK), which is shipped with the Oracle Enterprise Manager Ops Center software, includes some examples that show how to use the public APIs.
Procedure for using the examples in Oracle Enterprise Manager Ops Center’s SDK.
The example demonstrates the JMX Messaging Protocol (JMXMP) connector with Java/JMX technology. This example does not require any external JARs except Java and JDMK. This example performs the following functions:
Configures the connection.
Performs security settings.
Opens the connection (locally or remotely).
Uses the connection with JMX basic requests.
Closes the connection.
SUNWxvmoc-sdk.pkg package in the dvd/<platform>/Product/components/packages/ directory on the DVD/Install Media.SUNWxvmoc-sdk.pkg package.BasicClient.javaLists the packages in the API of the Oracle Enterprise Manager Ops Center.
Table C-1 provides a brief description of the public APIs. For a complete list of packages, its classes, interfaces, and methods, refer to the Javadoc that is included in the SDK.
Table C-1 List of Public APIs
| Package | Description |
|---|---|
|
|
Provides BIOS configuration services. |
|
|
Provides parameters for ABE related operations. |
|
|
Provides virtual datacenter (vDC) administration and vDC management services. |
|
|
Provides common constants and utility classes. |
|
|
Provides services to perform discovery and manage discovery profiles. |
|
|
Provides the service for Domain Model maintenance |
|
|
Provides the service interface for exadata cell management. |
|
|
Provides network domain services. |
|
|
Provides services for OCDoctor functionality in Ops Center. |
|
|
Provides Oracle pre-engineered system management services. |
|
|
Provides services for operating systems and virtual server container analytics. |
|
|
Provides services to perform operations on OVM deployments through the OVM manager. |
|
|
Provides rack management services. |
|
|
Provides the reset service interface to handle resetting and refreshing the service processor. |
|
|
Provides service for managing the provisioning of agents. This package provides services for the installation, configuration, and removal of agent software to remote operating systems. |
|
|
Provides the service interface for agent upgrades. |
|
|
Provides services for alarm management. |
|
|
Provides the operations for authorization management. |
|
|
Provides the interface for boot environment service. |
|
|
Provides the service interface for managing the cached view of the domain model. |
|
|
Provides the service interface for cluster management. This service is responsible for viewing and managing Solaris cluster instances and their nodes. |
|
|
Provides the service interfaces that are common to different public API services. |
|
|
Provides the service interface for hardware components management. |
|
|
Provides the service for accessing low-level data models. |
|
|
Provides the service interface to delete assets such as servers, operating systems, service tags, and chassis. The virtualization assets such as hosts, guests, virtual image libraries, and networks can be removed by calling the appropriate methods on their respective services. |
|
|
Provides services to discover assets. The interface for discovery service provides capability to initiate a discovery operation for a set of IP addresses. |
|
|
Provides the interface for event service. The interface for event service allows the client to subscribe to notifications emitted from the domain model. |
|
|
Provides service interfaces for fabric management. |
|
|
Provides services for firmware deployment management. This package manages deployments of firmware updates to servers and chassis. |
|
|
Provides service tag and general gear management interfaces. |
|
|
Provides asset group management services. |
|
|
Provides service interfaces for guest management. |
|
|
Provides service interfaces for guest provisioning. |
|
|
Provides job management services for performing job actions, controlling job status, and retrieving information on job actions and job history. |
|
|
Provides the service interface for migration service. This package provides the service for live, warm and cold migration of guest domains. |
|
|
Provides the My Oracle Support services. |
|
|
Provides the network management services. This package provides services for managing networks for guests. |
|
|
Provides notifications management services. |
|
|
Provides the service interface for Oracle Enterprise Manager Cloud Control repository integration. |
|
|
Provides services for operation profile functionality. |
|
|
Provides the service interface for XMV Update Job Manager. |
|
|
Provides classes for OS Configuration profiles management. |
|
|
Provides services and types to manage deployment of operating systems to servers. This package provides services to access aggregated and detailed information on installed operating systems, monitor OS activity, and provision OS. This package is available only in Enterprise Controllers. |
|
|
Provides the parameters for OS monitoring profile value object creation. |
|
|
Provides access to services based on the pluggable authentication modules |
|
|
Provides the product and asset information service and types interfaces, used to classify assets according to their product name and hierarchy. |
|
|
Provides the service interface to download update catalog files and bundles. |
|
|
Provides the profile services to create, delete, and update profiles. |
|
|
Provides services for managing server provisioning. |
|
|
Provides services for the installation of proxy software on a set of systems. |
|
|
Provides service for managing the provisioning of Proxy Controllers. |
|
|
Provides services and types for retrieving reports on utilization trend. |
|
|
Provides services interfaces for the report manager. |
|
|
Provides service interfaces for storage server management. |
|
|
Provides service interfaces for server management. |
|
|
Provides the physical and virtual switch management service interface. |
|
|
Provides the topology service and types interfaces to get topology information of the managed resources. This package provides a tree-based navigation view of the Ops Center assets. |
|
|
Provides the services to manage user preferences. |
|
|
Provides the services for virtual images library and virtual image management. |
|
|
Provides the service for managing the life cycle of virtual pools sharing the same libraries or networks, and have the same processor architecture, integrating virtual pools with storage, networks, and virtualization hosts. |
|
|
Provides the service interface for managing virtualized server containers. |
|
|
Provides filters supported for Windows services. |
|
|
Provides service interfaces for Windows compliance reports and Windows software updates deployment. |
|
|
Provides the service interface for Windows management extension administration. |
|
|
Provides the XVM server management service for managing the system level aspects of the XVM server. |
Overview of the API in Oracle Enterprise Manager Ops Center.
Describes Java Management Extensions (JMX) in Oracle Enterprise Manager Ops Center.
Java Management Extensions (JMX) technology provides the tools for building distributed, modular, and dynamic solutions for managing and monitoring devices, applications, and networks. The JMX API defines the notion of MBeans, or manageable objects, which expose attributes and operations in a way that allows remote management applications to access them. An important new feature of the JMX API in the Java Platform, Standard Edition 7 (Java SE 7) is its ability to create MXBeans, a substantial improvement over Standard MBeans. For more information on JMX, see the Java Management Extensions (JMX) Technology website at http://www.oracle.com/technetwork/java/javase/tech/javamanagement-140525.html.
Describes the API of Oracle Enterprise Manager Ops Center.
The simplest and preferred way of interacting with the public APIs is using a Java client. This Java client communicates with the public APIs using a secure remote JMX client. By using a remote JMX client, it is possible to directly interact with the Service MXBeans in Java using the strongly-typed Java MXBeans interface class library. The JMX MXBean interfaces are documented in the javadoc that is included in the SDK. The following remote JMX management protocols are supported: JMXMP and WS-MAN.
Describes tiers of the virtualization management stack in Oracle Enterprise Manager Ops Center.
The virtualization management stack is a three-tier management paradigm. The stack consists of presentation tier, service tier, and an underlying domain model.
Describes the presentation tier of the API in Oracle Enterprise Manager Ops Center.
The presentation tier provides the user interface, displays the information provided by the service tier, and takes actions through the service tier.
Describes the service tier of the API in Oracle Enterprise Manager Ops Center.
The service tier contains all the core management logic. This tier exposes the management functionality through a set of public APIs that are used by the presentation tier and external systems management solutions. These public APIs are the ideal integration points for third-party software to control or to monitor the Enterprise Manager Ops Center software.
The service tier exposes its management APIs as a series of Java Management Extensions (JMX) MXBean interfaces. These interfaces are made accessible as public APIs through several remote protocols, including JMXRemoting (JSR 160) and WS-Management (JSR 262).
The services are identified by MXBean ObjectName, and these are of the form:
com.sun.xvm.services:type=<service name>
The main entry point to the public APIs is the MXBean interface defined in com.sun.xvm.services.
Describes the way Oracle Enterprise Manager Ops Center registers each asset and its relationships.
The domain model provides the representation of underlying managed resources and associations between them. The domain model exposes a normalized data model of these managed resources as a collection of JMX MXBeans. Each managed resource has one MXBean and each association between these resources as one MXBean.