mqsireportproperties command

• Windows
• Linux® and UNIX systems
• z/OS®. Run this command by customizing and submitting BIPRPPR; see Contents of the integration node PDSE.

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.

• Before you run the mqsireportproperties command, ensure that the integration node is running.
• If you use the mqsichangeproperties command to change any value, the change is applied only after you stop and restart the integration node or integration server.
• If you run the mqsireportproperties command after changing properties, but before you restart the integration node or integration server, the command shows the changed value, even though that value is not yet in effect.
• If you want to view a resource manager for a configurable service, and that resource manager requires WebSphere® MQ, a queue manager must be associated with the integration node before you run the mqsireportproperties command. For a list of features that require WebSphere MQ, see Enhanced flexibility in interactions with WebSphere MQ.

integrationNodeName

(Required) The name of the integration node.

-b ComponentName

(Optional) The name of the component selected. Valid values are httplistener, securitycache, cachemanager, pubsub, webadmin, agent.

-c ConfigurableService

(Optional) The type of the configurable service. Specify a value of AllTypes to report on all configurable service types.

For a list of supplied configurable services, and their properties and values, see Configurable services properties.

-e integrationServerName

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

-o ObjectName

(Required) The name of the object 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 have 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 have specified with -b or -e.
• Specify the name of a configurable service (predefined or user-defined) of a type that you have specified with -c.
  For example:

  • -c EISProviders with SAP, Siebel, or PeopleSoft for a predefined WebSphere Adapters configurable service.
  • -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 have specified with -e. Nested property information can be displayed by specifying a / for each level required in the structure.
  For example:

  • -o Connectors/MQTT to display only the property information related to the connection provider MQTT.
• Specify DynamicSubscriptionEngine for inter-integration node communications properties for the integration server that you have specified with -e. These properties apply to integration node that you have configured in collectives, or cloned.
• 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 and SOAP nodes that you have 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 have specified with -e; one of HTTPListener, HTTPConnector, or HTTPSConnector. Values are defined for all HTTP and SOAP nodes that you have 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 have specified with -b.
• Specify TCPIP to display statistics for each TCPIPClient configurable service or TCPIPServer configurable service that is currently being used by a deployed message flow on the integration server that you specified with the -e parameter; see Examples: Displaying properties associated with objects.
• 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 a value of AllReportableEntityNames to return a list of all valid object names.

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

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

-p 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

(Optional) This parameter is valid only if you specify an integration server level object.

You can use this parameter only when the integration server is in the stopped state, and you must also specify -e and -o.

If you specify this parameter for other configurable services or components, an error is generated.

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 the mqsireportproperties command unless you have changed 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 configurable services
• Examples: Displaying properties associated with objects