mqsireportproperties command

• Windows
• Linux®
• AIX®
• IBM® z/OS® Container Extensions (zCX). Run this command by modifying and submitting the supplied JCL or by using an IBM z/OS console command.

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

• If the integration node or integration server is stopped, use the --offline parameter to view the persisted values.
• If you run the mqsireportproperties command to show integration node properties the values that are reported are the persisted values. The persisted values might be different from the values in use by the integration node if the mqsichangeproperties command was used to change property values since the integration node was started.

integrationNodeName

(Required) The name of the integration node.

-b |--component ComponentName

(Optional) The name of the component selected. Valid values are BrokerRegistry,NodeHttpListener, SecurityCache, RestAdminListener, Events, Service .

-c |--configurable-service policy-type

(Optional) Allows properties on policies that are defined on the integration node to be viewed. This option cannot be used to view policies that are deployed to an integration server. The 'policy-type' must be the short name for the type of policy to be changed; for example, JMSProviders for the JMS Providers policy type.

For a list of supplied policies, and their properties and values, see Policy properties.

-e | --integration-server integrationServerName

(Optional) The label of the integration server for which a report is required.

-o | --object ObjectName

(Required) The name of the object or policy whose properties you want to read.

You must also specify -b, -e, or -c after -o, except if you specify the object name BrokerRegistry.

Set ObjectName to match other parameters:

• Specify BrokerRegistry for integration node registry parameters.
• Specify CallableFlowManager for properties of callable message flows that are registered with the specified integration server.
• Specify ComIbmActivityLogManager for Activity Log properties for the integration server that you specified with -e. See Viewing and setting runtime properties for activity logs.
• Specify ComIbmJVMManager for JVM settings of the agent, HTTP listener, or integration server that you specified with -b or -e.
• Specify the name of a policy (predefined or user-defined) of a type that you specified with -c.
  For example,

  • -c EISProviders with SAP, Siebel, or PeopleSoft for a predefined WebSphere® Adapters policy.
  • -c JMSProviders with the name of a predefined or user-defined service, for example, WebSphere_MQ.
• Specify Connectors for all of the connection properties for the integration server that you specified with -e. Nested property information can be displayed by specifying a / for each level that is required in the structure.
  For example,

  • -o Connectors/MQTT to display only the property information that is related to the connection provider MQTT.
• Specify DynamicSubscriptionEngine for inter-integration node communications properties for the integration server that you specified with -e. These properties apply to integration node that you configured in collectives, or cloned.
• Specify a communications object for the NodeHttpListener component that you specified with -b. Specify one of HTTPListener, HTTPConnector, or HTTPSConnector. Values are defined for all HTTP and SOAP nodes that you deployed to the integration node.

  You can set a parameter to disable or enable the integration node listener for HTTP and SOAP nodes. By default, this listener is active and is used for HTTP nodes. SOAP nodes use the integration server (embedded) listener by default.

• Specify a communications object for the integration server that you specified with -e. Specify one of HTTPListener, HTTPConnector, or HTTPSConnector. Values are defined for all HTTP and SOAP nodes that you deployed to the specified integration server.

  You can configure the integration server such that all HTTP nodes use the embedded listener instead of the integration node listener. You can also configure the integration server so that SOAP nodes use the integration node listener. For more information, see HTTP listeners.

• Specify SecurityCache for properties for the securitycache component that you specified with -b.
• Specify ExceptionLog to display the values of properties that relate to the exception log on the integration server that you specified with the -e parameter.
• Specify ComIbmIIBSwitchManager to display the values of the properties that relate to the switch server. For examples, see Examples: Displaying properties associated with integration servers.

Specify a value of AllReportableEntityNames to return a list of all valid object names.

-n | --property PropertyName

(Optional) Display only the named property.

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

-a | --all-properties

(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 | --recursive

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

This option does not show all the possible values for AllReportableEntityNames. Furthermore, not all entities support this parameter.

-p | --output-file FileName

(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.

-f | --offline

(Optional) Retrieves the persisted properties without communicating with the integration node or integration server. The values that are returned might be different from the properties currently in use.

--trace traceFileName

(Optional) Use this parameter send verbose internal trace to the specified file.

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

For the NodeHttpListener component, the mqsireportproperties command does not report those properties that are not 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 was changed) is 7083. However, this value is not reported by the mqsireportproperties command unless you change it from this default by using the mqsichangeproperties command. To see the default values for all properties that the mqsireportproperties command can report, see the mqsichangeproperties command description.

• Examples: Displaying properties associated with integration node components
• Examples: Displaying properties associated with integration servers
• Examples: Displaying properties associated with policies