DISPLAY TCLUSTER

Use the MQSC command DISPLAY TCLUSTER to display the attributes of the IBM MQ cluster topic object.


Use MQSC commands

For information on how we use MQSC commands, see Performing local administration tasks using MQSC commands.

We can issue this command from sources 2CR. For an explanation of the source symbols, see Sources from which we can issue MQSC commands on z/OS .

The DISPLAY TCLUSTER command produces the same output as the DISPLAY TOPIC TYPE(CLUSTER) command.

See DISPLAY TOPIC for further information.

Synonym: DIS TCLUSTER


DISPLAY TCLUSTER

DISPLAY TCLUSTER ( generic-topic-name ) WHERE(FilterCondition)ALLCMDSCOPE(' ')CMDSCOPE(qmgr-name)1CMDSCOPE(*)12QSGDISP(LIVE)QSGDISP(ALL)QSGDISP(QMGR)QSGDISP(COPY)QSGDISP(GROUP)1QSGDISP(PRIVATE) CLUSTER ( generic name ) requested attrsRequested attrs,CLROUTECLSTATECLUSDATECLUSQMGRCLUSTIMEQMIDNotes:

  • 1 Valid only on z/OS when the queue manager is a member of a queue sharing group.
  • 2 Valid only on z/OS.


Parameter descriptions for DISPLAY TCLUSTER

We must specify the name of the cluster topic definition we want to display. This name can be a specific cluster topic name or a generic cluster topic name. By using a generic topic name, we can display either:

    (generic-topic-name)
    The name of the administrative cluster topic definition to be displayed (see Rules for naming IBM MQ objects ). A trailing asterisk (*) matches all administrative topic objects with the specified stem followed by zero or more characters. An asterisk (*) on its own specifies all administrative topic objects.

    WHERE
    Specify a filter condition to display only those administrative topic object definitions that satisfy the selection criterion of the filter condition. The filter condition is in three parts: filter-keyword, operator, and filter-value:

      filter-keyword
      Almost any parameter that can be used to display attributes for this DISPLAY command.
      However, we cannot use the CMDSCOPE, or QSGDISP parameters as filter keywords.

      operator
      This part is used to determine whether a topic object satisfies the filter value on the given filter keyword. The operators are:

        LT
        Less than

        GT
        Greater than

        EQ
        Equal to

        NE
        Not equal to

        LE
        Less than or equal to

        GE
        Greater than or equal to

        LK
        Matches a generic string that you provide as a filter-value

        NL
        Does not match a generic string that you provide as a filter-value

      filter-value
      The value that the attribute value must be tested against using the operator. Depending on the filter-keyword, this value can be:

      • An explicit value, that is a valid value for the attribute being tested.

        We can use operators LT, GT, EQ, NE, LE, or GE only. However, if the attribute value is one from a possible set of values on a parameter, we can use only EQ or NE.

      • A generic value. This value is a character string (such as the character string you supply for the DESCR parameter) with an asterisk at the end, for example ABC*. If the operator is LK, all items where the attribute value begins with the string (ABC in the example) are listed. If the operator is NL, all items where the attribute value does not begin with the string are listed. Only a single trailing wildcard character (asterisk) is permitted.

        We cannot use a generic filter-value for parameters with numeric values or with one of a set of values.

    Note: On z/OS there is a 256 character limit for the filter-value of the MQSC WHERE clause. This limit is not in place for other platforms.

    ALL
    Specify this parameter to display all the attributes. If this parameter is specified, any attributes that are requested specifically have no effect; all attributes are still displayed.

    This is the default if we do not specify a generic name, and do not request any specific attributes.

    CMDSCOPE
    This parameter applies to z/OS only and specifies how the command runs when the queue manager is a member of a queue sharing group. CMDSCOPE must be blank, or the local queue manager, if QSGDISP is set to GROUP.

      ' '
      The command runs on the queue manager on which it was entered. This value is the default value.

      qmgr-name
      The command runs on the queue manager you specify, providing the queue manager is active within the queue sharing group.

      We can specify a queue manager name, other than the queue manager on which the command was entered, only if we are using a queue sharing group environment and if the command server is enabled.

      *
      The command runs on the local queue manager and is also passed to every active queue manager in the queue sharing group. The effect of this process is the same as entering the command on every queue manager in the queue sharing group.

    We cannot use CMDSCOPE as a filter keyword.

    QSGDISP
    Specifies the disposition of the objects for which information is to be displayed. Values are:

      LIVE
      LIVE is the default value and displays information for objects defined with QSGDISP(QMGR) or QSGDISP(COPY).

      ALL
      Display information for objects defined with QSGDISP(QMGR) or QSGDISP(COPY).

      If there is a shared queue manager environment, and the command is being executed on the queue manager where it was issued, this option also displays information for objects defined with QSGDISP(GROUP).

      If QSGDISP(ALL) is specified in a shared queue manager environment, the command might give duplicated names (with different dispositions).

      In a shared queue manager environment, use 
      DISPLAY TOPIC(name) CMDSCOPE(*) QSGDISP(ALL)
      to list ALL objects matching name in the queue sharing group without duplicating those objects in the shared repository.

      COPY
      Display information only for objects defined with QSGDISP(COPY).

      GROUP
      Display information only for objects defined with QSGDISP(GROUP). This is allowed only if there is a shared queue manager environment.

      PRIVATE
      Display information only for objects defined with QSGDISP(QMGR) or QSGDISP(COPY). QSGDISP(PRIVATE) displays the same information as QSGDISP(LIVE).

      QMGR
      Display information only for objects defined with QSGDISP(QMGR).

      QSGDISP
      QSGDISP displays one of the following values:

        QMGR
        The object was defined with QSGDISP(QMGR).

        GROUP
        The object was defined with QSGDISP(GROUP).

        COPY
        The object was defined with QSGDISP(COPY).

      We cannot use QSGDISP as a filter keyword.

    CLUSTER
    Displays topics with the specified cluster name. The value can be a generic name.


Requested attributes

    CLROUTE
    The routing behavior to use for topics in the cluster defined by the CLUSTER parameter.

    CLSTATE
    The current state of this topic in the cluster defined by the CLUSTER parameter. The values can be as follows:

      ACTIVE
      The cluster topic is correctly configured and being adhered to by this queue manager.

      PENDING
      Only seen by a hosting queue manager, this state is reported when the topic has been created but the full repository has not yet propagated it to the cluster. This might be because the host queue manager is not connected to a full repository, or because the full repository has deemed the topic to be invalid.

      INVALID
      This clustered topic definition conflicts with an earlier definition in the cluster and is therefore not currently active.

      ERROR
      An error has occurred with respect to this topic object.

    This parameter is typically used to aid diagnosis when multiple definitions of the same clustered topic are defined on different queue managers, and the definitions are not identical. See Routing for publish/subscribe clusters: Notes on behavior.

    CLUSDATE
    The date on which the information became available to the local queue manager, in the form yyyy-mm-dd.

    CLUSQMGR
    The name of the queue manager that hosts the topic.

    CLUSTIME
    The time at which the information became available to the local queue manager, in the form hh.mm.ss.

    QMID
    The internally generated unique name of the queue manager that hosts the topic.


Usage notes for DISPLAY TCLUSTER

  1. On z/OS, the channel initiator must be running before we can display information about cluster topics.
  2. The TOPICSTR parameter might contain characters that cannot be translated into printable characters when the command output is displayed.

    On z/OS, these non-printable characters are displayed as blanks.

    On Multiplatforms using the runmqsc command, these non-printable characters are displayed as dots.

Parent topic: MQSC commands


Related reference