Siebel System Administration Guide > Siebel Management Framework API >

About the Siebel Management Framework API Methods


The Siebel Management Framework allows third-party and custom management tools to access Siebel CRM run-time information by way of JMX API (Java Management Extensions application program interface) methods. Three services allow you to gain access to three levels of information: the enterprise, server, and component levels.

This topic outlines the services and methods that can be executed with these API methods. For more information about the Siebel Management Framework, see the Siebel Installation Guide for the operating system you are using.

For descriptions and syntactic examples of the methods, see the following:

Table 39 shows the services along with a high-level description.

Table 39.  Services of Siebel Management Framework API Methods
Service
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
  • Start up and shut down components
  • Retrieve parameter settings for specific enterprise parameter
  • Retrieve parameter settings for component definitions
  • Start up and shut down all servers within the enterprise

Server

Allows third-party vendor management tools 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
  • Start up and shut down specific server

Component

Allows third-party vendor management tools 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
  • Start up and shut down a specific component
Siebel System Administration Guide Copyright © 2014, Oracle and/or its affiliates. All rights reserved. Legal Notices.