Maximo Management Interface APIs
Several APIs are available to access information that is related to the state of a Maximo deployment. A list of available MMI APIs is in the Monitor Environment Information dialog of the Logging application.
In order for the APIs to collect information from the Maximo environment, the system property mxe.oslc.webappurl must contain the host name of the Maximo server. For clustered environments, the load balancer, such as the HTTP server, must be specified. The default URL is http://localhost/maximo/oslc/.
All MMI APIs can be protected through Maximo authorization by using signature options. The signature options must be associated with the Logging application. A signature option can be specified for an API by opening the Monitor Environment Information dialog in the Logging application, locating the API, and selecting a value in the Signature Option field.
The URL template for each API in the table is http://<host>:<port>/maximo/oslc/members/<memberid>/<api>, where <memberid> is the Maximo cluster member.
| API | URL template | Description |
|---|---|---|
| JVM | http://<host>:<port>/maximo/oslc/members/<memberid>/jvm | Provides information about the JVM that is hosting
the Maximo application. Some of the information that is provided includes
the start time, the JVM vendor, and the JVM version. You can also drill down, by using links, to provide information about the JVM system properties and the JVM arguments. |
| Operating system | http://<host>:<port>/maximo/oslc/members/<memberid>/opsystem | Provides information about the operating system for the Maximo run time. Some of the information that is provided includes the OS type, version, architecture, and the number processors that are available. |
| Database | http://<host>:<port>/maximo/oslc/members/<memberid>/dbinfo | Provides information about the database that
is used by the Maximo application. Some of the information that is
provided includes the database version or vendor information, and
driver information. The resource also provides links to the database connection pool details. |
| MBO Count | http://<host>:<port>/maximo/oslc/members/<memberid>/mbocount | Provides MBO count information. The resource also provides links to the MBO and the MboSet class. This class can be useful when you are trying to resolve out of memory (OOM) or performance issues. |
| Memory | http://<host>:<port>/maximo/oslc/members/<memberid>/memory | Provides information about the server heap and non-heap memory usage. All units are in Megabytes (MB). |
| EventTopicTree | http://<host>:<port>/maximo/oslc/members/<memberid>/eventtopic | Provides information about the Maximo event subscription tree. The resource describes information about event topics, such as add asset or update work order, and the listeners that are associated with those topics. |
| Logger | http://<host>:<port>/maximo/oslc/members/<memberid>/loggers | Provides information about the state of a Maximo
logger. The logger name can be provided to the API by using the oslc.where query
parameter. An example of a parameter is oslc.where=oslc:shortId=”maximo.script”. This resource provides information about the automation script logger. API consumers specify the logger name by using the oslc:shortId property for this API to provide information about the logger, which includes the log level, and active state. |
| Integration Queues | http://<host>:<port>/maximo/oslc/members/<memberid>/queues | Provides information about state of a Maximo
integration queue. The resource allows consumers of the API to test
the connectivity/read/write to the queue and to browse messages in
the queue spi:browseMessage property. By default the API shows only the top 5 messages in the queue. You can control that number by using the query string oslc.where=spi:count=10. This query shows the top 10 messages in the queue. Note: Browsing
messages is a costly call and browsing too many messages simultaneously
can cause memory or performance issues in the server.
|
| JAXP | http://<host>:<port>/maximo/oslc/members/<memberid>/jaxp | Provides information about the JAXP providers in the server. |
| Object Structure Cache | http://<host>:<port>/maximo/oslc/members/<memberid>/oscache | Provides information about the Object Structure Cache. It identifies cases where there are invalid entries in the Object Structure tables that might cause cache corruption. |
| Threads | http://<host>:<port>/maximo/oslc/members/<memberid>/threads | Provides information about the threads in the JVM, such as the current thread count, peak thread count, and if there are any deadlocks. It also provides a link to enumerate the threads in the system at that instant. The API consumer can check for thread states and lock information about each thread. |
See the Maximo Management Interface wiki for information on running MMI APIs and viewing and submitting output to IBM.
