See information about the latest product version
mqsireportproperties command
Use the mqsireportproperties command to display properties that relate to a broker, an execution group, or a configurable service.
You can also use the WebSphere® Message Broker Explorer to create and view configurable services. See Using the WebSphere Message Broker Explorer to work with configurable services for more information.
Supported platforms
- Windows
- Linux and UNIX systems
- z/OS®. Run this command by customizing and submitting BIPRPPR; see Contents of the broker PDSE.
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, the change is applied only after you stop and restart the broker or execution group.
- If you run the mqsireportproperties command after changing properties, but before you restart the broker or execution group, the command shows the changed value, even though that value is not yet in effect.
Syntax
>>-mqsireportproperties--BrokerName-----------------------------> >--+---------------------------+-- -o --ObjectName--------------> +- -b --ComponentName-------+ +- -e --ExecutionGroupLabel-+ '- -c --ConfigurableService-' >--+- -n --PropertyName-+--+----------------+--+-----+--------->< +- -a----------------+ '- -p --FileName-' '- -f-' '- -r----------------'
Parameters
- BrokerName
- (Required) The name of the broker.
- -b ComponentName
- (Optional) The name of the component selected. Valid values are httplistener, securitycache, cachemanager, webadmin, and servicefederation.
- -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 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.
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 broker registry parameters.
- 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 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 broker.
You can set a parameter to disable or enable the broker-wide listener for HTTP and SOAP nodes; by default, this listener is active and is used for HTTP nodes. SOAP nodes use the execution group (embedded) listener by default.
- Specify a communications object for the execution group 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 execution group.
You can configure the execution group such that all HTTP nodes use the embedded listener instead of the broker-wide listener. You can also configure the execution group so that SOAP nodes use the broker-wide listener. For more information, see HTTP listeners.
- 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 SecurityCache for properties for the securitycache component that you have specified with -b.
- Specify an object for the servicefederation component that you have specified with -b; one of scmp, HTTPConnector, or HTTPSConnector. The properties apply to the broker HTTP(S) port that processes Service Federation Management (SFM) SCMP Atom requests.
- Specify ServiceFederationManager for properties involved in the creation of an SFM proxy for the execution group that you have specified with -e.
- Specify ComIbmActivityLogManager for Activity log properties for the execution group that you have specified with -e. See Viewing and setting runtime properties for Activity logs.
- Specify Connectors for
all of the connection properties for the execution group 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 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 execution
group level object.
You can use this parameter only when the execution group 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.
Authorization
- Security requirements for Linux and UNIX platforms
- Security requirements for Windows systems
- Security requirements for z/OS
Responses
- HTTPConnector
- PortNumber = 7800
- HTTPSConnector
- PortNumber = 7843
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.
- Check if the broker-wide listener is active for deployed
HTTP and SOAP nodes in one or more execution groups:
mqsireportproperties MB8BROKER -b httplistener -o HTTPListener -n startListener
- Display the properties for the
cache manager:
mqsireportproperties MB8BROKER -b cachemanager -o CacheManager -r
- Display all the current HTTPListener settings associated with
HTTP and SOAP nodes (defined in the httplistener component):
mqsireportproperties MB8BROKER -b httplistener -o HTTPListener -a
- Display the HTTPSConnector port setting for the HTTP nodes (defined
in the httplistener component):
mqsireportproperties MB8BROKER -b httplistener -o HTTPSConnector -n port
- Display all Service Federation object properties
and their values:
mqsichangeproperties MB8BROKER -b servicefederation -o AllReportableEntityNames -r
Displaying properties associated with execution groups
The following examples include the -e parameter to specify the execution group to view.
- Display the FTE agent name for execution
group FTESAMPLE in broker MB8BROKER:
If the agent has been created, the command returns the agent name. If the agent has not been created, the command returns an empty string.mqsireportproperties MB8BROKER -e FTESAMPLE -o FTEAgent -n agentName
- Check if the deployed HTTP nodes are using the execution
group embedded listener:
mqsireportproperties MB8BROKER -e exgroup1 -o ExecutionGroup -n httpNodesUseEmbeddedListener
- Check if the deployed SOAP nodes are using the execution
group (embedded) listener:
mqsireportproperties MB8BROKER -e exgroup1 -o ExecutionGroup -n soapNodesUseEmbeddedListener
- Display the properties that control the creation
of an SFM proxy for an execution group that is to be used as an SFM
Connectivity Provider:
The result of this command has the following format:mqsireportproperties MB8BROKER -e exgroup1 -o ServiceFederationManager -a
ServiceFederationManager uuid='ServiceFederationManager' userTraceLevel='none' traceLevel='none' userTraceFilter='none' traceFilter='none' port='8811' securePort='8844' maxWaitTime='180' proxyURLHostName=' mbhost.ibm.com ' proxyPathPrefix='proxy' proxyPathPrefixesEnabled='TRUE' creationTime='2009-09-11 15:37:52.639219' nextProxyPathPrefixCount='8' ownedProxyGroupCount='2'
Displaying properties associated with configurable services
The following examples include the -c parameter to specify the configurable service to view. For a list of supplied configurable services, and their properties and values, see Configurable services properties.
- Display all Aggregation configurable services:
mqsireportproperties MB8BROKER -c Aggregation -o AllReportableEntityNames -r
- Display all configurable services
for Connect:Direct® server (that you have
defined to this broker with the mqsicreateconfigurableservice command)
The result of this command has the following format:mqsireportproperties MB8BROKER -c CDServer -o AllReportableEntityNames -r
CDServer Default hostname='localhost' port='1363' brokerPathToStagingDir='' cdPathToStagingDir='' brokerPathToInputDir='' cdPathToInputDir='' queuePrefix= '' securityIdentity=”Default”
- Display all properties of the FtpServer
configurable service called TEST1:
mqsireportproperties MB8BROKER -c FtpServer -o TEST1 -r
- Display the protocol property
setting of the FtpServer configurable service called TEST1:
mqsireportproperties MB8BROKER -c FtpServer -o TEST1 -n protocol
- Report the properties of the Oracle JDBCProvider configurable
service:
mqsireportproperties MB8BROKER -c JDBCProviders -o Oracle -r
- 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 MB8BROKER -c JMSProviders -o AllReportableEntityNames -r
- Display the properties for all the JMS provider resources of WebSphere MQ.
mqsireportproperties MB8BROKER -c JMSProviders -o WebSphere_MQ -r
- Display the properties for all the JMS provider resources (default
JMS provider resources and those configurable services that you have
defined to this broker with the mqsicreateconfigurableservice command):
The result of this command has the following format:mqsireportproperties MB8BROKER -c JMSProviders -o BEA_WebLogic –r
ReportableEntityName='' JMSProviders BEA_Weblogic='' jarsURL='default_Path' nativeLibs='default_Path' proprietaryAPIAttr1='weblogic.jndi.WLInitialContextFactory' proprietaryAPIAttr2='t3://9.20.94.16:7001' proprietaryAPIAttr3='BEAServerName' proprietaryAPIAttr4='default_none' proprietaryAPIAttr5='default_none'proprietaryAPIHandler='BEAWebLogicAPIHandler.jar'
- Export policy set Policy_2 in broker MB8BROKER to file policyset.xml:
You can use the output file to move policy sets between brokers, and for backup.mqsireportproperties MB8BROKER -c PolicySets -o Policy_2 -n ws-security -p policyset.xml
- Export a policy set bindings from a broker to a file:
This command writes the Policy Set Bindings file Bindings_2 in broker MB8BROKER to file bindings.xml. You can use this file to move policy set bindings between brokers, and for backup.mqsireportproperties MB8BROKER -c PolicySetBindings -o Bindings_2 -n ws-security -p bindings.xml
- Display the properties for all the security profiles (default
security profiles and any that you have defined on this broker by
using the mqsicreateconfigurableservice command):
The result of this command has the following format:mqsireportproperties MB8BROKER -c SecurityProfiles -o AllReportableEntityNames -r
ReportableEntityName='' SecurityProfiles Default_Propagation='' authentication = 'NONE' authenticationConfig = '' authorization = 'NONE' authorizationConfig = '' idToPropagateToTransport = 'Message ID' keyStore = 'Reserved for future use' mapping = 'NONE' mappingConfig = '' passwordValue = 'PLAIN' propagation = 'TRUE' rejectBlankpassword = 'FALSE' transportPropagationConfig = '' trustStore = 'Reserved for future use'
- Display the properties for the security profile called MyFirstSecurityProfile:
The result of this command has the following format:mqsireportproperties MB8BROKER -c SecurityProfiles -o MyFirstSecurityProfile -r
ReportableEntityName='' SecurityProfiles MyFirstSecurityProfile='' authentication = 'LDAP' authenticationConfig = 'ldap://localhost:389/ou=users,o=ibm' authorization = 'NONE' authorizationConfig = '' idToPropagateToTransport = 'Message ID' keyStore = 'Reserved for future use' mapping = 'TFIM' mappingConfig = 'http://tfimhost1:80' passwordValue = 'PLAIN' propagation = 'TRUE' rejectBlankpassword = 'FALSE' transportPropagationConfig = '' trustStore = 'Reserved for future use'