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 or Service Federation Management
- Properties that affect one or more execution groups; for example, the broker registry
- Properties that affect a configurable service; for example, a JMS provider
You can also use the WebSphere® Message Broker Explorer or the Message Broker API (also known as the CMP API) 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 --ExecutionGroupLabel-' >-- -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, and servicefederation. 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 WebSphere Message Broker Explorer or
the mqsicreateconfigurableservice command.
The valid resource types are listed in Configurable services properties.
- -e ExecutionGroupLabel
- (Optional) The label of the execution group 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 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 MB8BROKER -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 execution group 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 execution group is in the stopped state. You can issue the -f parameter for a broker that is running or stopped. Use this parameter only under the direction of IBM® support to recover from execution group startup failures.
If you specify this parameter for other configurable services or components, an error is generated.
- Broker registry object parameter values
- Parameter values for the cachemanager component
- Configurable services properties
- Content based filtering component parameter values
- Execution group HTTP listener parameters (SOAP and HTTP nodes)
- Broker-wide HTTP listener parameters
- CDServer configurable service
- JVM parameter values
- Parameter values for the securitycache component
- Parameter values for the servicefederation component
- ServiceFederationManager object property values
- Parameter values for the webadmin component
Authorization
- Security requirements for Linux and UNIX platforms
- Security requirements for Windows systems
- Security requirements for z/OS
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 MB8BROKER -b httplistener -o HTTPListener -n startListener -v false
- Enable the broker-wide HTTP listener:
mqsichangeproperties MB8BROKER -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 MB8BROKER -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 MB8BROKER -b httplistener -o HTTPSConnector -n sslProtocol -v TLS
- Change the securitycache timeout to 200 seconds:
mqsichangeproperties MB8BROKER -b securitycache -o SecurityCache -n cacheTimeout -v 200
- Enable Service Federation Management (SFM) and
specify a host name and contact name:
mqsichangeproperties MB8BROKER -b servicefederation -o scmp -n enabled,hostname,contactName -v true,mbhost.ibm.com,John.Smith
- Disable the web user interface:
mqsichangeproperties MB8BROKER -b webadmin -o server -n enabled -v false
- Change the port number for the web user interface:
You can change this property only when the broker is running, and the change takes effect when the broker is restarted.mqsichangeproperties MB8BROKER -b webadmin -o HTTPSConnector -n port -v new_port_number
- Change the JVM heap size for the broker:
mqsichangeproperties MB8BROKER -o ComIbmJVMManager -n jvmMaxHeapSize -v size_in_bytes
Changes to properties that are associated with execution groups
The following examples include the -e parameter to specify the execution group to change.
- Configure the execution group so that all deployed HTTP
nodes use the embedded listener:
mqsichangeproperties MB8BROKER -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 execution group configuration as shown in this command; if the broker-wide listener is not active, all execution groups use the embedded listener by default for all HTTP message handling.
- Configure the execution group properties so that deployed
HTTP nodes do not use the embedded listener:
mqsichangeproperties MB8BROKER -e exgroup1 -o ExecutionGroup -n httpNodesUseEmbeddedListener -v false
- Configure the execution group so that deployed SOAP
nodes use the broker listener rather than the embedded listener:
mqsichangeproperties MB8BROKER -e exgroup1 -o ExecutionGroup -n soapNodesUseEmbeddedListener -v false
- Configure the execution group so that deployed SOAP
nodes use the embedded listener:
mqsichangeproperties MB8BROKER -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 execution group configuration as shown in this command; if the broker-wide listener is not active, all execution groups use the embedded listener by default for all HTTP message handling.
- Set the port number when changing properties for execution groups:
mqsichangeproperties MB8BROKER -e exgroup1 -o HTTPSConnector -n explicitlySetPortNumber -v 7777
- Set the list of ciphers allowed by the HTTPS listener of the execution
group:
mqsichangeproperties MB8BROKER -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"
- Set the JVM port number to activate message flow debugging:
mqsichangeproperties MB8BROKER -e exgroup1 -o ComIbmJVMManager -n jvmDebugPort -v 8018
- Change the JVM heap size for the execution group:
mqsichangeproperties MB8BROKER -e exgroup1 -o ComIbmJVMManager -n jvmMaxHeapSize -v size_in_bytes
- Set the type of server keystore:
mqsichangeproperties MB8BROKER -e AddressSampleProvider -o ComIbmJVMManager -n keystoreType -v JKS
- Set a host name and port to be used in the endpoint
address of SFM proxies created in an execution group that is to be
used as an SFM Connectivity Provider:
mqsichangeproperties MB8BROKER -e exgroup1 -o ServiceFederationManager -n proxyURLHostName,port,securePort -v mbhost.ibm.com,8811,8844
- Set the coordination queue manager
to QM2 for execution group myExecutionGroup in
broker MB8BROKER:
mqsichangeproperties MB8BROKER -e myExecutionGroup -o FTEAgent -n coordinationQMgr -v QM2
Note: After running this command, you must reload the execution group for the change to take effect. - Set the way XMLNSC serialization renders characters
that do not exist in the target code page:
where character_type specifies how to render the character:mqsichangeproperties MB8BROKER -e exgroup1 -o ComIbmGenericXmlParserFactory -n invalidCharacterEscapeType -v character_type
- 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 €.
- 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:
where option specifies if the expiry compensation is active or not:mqsichangeproperties MB8BROKER -e default -o ComIbmMQConnectionManager -n expiryCompensation -v option
- 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 MB8BROKER -o BrokerRegistry -n httpConnectorPortRange -v 7777-8888
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:
This command changes all nodes that are configured to use the myAggregationService configurable service by setting the timeout of an aggregation to 120 seconds.mqsichangeproperties MB8BROKER -c Aggregation -o myAggregationService -n timeoutSeconds -v 120
- Change a CICSConnection configurable service:
mqsichangeproperties MB8BROKER -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:
This command changes all nodes that are configured to use the myCollectorService configurable service by setting the expiry time of collections to 120 seconds.mqsichangeproperties MB8BROKER -c Collector -o myCollectorService -n collectionExpirySeconds -v 120
- 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 MB8BROKER -c CORBA -o myCORBAService -n namingService,objectReferenceName -v localhost:2809,Europe.region/Market.object
- Change an EmailServer configurable service:
mqsichangeproperties MB8BROKER -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 MB8BROKER -c CDServer -o myCDServer -n brokerPathToStagingDir -v /tmp/cdtransfer
- Make the JAR files and shared libraries available to the WebSphere Adapter for SAP:
mqsichangeproperties MB8BROKER -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 MB8BROKER -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 MB8BROKER -c IMSConnect -o myIMSConnectService -n Hostname -v production.ims.ibm.com
- Update the security identity for the JDBCProvider service for
Oracle:
OracleDSN is the DSN with which you have associated a user ID and password using the mqsisetdbparms command.mqsichangeproperties MB8BROKER -c JDBCProviders -o Oracle -n securityIdentity -v OracleDSN
- Change the JDBCProvider service myJDBCProvider to
use the database schema mySchemaName:
mqsichangeproperties MB8BROKER -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 MB8BROKER -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 MB8BROKER -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 MB8BROKER -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 MB8BROKER -c JMSProviders -o BEA_Weblogic -n proprietaryAPIAttr2, proprietaryAPIAttr3 -v t3://9.20.94.16:7001,BEAServerName
- Change the value of the jndiEnvironmentParms property
in the definition of a user-defined JMS provider configurable service
called myJMSprovider:
mqsichangeproperties MB8BROKER -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 MB8BROKER -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 MB8BROKER -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:
This command reads file policyset.xml and sets its contents as Policy_2 in broker MB8BROKER. The command is used to move policy sets between brokers, or to restore from a backup.mqsichangeproperties MB8BROKER -c PolicySets -o Policy_2 -n ws-security -p policyset.xml
- Import a policy set bindings to a broker from a file:
This command reads file bindings.xml and sets its contents as Bindings_2 in broker MB8BROKER. The command is used to move policy set bindings between brokers, or to restore from a backup.mqsichangeproperties MB8BROKER -c PolicySetBindings -o Bindings_2 -n ws-security -p bindings.xml
- Change a Resequence configurable service:
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.mqsichangeproperties MB8BROKER -c Resequence -o myResequenceService -n missingMessageTimeoutSeconds -v 120
- 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 MB8BROKER -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 MB8BROKER -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 MB8BROKER -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 execution groups 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 MB8BROKER -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 MB8BROKER -c TCPIPClient -o ClientPort1452HostnameJsmith -n MinimumConnections -v 0
- Change the connection expiry time on TCPIPServer connections to
30 seconds:
mqsichangeproperties MB8BROKER -c TCPIPServer -o ServerPort1452 -n ExpireConnectionSec -v 30
- Change the TCPIPClient configurable
service to use alternative addresses:
mqsichangeproperties MB8BROKER -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 MB8BROKER -c TCPIPClient -o MyTCPIPClient -n UseUniqueConnectionPool -v true
- Change a TCPIPClient or TCPIPServer configurable service to use SSL:
- Change a Timer configurable service:
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.mqsichangeproperties MB8BROKER -c Timer -o myTimerService -n timeoutIntervalSeconds -v 1
- Select content based filtering on the default execution group:
mqsichangeproperties MB8BROKER -e default -o ContentBasedFiltering -n cbfEnabled -v true
- Select content based filtering on the default execution group
and increase the number of evaluation threads to five:
mqsichangeproperties MB8BROKER -e default -o ContentBasedFiltering -n validationThreads -v 5
- Change a JavaClassLoader service:
mqsichangeproperties MB8BROKER -c JavaClassLoader -o myJavaClassLoader -n sharedJarPath -v /var/app2/jars
- Add a property to a configurable service of type UserDefined:
mqsichangeproperties MB8BROKER -c UserDefined -o MyService1 -n VerifyRequestTimeout -v 60
- Delete a property of a configurable service of type
UserDefined:
mqsichangeproperties MB8BROKER -c UserDefined -o HTTP_Timeout -n VerifyRequestTimeout -d