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

mqsichangeproperties command

Use the mqsichangeproperties command to modify broker properties and properties of broker resources.

Supported platforms

Windows systems.
Linux and UNIX systems.
z/OS®. Run this command by customizing and submitting the BIPCHPR utility; see Contents of the broker PDSE.

Purpose

Use the mqsichangeproperties command to change properties that are associated with a broker:

Properties that affect the whole broker; for example, an HTTP listener
Properties that affect one or more integration servers; for example, the broker registry
Properties that affect a configurable service; for example, a JMS provider

You can also use the IBM® Integration Explorer or the IBM Integration API (also known as the CMP) to change properties.

Use the mqsireportproperties command to view properties that are associated with a broker.

Usage notes

For most parameters of the mqsichangeproperties command, you must ensure that the broker is running before you run the command. However, you can issue the -f parameter for a broker that is running or stopped.
If you change one or more values, stop and start the broker again for the change to take effect. This step does not apply to all configurable services. Check the documentation for the specific configurable service type. The documentation specifies when restarting the broker is necessary.
When a message flow that includes HTTP nodes is started, the broker starts the HTTP and HTTPS listeners, unless this listener has been disabled.

Syntax


>>-mqsichangeproperties--BrokerName----------------------------->

>--+------------------------------+-- -o --ObjectName----------->
   +- -b --ComponentName----------+                     
   +- -c --ConfigurableService----+                     
   '- -e --IntegrationServerLabel-'                     

>-- -n --PropertyName--+- -v --PropertyValue-+--+-----+--------><
                       +- -p --Path.FileName-+  '- -f-'   
                       '- -d ----------------'

Parameters

BrokerName: (Required) The name of the broker to modify. This parameter must be the first parameter.
-b ComponentName: (Optional) The name of the component. Valid values are httplistener, securitycache, cachemanager, webadmin, crlFile. The properties associated with these components affect the whole broker.
-c ConfigurableService: (Optional) The type of configurable service. The type is predefined; for example, JMSProviders. You can define additional services of all defined types by using the IBM Integration Explorer or the mqsicreateconfigurableservice command.
The valid resource types are listed in Configurable services properties.
-e IntegrationServerLabel: (Optional) The label of the integration server for which you want to change properties.

-o ObjectName

(Required) The name of the broker resource for which you want to change the properties.

You must also specify -b, -e, or -c with -o, except if you specify the object name BrokerRegistry, or the object name ComIbmJVMManager to change a property related to the heap size.

For compatibility with previous versions, you can also specify the value ComIbmXmlParserFactory for the ObjectName.

-n PropertyName

(Required) The name of the property to be changed. The available property names differ according to the component or configurable service that you have specified. All property names start with a lowercase character. The property name must be a valid XML attribute name; for example, a property name cannot start with a number.

The property names for predefined configurable services are described in Configurable services properties.

If you specify a Configurable Service of type UserDefined, the PropertyName specified is created if it does not exist.

-v PropertyValue

(Required) The value that is assigned to the property that is specified by the -n parameter.

You can specify more than one property name together with a corresponding value, by using commas as separators, if you use a valid value for the corresponding property; for example, -n Name1,Name2 -v Value1,Value2.

Do not leave a space after each comma in the list of names and corresponding values. Use "" to specify an empty PropertyValue string.

If the property value contains a comma, enclose the value with escaped double quotation marks (\" and \"); for example, -n Name1,Name2 -v Value1,\"Value21,Value22\".

On UNIX, if the -v parameter contains a semicolon (;), enclose the entire string in quotation marks, as shown in the following example:

mqsichangeproperties IB9NODE -c JDBCProviders -o DB2EXTRA -n connectionUrlFormat
-v "jdbc:db2://[serverName]:[portNumber]/[databaseName]:user=[user];password=[password];"

If you set the -c parameter to EISProviders or JMSProviders, and the -n parameter to jarsURL, the expected value is a URL that specifies the file location of the EIS or JMS provider JAR files, but omits the file:// part of the URL. (On Windows, the file location cannot be a mapped network drive on a remote Windows computer; the directory must be local or on a Storage Area Network (SAN) disk.)

-p Path.FileName

(Optional) The location and name of a file from which the command reads the property value. Use this command as an alternative to -v where the value of the property is complex and is defined in a file, such as an XML file.

The following conditions apply to the use of this parameter:

-p can be used to set a single property only. Therefore, the -n parameter must have a single property name, not a comma-separated list.
White space characters (including line feed, carriage return, and end of file characters) read from the file are preserved by the command.

Use this parameter for policy sets and bindings.

Use this parameter for monitoring profiles; the XML file must conform to the monitoring profile schema.

-d

(Optional) This parameter is valid only if you specify a configurable service of type UserDefined. If the property that you specify on the -n parameter exists, it is deleted.

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

-f

(Optional) This parameter is valid only if you specify a property of an integration server level object. If the property that you specify on the -n parameter exists, its value is changed to the PropertyValue specified by the -v parameter.

You can use this parameter only when the integration server is in the stopped state. You can use the -f parameter when the broker is running or stopped. You are advised to use this parameter only under the direction of IBM support to recover from integration server startup failures.

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

For detailed information about valid components, configurable services, object names, properties, and values, select the appropriate topic:

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.

Examples

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

Changes to broker components

The following examples specify the -b parameter to identify a particular broker component.

Disable the broker-wide HTTP listener:

mqsichangeproperties IB9NODE -b httplistener -o HTTPListener 
			-n startListener -v false

Enable the broker-wide HTTP listener:

mqsichangeproperties IB9NODE -b httplistener -o HTTPListener 
			-n startListener -v true

Enable the HTTPSConnector for the HTTP nodes deployed to the specified broker that use the broker-wide listener:
```
 mqsichangeproperties IB9NODE -b httplistener -o HTTPListener 
			-n enableSSLConnector -v true
```
Change the default SSL protocol from SSLv3 to TLS for the HTTP nodes that are deployed to the specified broker:
```
mqsichangeproperties IB9NODE  -b httplistener -o HTTPSConnector 
			-n sslProtocol -v TLS 
```
Define CRL processing for HTTP-based input nodes that are deployed to the specified broker using a CRL file located at file_path:
```
mqsichangeproperties IB9NODE -b httplistener -o HTTPSConnector 
			-n crlFile -v file_path
```

Change the securitycache timeout to 200 seconds:

mqsichangeproperties IB9NODE -b securitycache -o SecurityCache 
			-n cacheTimeout -v 200

Disable the web user interface:

mqsichangeproperties IB9NODE -b webadmin -o server 
         -n enabled -v false

Change the port number for the web user interface:
```
mqsichangeproperties IB9NODE -b webadmin -o HTTPSConnector  
         -n port -v new_port_number 
```
You can change this property only when the broker is running, and the change takes effect when the broker is restarted.

Change the JVM heap size for the broker:

mqsichangeproperties IB9NODE -o ComIbmJVMManager 
-n jvmMaxHeapSize -v size_in_bytes

Changes to properties that are associated with integration servers

The following examples include the -e parameter to specify the integration server to change.

Configure the integration server so that all deployed HTTP nodes use the embedded listener:
```
mqsichangeproperties IB9NODE -e exgroup1 -o ExecutionGroup  
	-n httpNodesUseEmbeddedListener -v true
```
If you disable the broker-wide listener (as shown in a previous example), you do not have to change the integration server configuration as shown in this command; if the broker-wide listener is not active, all integration servers use the embedded listener by default for all HTTP message handling.
Configure the integration server properties so that deployed HTTP nodes do not use the embedded listener:
```
mqsichangeproperties IB9NODE -e exgroup1 -o ExecutionGroup  
	-n httpNodesUseEmbeddedListener -v false
```
Configure the integration server so that deployed SOAP nodes use the broker listener rather than the embedded listener:
```
mqsichangeproperties IB9NODE -e exgroup1 -o ExecutionGroup  
	-n soapNodesUseEmbeddedListener -v false
```
Configure the integration server so that deployed SOAP nodes use the embedded listener:
```
mqsichangeproperties IB9NODE -e exgroup1 -o ExecutionGroup  
	-n soapNodesUseEmbeddedListener -v true
```
If you disable the broker-wide listener (as shown in a previous example), you do not have to change the integration server configuration as shown in this command; if the broker-wide listener is not active, all integration servers use the embedded listener by default for all HTTP message handling.
Configure the time to wait before the next message is retrieved from an input node after a message has been rolled back. wait_time is the time to wait in milliseconds.
```
mqsichangeproperties IB9NODE -e exgroup1 -o ExecutionGroup 
-n failedMessageWaitTime -v wait_time
```

Set the port number when changing properties for integration servers:

mqsichangeproperties IB9NODE -e exgroup1 -o HTTPSConnector  
		-n explicitlySetPortNumber -v 7777

Set the list of ciphers allowed by the HTTPS listener of the integration server:
```
mqsichangeproperties IB9NODE -e default 
-o HTTPSConnector -n ciphers 
-v \"SSL_RSA_WITH_RC4_128_MD5,SSL_RSA_WITH_RC4_128_SHA\"
```
On distributed systems, if the property value contains a comma, enclose the value with escaped double quotation marks (\" and \"); for example:
```
-v \"SSL_RSA_WITH_RC4_128_MD5,SSL_RSA_WITH_RC4_128_SHA\"
```
On z/OS, if the property value contains a comma, enclose the value with double quotation marks (" and "); for example:
```
-v "SSL_RSA_WITH_RC4_128_MD5,SSL_RSA_WITH_RC4_128_SHA"
```
Add a certificate revocation list (CRL) file from location file_path for the HTTPS listener of the integration server:
```
mqsichangeproperties IB9NODE -e exgroup1 -n crlFile -v file_path
```
Configure the JVM to automatically download any CRL files (from CRL distribution points that are specified in the CA's digital signature):
```
mqsichangeproperties IB9NODE -e exgroup1 -o ComIbmJVMManager -n enableCRLDP -v true
```

Set the JVM port number to activate message flow debugging:

mqsichangeproperties IB9NODE -e exgroup1 -o ComIbmJVMManager 
	-n jvmDebugPort -v 8018

Change the JVM heap size for the integration server:

mqsichangeproperties IB9NODE -e exgroup1 -o ComIbmJVMManager 
-n jvmMaxHeapSize -v size_in_bytes

Set the type of server keystore:

mqsichangeproperties IB9NODE -e AddressSampleProvider 
	-o ComIbmJVMManager 
	-n keystoreType -v JKS

Set the coordination queue manager to QM2 for integration server myExecutionGroup in broker IB9NODE:
```
mqsichangeproperties IB9NODE -e myExecutionGroup
-o FTEAgent -n coordinationQMgr -v QM2
```
Note: After running this command, you must reload the integration server for the change to take effect.
Set the way XMLNSC serialization renders characters that do not exist in the target code page:
```
mqsichangeproperties IB9NODE -e exgroup1 
-o ComIbmGenericXmlParserFactory -n invalidCharacterEscapeType -v character_type
```
where character_type specifies how to render the character:
- unicode renders the character as {U+XXXX}, where XXXX is the Unicode code point associated with the character. For example, the euro character would be rendered as {U+20AC}.
- hex renders the character as &#xXXXX, where XXXX is the Unicode code point associated with the character. For example, the euro character would be rendered as &#x20AC.
- decimal renders the character as #DDDD, where DDDD is the Unicode code point associated with the character expressed in decimal. For example, the euro character would be rendered as #8364.
Configure the expiry compensation to prevent messages from immediately expiring when put:
```
mqsichangeproperties IB9NODE -e default 
-o ComIbmMQConnectionManager -n expiryCompensation -v option
```
where option specifies if the expiry compensation is active or not:
- false This option is the default value. No adjustment is applied to the expiry
- true This option causes the expiry to be reduced by the amount of time that the message has spent in the flow at the time that the MQPUT call is made by the MQOutput Node.

Changes to the BrokerRegistry object

Set the HTTPConnector Port Range in the broker registry:

mqsichangeproperties IB9NODE -o BrokerRegistry 
	-n httpConnectorPortRange -v 7777-8888

Configure the path to the CRL files that the JVM uses to check certificates, where file_path is a list of paths to CRL files separated by the path separator character for the host operating system.
```
mqsichangeproperties IB9NODE -o BrokerRegistry -n crlFileList -v file_path
```

Changes to configurable services

The following examples include the -c parameter to specify the type of configurable service to change.

Change an Aggregation configurable service:
```
mqsichangeproperties IB9NODE -c Aggregation 
	-o myAggregationService
 -n timeoutSeconds -v 120
```
This command changes all nodes that are configured to use the myAggregationService configurable service by setting the timeout of an aggregation to 120 seconds.
Change a CICSConnection configurable service:
```
mqsichangeproperties IB9NODE -c CICSConnection -o myCICSConnectionService
 -n connectionTimeoutSecs -v 120
```
This command changes the CICSRequest node that is configured to use the myCICSConnectionService configurable service by setting the Connection timeout to 120 seconds.
Change a Collector configurable service:
```
mqsichangeproperties IB9NODE -c Collector 
	-o myCollectorService
 -n collectionExpirySeconds -v 120
```
This command changes all nodes that are configured to use the myCollectorService configurable service by setting the expiry time of collections to 120 seconds.
Change the location of the object reference for all nodes that are configured to use the myCORBAService configurable service. After you run this command, all nodes look for the object reference name "Europe.region/Market.object" in the naming service on the local host on port 2809.
```
mqsichangeproperties IB9NODE -c CORBA -o myCORBAService -n namingService,objectReferenceName -v localhost:2809,Europe.region/Market.object
```
Change an EmailServer configurable service:
```
mqsichangeproperties IB9NODE -c EmailServer -o 
myEmailConfigurableServiceName -n securityIdentity -v 
myNewSecurityIdentityObjectName
```
This command changes the EmailInput node that is configured to use the myEmailConfigurableServiceName configurable service by renaming the securityIdentity object to myNewSecurityIdentityObjectName.
Change the myCDServer configurable service to use a specific staging directory -/tmp/cdtransfer.
Note that you can use any string for the -o Objectname parameter.
```
mqsichangeproperties IB9NODE -c CDServer -o myCDServer -n brokerPathToStagingDir
 -v /tmp/cdtransfer 
```

Make the JAR files and shared libraries available to the WebSphere® Adapter for SAP:

mqsichangeproperties IB9NODE -c EISProviders -o SAP 
	-n jarsURL,nativeLibs 
      -v c:\sapjco\jars,c:\sapjco\bin

For the FtpServer configurable service called TEST1, change the protocol to SFTP and change the server name to winlnx58:

mqsichangeproperties IB9NODE -c FtpServer -o TEST1 
-n protocol,serverName,scanDelay,remoteDirectory,securityIdentity,
cipher,compression,strictHostKeyChecking
-v  SFTP,winlnx58,30,.,chbatey,blowfish-cbc,9,no

Change all the nodes that are configured to use the myIMSConnectService configurable service. After you run this command, all nodes connect to the production system (production.ims.ibm.com) instead of the test system (test.ims.ibm.com).
```
mqsichangeproperties IB9NODE -c IMSConnect 
	-o myIMSConnectService 
	-n Hostname -v production.ims.ibm.com
```
Update the security identity for the JDBCProvider service for Oracle:
```
mqsichangeproperties IB9NODE -c JDBCProviders -o Oracle  

	-n securityIdentity -v OracleDSN
```
OracleDSN is the DSN with which you have associated a user ID and password using the mqsisetdbparms command.

Change the JDBCProvider service myJDBCProvider to use the database schema mySchemaName:

mqsichangeproperties IB9NODE -c JDBCProviders -o myJDBCProvider 
-n databaseSchemaNames -v mySchemaName

Change the JDBCProvider service myJDBCProvider to use a table-specific database schema, where myTableNameA is the name of your database table, and mySchemaName01 is the name of your database schema:
```
mqsichangeproperties IB9NODE -c JDBCProviders -o myJDBCProvider 
-n databaseSchemaNames -v myTableNameA:mySchemaName01
```
Change the JDBCProvider service myJDBCProvider to use the default database schema myDefaultSchemaName, and a table-specific database schema, where myTableNameA is the name of your database table, and mySchemaName01 is the name of your database schema:
```
mqsichangeproperties IB9NODE -c JDBCProviders -o myJDBCProvider 
-n databaseSchemaNames -v myDefaultSchemaName;myTableNameA:mySchemaName01
```

Change the location of the JAR files for the IBM WebSphere MQ JMS client:

mqsichangeproperties IB9NODE -c JMSProviders -o WebSphere_MQ  
      -n jarsURL -v file://D:\SIBClient\Java

Change the value of the properties proprietaryAPIAttr2 and proprietaryAPIAttr3 for a user-defined JMS provider configurable service definition called BEA_Weblogic, where the properties represent the URL of the BEA WebLogic bindings and the DNS name of the JMS server:
```
mqsichangeproperties IB9NODE -c JMSProviders -o BEA_Weblogic
      -n proprietaryAPIAttr2, proprietaryAPIAttr3
      -v t3://9.20.94.16:7001,BEAServerName
```

Change the value of the jndiEnvironmentObject property in the definition of a user-defined JMS provider configurable service called myJMSprovider to add three strings to a vector:

mqsichangeproperties IB9NODE -c JMSProviders -o myJMSprovider
      -n jndiEnvironmentObject,jndiEnvironmentObjectParm1,jndiEnvironmentObjectParm2,jndiEnvironmentObjectParm3 
      -v java.util.Vector:name=com.tibco.tibjms.naming.ssl_trusted_certs,mycert1,mycert2,mycert3

Change the value of the jndiEnvironmentParms property in the definition of a user-defined JMS provider configurable service called myJMSprovider:
```
mqsichangeproperties IB9NODE -c JMSProviders -o myJMSprovider
      -n jndiEnvironmentParms
      -v domainName=myDomain;timeout=6000
```

Set the properties of monitoring profile 'mp1' by using the contents of file mp1.xml:

mqsichangeproperties IB9NODE -c MonitoringProfiles -o mp1 
-n profileProperties -p mp1.xml

Change all connections that are used by the adapter myPeopleSoftAdapter.outadapter. After you run this command, all adapters connect to the production system (my.peoplesoft.production.com) instead of the test system (my.peoplesoft.qa.com).
```
mqsichangeproperties IB9NODE -c PeopleSoftConnection 

	-o myPeopleSoftAdapter.outadapter -n hostName 
	-v "my.peoplesoft.production.com"
```
When you create a policy set, its properties are always set to default values. Use this command to change the property values.
Import a policy set to a broker from a file:
```
mqsichangeproperties IB9NODE -c PolicySets -o Policy_2
      -n ws-security -p policyset.xml
```
This command reads file policyset.xml and sets its contents as Policy_2 in broker IB9NODE. The command is used to move policy sets between brokers, or to restore from a backup.
Import a policy set bindings to a broker from a file:
```
mqsichangeproperties IB9NODE -c PolicySetBindings -o Bindings_2
      -n ws-security -p bindings.xml
```
This command reads file bindings.xml and sets its contents as Bindings_2 in broker IB9NODE. The command is used to move policy set bindings between brokers, or to restore from a backup.
Change a Resequence configurable service:
```
mqsichangeproperties IB9NODE -c Resequence -o myResequenceService
 -n missingMessageTimeoutSeconds -v 120
```
This command changes all nodes that are configured to use the myResequenceService configurable service, by setting them to propagate message sequences that have missing messages after waiting for 120 seconds.
Change all connections that are used by the adapter mySAPAdapter.outadapter. After you run this command, all adapters connect to the production system (production.sap.ibm.com) instead of the test system (test.sap.ibm.com).
```
mqsichangeproperties IB9NODE -c SAPConnection -o mySAPAdapter 
-n applicationServerHost -v production.sap.ibm.com
```

Change a SecurityProfiles configurable service to enable identity mapping using the WS-Trust v1.3 STS provider interface to Tivoli® Federated Identity Manager (TFIM) V6.2:

mqsichangeproperties IB9NODE -c SecurityProfiles
		-o TFIMv62MapSecProfile
		-n mapping,mappingConfig 
		-v "WS-Trust v1.3 STS",
		 http://wstrusthost1.ibm.com:9080/TrustServerWST13/services/RequestSecurityToken

Change the connection timeout for queries issued by the WebSphere Service Registry and Repository nodes to 180 seconds:
```
mqsichangeproperties IB9NODE -c ServiceRegistries -o DefaultWSRR 
      -n connectionTimeout -v 180
```
Change the connection that is used by the adapter myAdapter.outadapter. After you run this command, all message flows in all integration servers that use this adapter connect to the production system (my.siebel.production.com) instead of the test system (my.siebel.qa.com). If you are using different adapters in the message flow, run the mqsichangeproperties command for each named adapter.
```
mqsichangeproperties IB9NODE -c SiebelConnection 
	-o mySiebelAdapter.outadapter 
	-n connectString 
	-v "siebel://my.siebel.production.com/SBA_80/SSEObjMgr_enu"
```
Update the TCPIPClient configurable service so that it does not create client connections until they are required:
```
mqsichangeproperties IB9NODE -c TCPIPClient 
	-o ClientPort1452HostnameJsmith 
      -n MinimumConnections -v 0
```

Change the connection expiry time on TCPIPServer connections to 30 seconds:

mqsichangeproperties IB9NODE -c TCPIPServer -o ServerPort1452 
      -n ExpireConnectionSec -v 30

Change the TCPIPClient configurable service to use alternative addresses:

mqsichangeproperties IB9NODE -c TCPIPClient -o MyTCPIPClient 
      -n AlternativeAddresses -v smith6:1111;jones7

Change the TCPIPClient configurable service to use a connection pool other than the main pool:

mqsichangeproperties IB9NODE -c TCPIPClient -o MyTCPIPClient 
      -n UseUniqueConnectionPool -v true

Change the TCP/IP connection manager to start the server connection on port 1445:
```
mqsichangeproperties IB9NODE -e default -o TCPIP/quiesce/Server -n port, 1445
```
Change the TCP/IP connection manager to stop the server connection on port 1445:
```
mqsichangeproperties IB9NODE -e default -o TCPIP/quiesce/Server -n port, 1445
```
Change the TCP/IP connection manager to quiesce the server connection on port 1445. You must also supply a timeout for the quiesce. In this example, the timeout has a value of 30 seconds:
```
mqsichangeproperties IB9NODE -e default -o TCPIP/quiesce/Server -n port, quiesceTimeoutSec -v 1445,30
```
Change a TCPIPClient or TCPIPServer configurable service to use SSL:
- Configuring TCP/IP client nodes to use SSL
- Configuring TCP/IP server nodes to use SSL
Change a Timer configurable service:
```
mqsichangeproperties IB9NODE -c Timer -o myTimerService
 -n timeoutIntervalSeconds -v 1
```
This command changes all TimeoutNotification nodes that are configured to use the myTimerService configurable service, by configuring them to generate events every second if the node is configured in Automatic mode.

Select content based filtering on the default integration server:

mqsichangeproperties IB9NODE -e default -o ContentBasedFiltering
  -n cbfEnabled -v true

Select content based filtering on the default integration server and increase the number of evaluation threads to five:
```
mqsichangeproperties IB9NODE -e default -o ContentBasedFiltering
  -n validationThreads -v 5
```

Change a JavaClassLoader service:

mqsichangeproperties IB9NODE -c JavaClassLoader 
  -o myJavaClassLoader 
  -n sharedJarPath 
  -v /var/app2/jars

Add a property to a configurable service of type UserDefined:

mqsichangeproperties IB9NODE -c UserDefined 
  -o MyService1 -n VerifyRequestTimeout -v 60

Delete a property of a configurable service of type UserDefined:

mqsichangeproperties IB9NODE -c UserDefined 
  -o HTTP_Timeout -n VerifyRequestTimeout -d

an09140_.htm |

Last updated Friday, 21 July 2017