List of provided MBeans

Liberty provides a list of MBeans and corresponding management interfaces that you can use to manipulate and monitor the server. When using an MBean Proxy, find the classes that you need to compile inside the .jar files in ${wlp.install.dir}/dev/api/ibm.

For each MBean or MXBean in the list:
  • The name is the javax.management.ObjectName value that uniquely identifies the MBean or MXBean. When there are multiple instances of an MBean or MXBean, the ObjectName value can contain a wildcard (*), which is described in the Comments entries in this topic.
  • The Management interface entries specify the name of the Java™ interface that can be used to construct a proxy object for the MBean or MXBean as described in Examples of accessing MBean attributes and operations. For more information about the management interface, see the Java API document for Liberty. The Java API documentation for each Liberty API is detailed in the Programming interfaces (Javadoc) section of the online IBM® documentation, and is also available as a separate .zip file in one of the javadoc subdirectories of the ${wlp.install.dir}/dev directory.

WebSphere:feature=channelfw,type=endpoint,name=*

  • Management interface: com.ibm.websphere.endpoint.EndPointInfoMBean
  • Comments: One instance is available for each endpoint in the system, where * is a unique endpoint name.

WebSphere:feature=clusterMember,type=ClusterMember,name=ClusterMember

  • Management interface: com.ibm.websphere.cluster.member.ClusterMemberMBean
  • Comments: This MBean is available when the clusterMember feature is enabled on a collective member. To join a cluster, add <clusterMember name=<clusterName> /> into the server configuration. The name of the cluster can be retrieved by this MBean.

WebSphere:feature=collectiveController,type=AdminMetadataManager,name=AdminMetadataManager

  • Management interface: com.ibm.websphere.collective.repository.AdminMetadataManagerMBean
  • Comments: This MBean provides the administrative metadata MBean operations to add, retrieve, and remove metadata. The metadata includes tags, owner, contact, and note data. The metadata information is stored in the collective repository. You can find the MBean class and API documentation in the following locations:
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.collectiveController_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.collectiveController_version-javadoc.zip

WebSphere:feature=collectiveController,type=ClusterManager,name=ClusterManager

  • Management interface: com.ibm.websphere.collective.controller.ClusterManagerMBean
  • Comments: This MBean is available when the collectiveController feature is enabled. It provides operations that can be used to query and manipulate Liberty servers that have enabled the collectiveMember and clusterMember features.

WebSphere:feature=collectiveController,type=CollectiveRegistration,name=CollectiveRegistration

  • Management interface: com.ibm.websphere.collective.controller.CollectiveRegistrationMBean
  • Comments: This MBean is available when the collectiveController feature is enabled. It provides operations that enable registration of hosts, Liberty servers to be joined as members, replication of new controllers, and controller access authentication of members to the collective controller.

WebSphere:feature=collectiveController,type=CollectiveRepository,name=CollectiveRepository

  • Management interface: com.ibm.websphere.collective.repository.CollectiveRepositoryMBean
  • Comments: This MBean is available when the collectiveController feature is enabled. It provides operations that enable reading and writing of data into the collective repository.

WebSphere:feature=collectiveController,type=ControllerConfig,name=ControllerConfig

  • Management interface: com.ibm.websphere.collective.controller.ControllerConfigMBean
  • Comments: The ControllerConfigMBean defines the administrative interface for managing shared configuration files across a collective controller replica set. You can find the MBean class and API documentation in the following locations:
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.collectiveController_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.collectiveController_version-javadoc.zip

WebSphere:feature=collectiveController,type=RepositoryConfiguration,name=RepositoryConfiguration

  • Management interface: com.ibm.websphere.collective.repository.RepositoryConfigurationMBean
  • Comments: This MBean is available when the collectiveController feature is enabled. It provides operations that enable adding and removing collective controller replicas to scale out the replica set and provide high availability capabilities.

WebSphere:feature=collectiveController,type=RepositoryPathUtility,name=RepositoryPathUtility

  • Management interface: com.ibm.websphere.collective.repository.RepositoryPathUtilityMBean
  • Comments: This MBean is available when the collectiveController feature is enabled. It provides utility operations that enable easier construction of paths for use with the RepositoryConfiguration MBean.

WebSphere:feature=collectiveController,type=RoutingContext,name=RoutingContext

  • Management interface: com.ibm.websphere.collective.controller.RoutingContextMBean
  • Comments: This MBean is for setting up the JMX routing context - to call MBeans on a collective member server through a collective controller for example.

    See Example of setting up a JMX routing environment for more information.

WebSphere:feature=collectiveController,type=ServerCommands,name=ServerCommands

  • Management interface: com.ibm.websphere.collective.controller.ServerCommandsMBean
  • Comments: This MBean runs in the collective controller and can remotely start the Liberty server command on a target host. It has the following operations:
    • getServerStatus: This operation gets the status of a member server in a collective by providing its host name, server user directory, and server name. You can subscribe for server up or down changes by calling addNotificationListener. An AttributeChangeNotification is sent to all listeners when any server in the collective changes its state. The host name, server user directory, and server name are stored as a comma-separated string in the message for identification purposes.
    • startServer
    • stopServer
    • javadumpServer: This operation creates a Java thread dump or Java heap dump of a member server in a collective by providing its host name, server user directory, and server name.
    You can find the MBean class and API documentation in the following locations:
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.collectiveController_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.collectiveController_version-javadoc.zip

WebSphere:feature=collectiveController,type=CollectiveValidation,name=CollectiveValidation

  • Management interface:com.ibm.websphere.collective.controller.CollectiveValidationMBean
  • Comments:This MBean is available when the collectiveController feature is enabled. It provides operations to tests configured RXA and SSL connections' settings of a server in a collective or the RXA connection settings of a registered host in a collective.

WebSphere:feature=dynamicRouting,type=DynamicRouting,name=DynamicRouting

  • Management interface: com.ibm.websphere.dynamic.routing.DynamicRoutingMBean
  • Comments: This MBean is available when the Dynamic Routing feature is enabled. It provides an operation to generate a web server plug-in configuration for dynamic routing.

    See Dynamic routing command.

WebSphere:feature=jaxws,type=WebServiceStats,service=*,port=*

  • Management interface: org.apache.cxf.management.counters.ResponseTimeCounterMBean
  • Comments: Available when the monitor-1.0 feature is enabled. The WebServiceStats can be either Performance.Counter.Server or Performance.Counter.client, where service=* is the qualified name of a service endpoint, port=* is the port name of the service endpoint. See JAX-WS monitoring.
Note: This is a Dynamic Model MBean.

WebSphere:feature=jaxws,type=Bus.Service.Endpoint,bus.id=*,service=*,port=*,name=*

  • Management interface: org.apache.cxf.endpoint.ManagedEndpoint
  • Comments: Available when the localConnector-1.0 or restConnector-2.0 feature is enabled and the JAX-WS application is accessed at least once. The bus.id=* is the name of the bus, where * is of the form <AppName>-Server-Bus. The service=* is the qualified name of the endpoint, where * is of the form {ServiceNamespace}ServiceName. The port=* is the port name of the endpoint, where the * is the current port name. The format of the MBean is as follows: <BUS>@<SERVICE>@<PORT>@<URL_PATTERN>, where:
    • <BUS> is the same value as the field bus.id;
    • <SERVICE> is the same value as the field service;
    • <PORT> is the same value as the field port;
    • <URL_PATTERN> can be the following values in different scenarios;
      • If the url-pattern element is defined in the web.xml file of your application, the value of url-pattern element is used. For example, the url-pattern element is /SayHelloURL in the web.xml file:
        <servlet-mapping>
    <servlet-name>com.ibm.ws.jaxws.test.jmx.service.WSTestEndpointService</servlet-name>
    <url-pattern>/SayHelloURL</url-pattern>
</servlet-mapping>
        For example, the MBean might be as follows:
        WebSphere:feature=jaxws,bus.id=EJBWSBasic-Server-Bus,type=Bus.Service.Endpoint,
service="{http://ejbbasic.jaxws.ws.ibm.com/}SayHelloService",port="SayHelloPort",
name="EJBWSBasic-Server-Bus@{http://ejbbasic.jaxws.ws.ibm.com/}SayHelloService@SayHelloPort@SayHelloURL"
      • If the URL pattern is not specified, the service name is used as the default value. For example, the MBean might be as follows:
        WebSphere:feature=jaxws,bus.id=EJBWSBasic-Server-Bus,type=Bus.Service.Endpoint,
service="{http://ejbbasic.jaxws.ws.ibm.com/}SayHelloService",port="SayHelloPort",
name="EJBWSBasic-Server-Bus@{http://ejbbasic.jaxws.ws.ibm.com/}SayHelloService@SayHelloPort@SayHelloService
      • If the web services engine cannot retrieve the URL pattern when the endpoint MBean is registered, a random unique number is used to ensure that the MBean is unique. For example, the MBean might be as follows:
        WebSphere:feature=jaxws,bus.id=EJBWSBasic-Server-Bus,type=Bus.Service.Endpoint,
service="{http://ejbbasic.jaxws.ws.ibm.com/}SayHelloService",port="SayHelloPort",
name="EJBWSBasic-Server-Bus@{http://ejbbasic.jaxws.ws.ibm.com/}SayHelloService@SayHelloPort@261689241"
Note:
  • This is a Dynamic Model MBean.
  • The destroy operation on this MBean is not supported.

WebSphere:feature=kernel,name=ServerInfo

  • Management interface: com.ibm.websphere.kernel.server.ServerInfoMBean
  • Comments: The ServerInfoMbean interface is used to retrieve information about the running server. Search the following directories for the class and API documentation:
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.kernel.service_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.kernel.service_version-javadoc.zip

The exposed operations include a method to retrieve the product installation and user directory locations, the default host name, the server name, the product version, the Java specification version, and the Java Runtime version.

WebSphere:feature=kernel,name=ServerEndpointControl

  • Management interface: com.ibm.websphere.kernel.server.ServerEndpointControlMBean
  • Comments: The ServerEndpointControlMBean interface is used to pause, resume, and get the status of server endpoints. The MBean is available from the Kernel, so you do not need to enable a special feature. You can find the MBean class and API documentation in the following locations:
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.kernel.service_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.kernel.service_version-javadoc.zip

For a list of endpoint types that you can pause, see Pausing and resuming a Liberty server from the command line.

WebSphere:feature=persistence,type=DDLGenerationMBean,name=DDLGenerationMBean

  • Management interface: com.ibm.websphere.persistence.mbean.DDLGenerationMBean
  • Comments: This MBean is available after you enable the Enterprise JavaBeans (EJB) persistent timer feature or another feature that uses the persistent store capability. When you run the DDLGenerationMBean.generateDDL() operation, you receive a map that contains information, such as how many Data Definition Language (DDL) files were created and where they were created in the file system.
    You can find the MBean class and API documentation in the following locations:
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.persistence_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.persistence_version-javadoc.zip

WebSphere:feature=restConnector,type=FileService,name=FileService

  • Management interface: com.ibm.websphere.filetransfer.FileServiceMXBean
  • Comments: This MXBean enables you to perform various file-related operations on the host where Liberty resides.
    You can find its class and API documentation in the following locations: 
    liberty_home/dev/api/ibm/com.ibm.websphere.appserver.api.restConnector_version.jar
liberty_home/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.restConnector_version-javadoc.zip

    The exposed operations include the ability to query certain metadata (last modified date, size, and other similar metadata) for a particular file or directory and also to query all child files (and corresponding metadata) for a particular directory. Support for archive creation and expansion is also provided, which can be useful to compress Liberty log files or to extract an application before it is deployed.

    This MXBean contains two attributes: the read list and the write list. They represent the lists of locations that users can read or write to when using the FileService or FileTransfer capabilities that are provided by Liberty. Through the MXBean, these attributes can be read only, but they can be configured or customized through the following elements in the server.xml file:
    <remoteFileAccess>
  	<readDir>${server.output.dir}/logs</readDir>
  	<readDir>${server.output.dir}/apps</readDir>
  	<writeDir>${server.output.dir}/dropins</writeDir>
</remoteFileAccess>
    If the readDir element is not specified, the default is the combination of: ${wlp.install.dir}, ${wlp.user.dir}, and ${server.output.dir}. If a writeDir element is not specified, the default is the empty set.

    The restConnector-2.0 feature must be included in the server.xml file in order for this MXBean to be loaded and to honor its configuration elements

    Using Liberty-defined variables is allowed with all the server-side parameters that take a string that represents a file path. Such variables are defined on the liberty_home/README.TXT file.

WebSphere:feature=restConnector,type=FileTransfer,name=FileTransfer

  • Management interface: com.ibm.websphere.filetransfer.FileTransferMBean
  • Comments: Use this MBean to perform various file-transfer operations on the host where Liberty resides.
    You can find its class and API documentation in the following locations: 
    liberty_home/dev/api/ibm/com.ibm.websphere.appserver.api.restConnector_version.jar
liberty_home/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.restConnector_version-javadoc.zip

    This MBean is registered on the PlatformMBeanServer from the same JVM that its corresponding Liberty process is running, but it can be accessed only by using the IBM JMX REST Connector. The connection can be local or remote, but the REST Connector must be used.

    The exposed operations include the ability to download, upload, and delete a file. Each read and write request on the server is bound to the configurable read and write lists that are accessed through the FileServiceMXBean. The FileTransferMBean can also be fully accessed and operated from the built-in Java JConsole, if the JConsole is connected through the IBM JMX REST Connector.

    Using Liberty-defined variables is allowed with all the server-side parameters that take a string that represents a file path. Such variables are defined on the liberty_home/README.TXT file.

WebSphere:feature=scalingController,type=StackManager,name=StackManager

  • Management interface: com.ibm.websphere.scaling.controller.StackManager
  • Comments: The StackManager MBean controls file system scanning. The stack manager scans the WLP_STACK_GROUPS_DIR location, which by default is $WLP_USER_DIR/shared/stackGroups, for additions, modifications, and deletions of controllers. You can find the MBean class and API documentation in the following locations:
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.scalingController_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.scalingController_version-javadoc.zip

WebSphere:feature=wasJmsServer,type=MessagingEngine,name=*

  • Management interface: com.ibm.websphere.messaging.mbean.MessagingEngineMBean
  • Comments: Available when the wasJmsServer-1.0 feature is enabled. One messaging engine instance is available for each Liberty. The name=* is the name of the MBean, where * is the unique name of the messaging engine MBean. See JMS messaging.

WebSphere:feature=wasJmsServer,type=Queue,name=*

  • Management interface: com.ibm.websphere.messaging.mbean.QueueMBean
  • Comments: The MBean is available when the wasJmsServer-1.0 feature is enabled and the MBean of the messaging engine is available. The name=* is the name of the MBean, where * is the name of the queue MBean. See JMS messaging.

WebSphere:feature=wasJmsServer,type=Subscriber,name=*

  • Management interface: com.ibm.websphere.messaging.mbean.SubscriberMBean
  • Comments: The MBean is available when the wasJmsServer-1.0 feature is enabled and the MBean of the messaging engine is available. The name=* is the name of the MBean, where * is the name of the subscriber MBean.
    Note: The SubscriberMBean is a subscriber to the existing TopicMBean. See JMS messaging.

WebSphere:feature=wasJmsServer,type=Topic,name=*

  • Management interface: com.ibm.websphere.messaging.mbean.TopicMBean
  • Comments: The MBean is available when the wasJmsServer-1.0 feature is enabled and the MBean of the messaging engine is available. The name=* is the name of the MBean, where * is the name of the topic MBean. See JMS messaging.

WebSphere:name=com.ibm.websphere.config.mbeans.ServerXMLConfigurationMBean

  • Management interface: com.ibm.websphere.config.mbeans.ServerXMLConfigurationMBean
  • Comments: The ServerXMLConfigurationMBean provides an interface for retrieving the file paths of all server configuration files that are known to the server. The MBean is available from the Kernel, so you do not need to enable a special feature. You can find the MBean class and API documentation in the following locations:
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.config_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.config_version-javadoc.zip

WebSphere:name=com.ibm.websphere.runtime.update.RuntimeUpdateNotificationMBean

  • Management interface: com.ibm.websphere.runtime.update.RuntimeUpdateNotificationMBean
  • Comments: The RuntimeUpdateNotificationMBean provides notifications for server runtime updates. The user data object attached to the notification is a java.util.Map. The notification type for runtime update notifications that are emitted by this MBean is com.ibm.websphere.runtime.update.notification.

WebSphere:name=com.ibm.ws.config.mbeans.FeatureListMBean

  • Management interface: com.ibm.websphere.config.mbeans.FeatureListMBean
  • Comments: The FeatureListMBean exposes a single method to generate an XML report on all the features installed at run time. The MBean is available from the Kernel, so you do not need to enable a special feature. You can find the MBean class and API documentation in the following locations:
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.config_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.config_version-javadoc.zip

WebSphere:name=com.ibm.ws.config.serverSchemaGenerator

  • Management interface: com.ibm.websphere.config.mbeans.ServerSchemaGenerator
  • Comments: The ServerSchemaGenerator MBean exposes methods to generate schema from the installed image, the most used way, or from a current runtime. The MBean is available from the Kernel, so you do not need to enable a special feature. You can find the MBean class and API documentation in the following locations:
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.config_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.config_version-javadoc.zip

WebSphere:name=com.ibm.ws.jmx.mbeans.generatePluginConfig

WebSphere:service=com.ibm.websphere.application.ApplicationMBean,name=*

  • Management interface: com.ibm.websphere.application.ApplicationMBean
  • Comments: One instance is available for each application in the system, where * is a unique application name.

WebSphere:service=com.ibm.websphere.security.authentication.cache.DeleteAuthCache

  • Management interface: com.ibm.websphere.security.authentication.cache.DeleteAuthCache
  • Comments: This MBean can be called to clear all users from the authentication cache. This MBean is available when the Application Security feature, version 2.0 or later, is configured.

WebSphere:service=com.ibm.websphere.security.keyring.saf.KeyringNotificationMBean

  • Management interface: com.ibm.websphere.security.keyring.saf.KeyringNotificationMBean
  • Comments: This MBean reloads the SAF key rings that are used by the transportSecurity-1.0 component, and enables the server to use updated certificates in the SAF key ring, without restarting the Liberty server instance.

WebSphere:service=com.ibm.websphere.webcontainer.WebModuleMBean,application=*,name=*

  • Management interface: com.ibm.websphere.webcontainer.WebModuleMBean
  • Comments: One instance is available for each WebModule in the system, where application=* is the name of an application in the system, and name=* is the name of a web module in that application.

WebSphere:type=com.ibm.ws.jca.cm.mbean.ConnectionManagerMBean,*

  • Management interface: com.ibm.ws.jca.cm.mbean.ConnectionManagerMBean
  • Comments: One instance is available for each Connection Manager in the system, including those that are created in the following contexts:
    • When explicitly configured in the server configuration
    • When implicitly created because of @DataSourceDefinition or @ConnectionFactoryDefinition annotations
    • When created as a result of a connection factory or data source in the server configuration
    The mbean instance is not available until the corresponding connection factory or data source is first used.
    To narrow the connection manager instance, you can specify more attributes, such as those shown in the following examples:
    WebSphere:type=com.ibm.ws.jca.cm.mbean.ConnectionManagerMBean,jndiName=jdbc/db2,*
WebSphere:type=com.ibm.ws.jca.cm.mbean.ConnectionManagerMBean,name=jmsConnectionFactory[cf1]/connectionManager[default-0],*
WebSphere:type=com.ibm.ws.jca.cm.mbean.ConnectionManagerMBean,name=databaseStore[dbstore1]/dataSource[default-0]/connectionManager,*
WebSphere:type=com.ibm.ws.jca.cm.mbean.ConnectionManagerMBean,jndiName=java.module/env/jdbc/ds3,application=MyApp,module=myweb,*

WebSphere:service=com.ibm.ws.kernel.filemonitor.FileNotificationMBean

  • Management interface: com.ibm.websphere.filemonitor.FileNotificationMBean

WebSphere:type=JvmStats

  • Management interface: com.ibm.websphere.monitor.jmx.JvmMXBean
  • Comments: Available when the monitor-1.0 feature is enabled. See JVM monitoring.

WebSphere:type=RequestTimingStats,name=Servlet

  • Management interface: com.ibm.websphere.request.timing.RequestTimingStatsMXBean
  • Comments: To enable this MBean, configure the monitor-*.* and requestTiming-*.* features. The asterisk in the name=* entry represents the type of request for which statistics are gathered. For more information, see Request monitoring.

WebSphere:type=ServletStats,name=*

  • Management interface: com.ibm.websphere.webcontainer.ServletStatsMXBean
  • Comments: When the monitor-1.0 feature is enabled, one instance is available for each servlet that is served, where * is of the form <AppName>.<ServletName>. See Web application monitoring.

WebSphere:type=ThreadPoolStats,name=Default Executor

  • Management interface: com.ibm.websphere.monitor.jmx.ThreadPoolMXBean
  • Comments: Available when the monitor-1.0 feature is enabled. See ThreadPool monitoring.