Response body attributes for queue managers

status

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, AIX®, 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, AIX, 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, AIX, 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:

isDefaultQmgr

Boolean.

Specifies whether the queue manager is the default queue manager.

The value is true if the queue manager is the default queue manager.

permitStandby

This attribute is only available on AIX, 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.

encryptedFileSystem

This attribute is only available on IBM MQ Appliance.

String.

Set to yes if the queue manager file system is encrypted, or no if the file system is not encrypted.

groupLSN

For a queue manager that supports Native HA.

String.

The log sequence number (LSN) that has been replicated between a quorum of instances in the Native HA group, in nnnnn:nnnnn:nnnnn:nnnnn format. If the LSN is not known, the value is an empty string.

groupName

For a queue manager that supports Native HA.

String.

The name of the Native HA group if the queue manager is running in a Native HA environment, or blank otherwise.

groupRole

For a queue manager that supports Native HA.

String.

The current role of the local Native HA group. Is one of the following values:

• live
• notConfigured
• PendingLive
• PendingRecovery
• recovery
• unknown

instanceName

For a queue manager that supports Native HA.

String.

The name of the local Native HA instance if the queue manager is running in a Native HA environment, or blank otherwise.

inSync

For a queue manager that supports Native HA.

String.

Whether this instance is currently considered in-sync with the active instance. One of the following values:

• no
• unknown
• yes
• blank (if the queue manager is not running in a Native HA environment).

role

For a queue manager that supports Native HA.

String.

Specifies the current role of the instance in the Native HA group. One of the following values:

• active
• inactive
• notConfigured
• replica
• unknown

quorum

For a queue manager that supports Native HA.

String.

Two numeric values separated by a forward slash (X/Y) if the queue manager is part of a Native HA group, or blank otherwise.

ha

This object is only available on the IBM MQ Appliance. The ha object returns information about the high availability (HA) configuration on the appliance:

type

String.

Specifies whether the queue manager is configured for HA. Is set to "replicated" for an HA queue manager, or is an empty string otherwise.

floatingIPAddress

String.

Specifies the floating IP address if one has been configured for an HA queue manager.

floatingIPInterface

String.

Specifies the local interface that is used to connect to the queue manager on the two appliances in the HA group, if one has been configured for an HA queue manager.

dr

nativeha

This object returns information about Native HA on the queue manager and consists of an array of Native HA objects that represent information about an instance or a group. Each object contains the following attributes:

name

String.

Specifies the name of the Native HA object. This attribute is always returned.

type

String.

Specifies the type of Native HA object. Is one of the following values:

• instance
• group

This attribute is always returned.

The following objects can be included in the JSON object that represents information about a Native HA instance or group. Which objects and attributes are returned depends on the URL that was specified for the request:

instance

Contains attributes that are related to Native HA instances in the local group.

group

Contains attributes that are related to the Native HA groups configured on this instance.

The following attributes are returned for the instance object:

acknowledgedLSN

String.

The log sequence number (LSN) that has been acknowledged by the instances as having been written to the recovery log, in nnnnn:nnnnn:nnnnn:nnnnn format.

activeConnections

String.

Whether the instance currently has a pair of active connections to the active instance. One of the following values:

• no
• yes
• unknown

backlog

String.

How many KB of recovery log data the active instance has written that have not yet been acknowledged by the named instance. This is how ‘out of sync’ the named instance currently is. The value is rounded up to a 1 KB boundary. Set to unknown if the information is not available.

connected

Boolean.

Indicates whether the named instance is connected to this instance.

inSync

String.

Whether this instance is currently considered in-sync with the active instance. One of the following values:

• no
• yes
• unknown

inSyncTime

String.

Indicates the date and time on which this instance was last in-sync with the active queue manager (blank if it is not known) in ISO 8601 format.

replicationAddress

String.

The network address and port to use when sending data to and from the specified instance.

role

String.

The current role of the instance in the Native HA group. One of the following values:

• active
• inactive
• leader
• notConfigured
• replica
• unknown

status

String.

The operational status of this instance. One of the following values:

• checking
• disconnected
• diskFull
• normal
• rebasing
• synchronizing
• unknown

The following attributes are returned for the group object:

address

String.

The IP address of the group.

backlog

String.

Indicates the number of KB that the group is behind. The value is rounded up to a 1 KB boundary. Set to unknown if the information is not available.

liveConnection

String.

Indicates whether the group is connected to a Live or Pending recovery group. One of the following values:

• no
• unknown
• suspended
• yes

inSync

String.

Indicates whether the group can become Live with no loss of data if a failover occurred. One of the following values:

• no
• unknown
• yes

inSyncTime

String.

Indicates the date and time on which this group was last in-sync with the Live group (blank if it is not known) in ISO 8601 format.

initialLSN

String.

The log sequence number (LSN) of the last log record recovered when the Native HA group initially became live, in the format nnnnn:nnnnn:nnnnn:nnnnn, or blank if the group is not live.

initialTime

String.

The time of the last log record recovered when the Native HA group initially became live, in ISO 8601 format. Blank, if the group is not live.

liveTime

String.

The time the group first became the live group, in ISO 8601 format. Blank, if the group is not live.

recoveryLSN

String.

A log sequence number (LSN) that the group could recover to, in nnnnn:nnnnn:nnnnn:nnnnn format. Any data written to the recovery log after this point might be lost if a failover occurred.

recoveryTime

String.

A time that the group could recover to, in ISO 8601 format. Any data written to the recovery log after this time might be lost if a failover occurred.

role

String.

Specifies the current role of the Native HA group. One of the following values:

• live
• notConfigured
• pendingLive
• pendingRecovery
• recovery
• unknown

status

String.

Indicates the operational status of this group. One of the following values:

• checking
• diskFull
• normal
• partitioned
• rebasing
• synchronizing
• unknown

version

String.

Indicates the version of the current group leader.