Response body attributes for agents

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

The following objects are available:


general

    description
    String.
    Specifies the description of the agent.

    statusAge
    String.
    Specifies the age of the agent. The age is calculated as the difference in time between the system time of the machine where the coordination queue manager is running, and the time the last status was published by an agent.

    version
    String.
    Specifies the version of the queue manager.

    level
    String.
    Specifies the build level on which the queue manager is running.

    statusPublicationRate
    Integer.
    Specifies the rate, in seconds, that the agent publishes its status.
    The default value for this attribute is 300 seconds.

    statusPublishTime
    String.
    Specifies the time at which the agent published its status, in Universal Time Constant format.

    maximumQueuedTransfers
    Integer.
    Specifies the maximum number of pending transfers that can be queued by an agent until the agent rejects a new transfer request.
    The default value for this attribute is 1000.

    maximumQueuedTransfers
    Integer.
    Specifies the maximum number of pending transfers that can be queued by an agent until the agent rejects a new transfer request.
    The default value for this attribute is 1000

    maximumDestinationTransfers
    Integer.
    Specifies the maximum number of concurrent transfers that the destination agent processes at any given point in time.
    The default value for this attribute is 25.

    maximumSourceTransfers
    Integer.
    Specifies the maximum number of concurrent transfers that the source agent processes at any given point in time.
    The default value for this attribute is 25.

    operatingSystem
    String
    Specifies the operating system where the agent queue manager is created.


qmgrConnection

This object provides information about the queue manager connections.

    qmgrName
    String.
    Specifies the name of the agent queue manager.

    transportType
    String.
    Specifies the transport type in which the agent is connecting with the queue manager. The transport type can be client or bindings.
    The default value is bindings.

    host
    String.
    Specifies the agent queue manager host name; applicable only if transportType is client.

    port
    Integer.
    Specifies the agent queue manager channel communication port; applicable only if transportType is client.

    channelName
    String.
    Specifies the agent queue manager channel; applicable only if transportType is client.
    The default value for this attribute is SYSTEM.DEF.SVRCONN

    standbyHost
    String.
    Specifies the host name used by client connections to connect to the standby instance of a multi-instance agent queue manager.

    standbyPort
    Integer.
    Specifies the port number through which a client can connect to the standby instance of a multi-instance agent queue manager.
    The default value for this attribute is -1.


connectDirectBridge

This object provides information about to connect direct bridge type agent. For other type of agents this object is not added.

    nodeName
    String.
    Specifies the name of the Connect:Direct node to use to transfer messages from this agent to the destination Connect:Direct nodes.

    host
    String.
    Specifies the host name or IP address of the system where the Connect:Direct node, specified by the -cdNode parameter, is located.
    If we do not specify the -cdNodeHost parameter, a default of the host name or IP address of the local system is used.
    The default value for this attribute are the details of the host where it is configured, for example, localhost.

    port
    Integer.
    Specifies the port number of the Connect:Direct node that client applications use to communicate with the node.
    The default value for this attribute is 1363.


protocolBridge

This object provides information about protocol bridge type agent. For other type of agents this object is not added.

    endpoint
    String.
    Specifies the number of endpoints the bridge can support.
    The default value for this attribute is multiple from Version 7.0.1.

    defaultServer
    String.
    Specifies the host name or IP address of the default protocol server if it is set. If the default protocol field is not set, this value is blank.
    The value is a complete string containing the protocol type, server, and port, in the following format:
    <protocolType>://<serverName or IP address>:<port>
    For example:
    "ftp://localhost:21"


standbyInstance

This object provides information about the status of the standby instance, and is present only if the agent is enabled as highly available.

    host
    String
    Specifies the agent queue manager host name.

    version
    String.
    Specifies the version of the queue manager. The version must be 9.1.4.0 or higher.

Parent topic: GET


Related reference


Related information