Response body attributes for queue managers

When we use the HTTP GET method with the qmgr object to request information about queue managers, the following attributes are returned within named JSON objects.

The following objects are available:

For more information about the PCF equivalents to the queue manager REST API parameters and attributes, see REST API and PCF equivalents for queue managers.


status

The status object contains status information about queue managers:

    started
    String.
    Specifies the date and time at which the queue manager was started.
    For more information about the time stamp format that is used to return the date and time, see REST API time stamps.

    channelInitiatorState
    String.
    Specifies the current state of the channel initiator.
    On all platforms, the value is one of the following values:

    • stopped
    • running

    On the IBM MQ Appliance, UNIX, Linux, and Windows, the value can also be one of the following values:

    • starting
    • stopping

    On z/OS, the value can also be one of the following values:

    • unknown

      This value indicates that the channel initiator did not return a response to the status request. The channel initiator might be running, but busy. Retry the request after a short time to resolve the issue.

    ldapConnectionState
    This attribute is only available on the IBM MQ Appliance, UNIX, Linux, and Windows.
    String.
    Specifies the current state of the connection to the LDAP server.
    The value is one of the following values:

    • connected
    • error
    • disconnected

    connectionCount
    Integer.
    Specifies the current number of connections to the queue manager.
    On z/OS, this attribute includes threads that might be disassociated from a connection, together with connections that are in-doubt and connections where external intervention is required.

    publishSubscribeState
    String.
    Specifies the current state of the publish/subscribe engine of the queue manager.
    The value is one of the following values:

      stopped
      Specifies that the publish/subscribe engine, and the queued publish/subscribe interface is not running.

      starting
      Specifies that the publish/subscribe engine is initializing.

      running
      Specifies that the publish/subscribe engine, and the queued publish/subscribe interface are running.

      compatibility
      Specifies that the publish/subscribe engine is running, but that the publish/subscribe interface is not running. Therefore, it is possible to publish or subscribe by using the application programming interface. However, any message that is put to the queues that are monitored by the queued publish/subscribe interface are not acted upon.

      error
      The publish/subscribe engine failed.

      stopping
      The publish/subscribe engine is stopping.


extended

This object is only available on the IBM MQ Appliance, UNIX, Linux, and Windows. This object is not returned if the queue manager that is specified in the resource URL is a remote queue manager. The extended object contains extended information about queue managers:

    permitStandby
    This attribute is only available on UNIX, Linux, and Windows.
    String.
    Specifies the permissible standby state.
    The value can be one of the following values:

    • permitted
    • notPermitted
    • notApplicable

    installationName
    String.
    Specifies the name of the installation that the queue manager is associated with.

Parent topic: GET