mqsireportproperties command

Use the mqsireportproperties command to display properties that relate to a broker or its associated configurable services.

Supported platforms

Purpose

Use the mqsireportproperties command to examine the values of properties or broker resources that are set by using the mqsichangeproperties command, or created by using the mqsicreateconfigurableservice command.

Usage notes

  • Before you run the mqsireportproperties command, ensure that the broker is running.
  • If you use the mqsichangeproperties command to change any value, stop and restart the broker for the change to take effect.

Syntax

Parameters

BrokerName
(Required) The name of the broker.

-b httplistener
(Optional) The name of the component.

Start of changeYou must specify -b httplistener, -c ConfigurableService, or -e ExecutionGroupLabel.End of change

-c ConfigurableService
(Optional) The type of the configurable service, such as JMSProviders. Specify a value of AllTypes to report on all configurable service types.

Start of changeYou must specify -b httplistener, -c ConfigurableService, or -e ExecutionGroupLabel.End of change

-e ExecutionGroupLabel
(Optional) The label of the execution group for which a report is required.

-o ObjectName
(Required) The name of the object whose properties you want to read.
Set ObjectName to match other parameters:
  • Specify the name of a configurable service, predefined or user-defined, of a type that you have specified with -c; for example, -c JMSProviders with WebSphere_MQ.
  • Specify a communications object for the httplistener component that you have specified with -b; one of HTTPListener, HTTPConnector, or HTTPSConnector. Values are defined for all HTTP nodes that you have deployed to the broker.
  • Specify DynamicSubscriptionEngine for inter-broker communications properties for the execution group that you have specified with -e. These properties apply to brokers that you have configured in collectives, or cloned.
  • Specify DynamicSubscriptionEngine for all Real-time nodes that you have deployed to the execution group that you have specified with -e.

Specify a value of AllReportableEntityNames to return a list of all valid object names. If you run the mqsireportproperties command on the command line without any properties, the AllReportableEntityNames is used.

-n PropertyName
(Optional) Display only the named property.

You must select only one option from -n, -a, and -r.

-a
(Optional) Indicates that all property values of the object are displayed, and does not act in a recursive manner on properties that have child values.

-r
(Optional) Indicates that all property values of the object are displayed and, additionally, displays the child values for all properties that have child values.

Start of change-p FileNameEnd of change
Start of change(Optional) The location and name of the file to which the command writes all selected properties. If you do not specify -n, the property values, but not the property names, are written.

End of change

For more information about objects, properties, and values, and valid combinations of these parameters, see mqsichangeproperties command.

For the httplistener component, the mqsireportproperties command does not report those properties that have not been explicitly set with the mqsichangeproperties command, even if those properties have a default setting.

For example, the default HTTPSConnector port that is used (unless it has been changed) is 7083. However, this value is not reported by mqsireportproperties unless you have changed it from this default with mqsichangeproperties. To see the default values for all properties that mqsireportproperties can report, see the mqsichangeproperties command description.

Authorization

No specific authority is required to run this command.

Examples

Always enter the command on a single line; in some examples, a line break has been added to enhance readability.

Displaying properties associated with broker components

The following examples include the -b parameter to specify the component to view.

  • Display all the current HTTPListener settings associated with HTTP nodes (defined in the httplistener component):
    mqsireportproperties TEST -b httplistener -o HTTPListener -a
  • Display the HTTPSConnector port setting for the HTTP nodes (defined in the httplistener component):
    mqsireportproperties TEST -b httplistener -o HTTPSConnector -n port

Displaying properties associated with execution groups

The following example includes the -e parameter to specify the execution group to view.

  • Display recursively all the current settings for the interbroker communication:
    mqsireportproperties TEST -e default -o DynamicSubscriptionEngine -r

Displaying properties associated with configurable services

The following examples include the -c parameter to specify the configurable service to view.

  • Display the properties for all the broker's JMS provider resources (default JMS provider resources and those configurable services that you have defined by using the mqsicreateconfigurableservice command):
    mqsireportproperties WBRK6_DEFAULT_BROKER -c JMSProviders 
         -o AllReportableEntityNames -r
  • Display the properties for all the JMS provider resources of WebSphere® MQ.
    mqsireportproperties WBRK6_DEFAULT_BROKER -c JMSProviders 
         -o WebSphere_MQ -r
Related concepts
Broker domains
Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2009Copyright IBM Corporation 1999, 2009. All Rights Reserved.
Last updated : 2009-01-07 15:40:46

an09150_