Siebel System Administration Guide > Siebel Management Framework APIs >

About the Siebel Management Framework APIs


The Siebel Management Framework allows third party and custom management tools to access Siebel runtime information by way of JMX APIs (Java Management Extensions application program interface). Three services allow you to gain access to three levels of information; Enterprise, Server and Components level.

This topic outlines the services and methods that can be executed with the APIs. For more information on Siebel Management Framework see Siebel System Monitoring and Diagnostics Guide. Table 35 shows the services along with a high level description. For descriptions and syntactic examples of the methods, see Methods Used with the Enterprise-Level Service, Methods Used with the Server-Level Service, and Methods Used with the Component-Level Service.

Table 35.  Services of Siebel Management Framework APIs
Services
Description

Enterprise

Allows third-party vendor, and custom made management tools to access exposed JMX Mbeans to perform Siebel enterprise level operations including:

  • Get list of servers that make up the enterprise
  • Get component availability across all servers within the enterprise
  • Startup and shutdown components
  • Retrieve parameter settings for specific enterprise parameter
  • Retrieve parameter settings for component definitions
  • Startup and shutdown all servers within the enterprise

Server

Allows third-party vendor management tool to access exposed JMX Mbeans to perform server level operations including:

  • Get server state
  • Get parameter settings for specific server parameters
  • Get statistic value
  • Get state value of a server component
  • Get list of components running on a specific server
  • Get state of components running on a specific server
  • Startup and shutdown specific server

Component

Allows third-party vendor management tool to access exposed JMX Mbeans to perform component level operations including:

  • Get attributes (parameter, statistic, state value) of a specific component
  • Get availability of a component on a specific server
  • Get number of processes running for a specific component
  • Get number of tasks running for a specific component
  • Startup and shutdown a specific component
Siebel System Administration Guide Copyright © 2010, Oracle and/or its affiliates. All rights reserved. Legal Notices.