IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

mqsireportproperties command

Use the mqsireportproperties command to display properties that relate to a broker, an integration server, or a configurable service.

You can also use the IBM® Integration Explorer to create and view configurable services. See Using the IBM Integration 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 integration server.
If you run the mqsireportproperties command after changing properties, but before you restart the broker or integration server, the command shows the changed value, even though that value is not yet in effect.

Syntax


>>-mqsireportproperties--BrokerName----------------------------->

>--+------------------------------+-- -o --ObjectName----------->
   +- -b --ComponentName----------+                     
   +- -e --IntegrationServerLabel-+                     
   '- -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 or webadmin.

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

(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 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 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 broker-wide listener. You can also configure the integration server so that SOAP nodes use the broker-wide listener. For more information, see HTTP listeners.
Specify DynamicSubscriptionEngine for inter-broker communications properties for the integration server 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 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 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 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.

Authorization

For information about platform-specific authorizations, see the following topics:

If you have enabled broker administration security, you must also set up the authority detailed in Tasks and authorizations for administration security.

Responses

Responses are of the form:

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 integration servers:
```
mqsireportproperties IB9NODE -b httplistener -o HTTPListener -n startListener
```

Display the properties for the cache manager:

mqsireportproperties IB9NODE -b cachemanager -o CacheManager -r

Display all the current HTTPListener settings associated with HTTP and SOAP nodes (defined in the httplistener component):
```
mqsireportproperties IB9NODE -b httplistener -o HTTPListener -a
```
Display the HTTPSConnector port setting for the HTTP nodes (defined in the httplistener component):
```
mqsireportproperties IB9NODE -b httplistener -o HTTPSConnector -n port
```
Display the HTTPSConnector settings associated with the webadmin component:
```
mqsireportproperties IB9NODE -b webadmin -o HTTPSConnector -r
```

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 IB9NODE -c Aggregation -o AllReportableEntityNames -r

Display all configurable services for Connect:Direct® server (that you have defined to this broker with the mqsicreateconfigurableservice command)

mqsireportproperties IB9NODE -c CDServer -o AllReportableEntityNames -r

The result of this command has the following format:

CDServer
  Default
    hostname='localhost'
    port='1363'
    brokerPathToStagingDir=''
    cdPathToStagingDir=''
    brokerPathToInputDir=''
    cdPathToInputDir=''
    queuePrefix= ''
    securityIdentity=”Default”

Display all properties of the FtpServer configurable service called TEST1:
```
mqsireportproperties IB9NODE -c FtpServer -o TEST1 -r
```
Display the protocol property setting of the FtpServer configurable service called TEST1:
```
mqsireportproperties IB9NODE -c FtpServer -o TEST1 -n protocol
```
Report the properties of the Oracle JDBCProvider configurable service:
```
mqsireportproperties IB9NODE -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 IB9NODE -c JMSProviders 
     -o AllReportableEntityNames -r
```
Display the properties for all the JMS provider resources of WebSphere MQ.
```
mqsireportproperties IB9NODE -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):

mqsireportproperties IB9NODE -c JMSProviders 
     -o BEA_WebLogic –r

The result of this command has the following format:

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 IB9NODE to file policyset.xml:
```
mqsireportproperties IB9NODE -c PolicySets 
     -o Policy_2 -n ws-security -p policyset.xml
```
You can use the output file to move policy sets between brokers, and for backup.
Export a policy set bindings from a broker to a file:
```
mqsireportproperties IB9NODE -c PolicySetBindings 
     -o Bindings_2 -n ws-security -p bindings.xml
```
This command writes the Policy Set Bindings file Bindings_2 in broker IB9NODE to file bindings.xml. You can use this file to move policy set bindings between brokers, and for backup.

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):

mqsireportproperties IB9NODE -c SecurityProfiles 
     -o AllReportableEntityNames -r

The result of this command has the following format:

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:

mqsireportproperties IB9NODE -c SecurityProfiles 
     -o MyFirstSecurityProfile -r

The result of this command has the following format:

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'

an09150_.htm |

Last updated Friday, 21 July 2017