mqsichangeproperties command

Use the mqsichangeproperties command to modify integration node properties and properties of integration node resources.

Supported platforms

Windows
Linux®
AIX®
IBM® z/OS® Container Extensions (zCX). Run this command by modifying and submitting the supplied JCL or by using an IBM z/OS console command.

Purpose

Use the mqsichangeproperties command to change properties that are associated with an integration node:

Properties that affect the whole integration node; for example, the REST admin HTTP listener.
Properties that affect an integration server; for example, the integration server HTTP Connector.
Properties that affect a policy that is defined on the integration node; for example, a user-defined property.

You can also use the web user interface or the administration REST API to change properties.

Use the mqsireportproperties command to view properties that are associated with an integration node.

You can also view and change properties by editing the node.conf.yaml or server.conf.yaml configuration files. For more information, see Configuring an integration node by modifying the node.conf.yaml file and Configuring an integration server by modifying the server.conf.yaml file.

Usage notes

When you update the properties for an integration node, the integration node can be started or stopped, but the changes are not effective until the integration node is restarted.
When you update the properties for an integration server and the integration server is running, most changes are effective immediately. If any changes require a restart, a message is displayed. If the integration server is stopped, you must specify the --offline parameter. The changes are effective when the integration server is restarted.

Syntax 1: Integration node properties

Syntax 2: Integration server properties

Parameters

--integration-node integrationNodeName

(Required) The name of the integration node to modify. This parameter must be the first parameter.

-b |--component ComponentName

(Optional) The name of the component. Valid values are pubsub, NodeHttpListener, securitycache, RestAdminListener , agent. The properties that are associated with these components affect the whole integration node.

-c --configurable-service policy-type

(Optional) The short name for the type of policy to be changed. Supplied policy types have short names that are predefined; for example, JMSProviders for the JMS Providers policy type. For a list of supplied policies, and their properties and values, see Policy properties.

You must also specify the name of a policy on the -o parameter.

-c --configurable-service policy-type

(Optional)

Use this parameter to change the properties of policies that are defined on the integration node. This option cannot be used to change properties on policies that are deployed to an integration server. The policy-type must be the short name for the type of policy to be changed; for example, JMSProviders for the JMS Providers policy type. For a list of supplied policies, and their properties and values, see Policy properties.

You must also specify the name of a policy on the -o parameter.

-e | --integration-server integrationServerName

(Optional) The name of the integration server for which you want to change properties.

-o | --object ObjectName

(Required) The name of the object or policy 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.

Specify ComIbmJVMManager to update the following settings. If you do not specify -b or -e when you specify ComIbmJVMManager, the JVM settings of all integration servers are updated.

JVM settings of the HTTP listener or agent that you specify with -b.
JVM settings of the integration server that you specified with -e.

Specify ComIbmIIBSwitchManager to configure the values of properties that relate to the switch server.

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

-n | --property PropertyName

(Required) The name of the property to be changed. The available property names differ according to the component or policy that you specify. 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 policies are described in Policy properties.

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

-v | --value 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 AIX, if the -v parameter contains a semicolon (;), enclose the entire string in quotation marks, as shown in the following example:

mqsichangeproperties INODE -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. The expected value 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 | --input-file 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 or JSON file.

The following conditions apply to the use of this parameter:

The -p parameter 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 | --delete

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

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

-f | --offline

(Optional) Use this parameter to allow updates when the integration node or integration server is stopped. The changes are effective when the integration node or integration server is restarted.

--trace traceFileName

(Optional) Use this parameter send verbose internal trace to the specified file.

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

Authorization

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

If you enable administration security, you must also set up the authority that is detailed in Tasks and authorizations for administration security.

Examples

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

Changes to integration node components
Changes to properties that are associated with integration servers
Changes to the BrokerRegistry object

Changes to integration node components

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

Change the default queue manager that is associated with an integration node:
```
mqsichangeproperties INODE -n defaultQueueManager -v QM1
```

Enable the integration node HTTP listener:

mqsichangeproperties INODE -b NodeHttpListener -n startListener -v true

Change the port number for the integration node HTTPS listener:

mqsichangeproperties INODE   -b NodeHttpListener -o HTTPSConnector -n ListenerPort -v 9083

Change the securitycache timeout to 200 seconds:

mqsichangeproperties INODE -b SecurityCache -n cacheTimeout -v 200

Disable the web user interface by specifying -1 as the value for the -v parameter:
```
mqsichangeproperties INODE -b RestAdminListener -n port -v -1 
```
Enable the web user interface by specifying a valid value for the -v parameter. The default value is 4414:
```
mqsichangeproperties INODE -b RestAdminListener -n port -v new_port_number
```
You can change this property only when the integration node is running, and the change takes effect when the integration node is restarted.
Enable event publication for an event type that belongs to the OperationalEvents event group. This example uses IBM MQ for the transport protocol:
```
mqsichangeproperties INODE -b Events -o OperationalEvents/MQ -n enabled -v true
```
Disable event publication for an event type that belongs to the OperationalEvents event group. This example uses IBM MQ as the transport protocol:
```
mqsichangeproperties INODE -b Events -o OperationalEvents/MQ -n enabled -v false
```
Specify a policy to control event publication, for an event type that belongs to the OperationalEvents event group. This example uses IBM MQ as the transport protocol:
```
mqsichangeproperties INODE -b Events -o OperationalEvents/MQ -n policy -v {MyPolicies}:ExampleMQPolicy
```
Configure the integration node to be started and stopped as an IBM MQ service:
```
mqsichangeproperties INODE -b Service -n autoStart -v mqservice
```
Configure the path to the Certificate Revocation List (CRL) files that the JVM uses to check certificates. The parameter, file_path is a list of paths to CRL files separated by the path separator character for the host operating system.
```
mqsichangeproperties INODE -o BrokerRegistry -n crlFileList -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 INODE -e integrationServerName -o ComIbmJVMManager -n enableCRLDP -v true --offline
```
Define CRL processing for HTTP-based input nodes that are deployed to the specified integration node by using a CRL file that is located in file_path:
```
mqsichangeproperties INODE -b NodeHttpListener -o HTTPSConnector 
			-n crlFile -v file_path
```
Add a certificate revocation list (CRL) file from location file_path for the HTTPS listener of the integration server:
```
mqsichangeproperties INODE -e integrationServerName -n crlFile -v file_path
```

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 INODE -e integrationServerName -n httpNodesUseEmbeddedListener -v true
```
You do not have to change the integration server configuration as shown in this command if the integration node listener is not active. All integration servers use the embedded listener by default if the node integration node listener is not active.
Configure the integration server so that deployed SOAP nodes use the integration node listener rather than the embedded listener. You must stop the integration node before you run the command with this syntax:
```
mqsichangeproperties INODE -e integrationServerName -o ExecutionGroup -n soapNodesUseEmbeddedListener -v false --offline
```
You do not have to change the integration server configuration as shown in this command if the integration node listener is not active. All integration servers use the embedded listener by default if the node integration node listener is not active.
Create and configure a connectivity agent in an integration server where you deploy a callable flow. If your callable flows are deployed to different integration servers, you must run this command for each integration server. You must stop the integration node before you run the command with this syntax:
```
mqsichangeproperties integrationNodeName -e integrationServerName -o ComIbmIIBSwitchManager -n serverClientConfigFile -p filepath\serverclient.json --offline
```
The following syntax is deprecated but is still supported:
```
mqsichangeproperties integrationNodeName -e integrationServerName -o ComIbmIIBSwitchManager -n agentXConfigFile -p filepath\agentx.json --offline
```
Configure the time to wait before the next message is retrieved from an input node after a message is rolled back. wait_time is the time to wait in milliseconds.
```
mqsichangeproperties INODE -e integrationServerName -o ExecutionGroup -n failedMessageWaitTime -v wait_time
```
Note: failedMessageWaitTime applies only to errors that occur downstream of an input node and only if it is set to a non-default value. The default value is 1000 milliseconds.

Set the port number when you change properties for integration servers:

mqsichangeproperties INODE -e integrationServerName -o HTTPSConnector  -n ListenerPort -v 7777

Set the JVM port number to activate message flow debugging:

mqsichangeproperties INODE -e integrationServerName -o JVM -n jvmDebugPort -v 8018

Change the JVM heap size for the integration server. You must stop the integration node before you run the command with this syntax:
```
mqsichangeproperties INODE -e integrationServerName -o JVM -n jvmMaxHeapSize -v size_in_bytes --offline
```

Changes to the BrokerRegistry object

Set the HTTPConnector Port Range in the integration node registry:

mqsichangeproperties INODE -b BrokerRegistry -n httpConnectorPortRange -v 7777-8888

Configure the file path to an IBM MQ CCDT file in the integration node registry:
```
mqsichangeproperties INODE -o BrokerRegistry -n mqCCDT -v "C:\ProgramData\IBM\MQ\Qmgrs\QM1\@ipcc\AMQCLCHL.TAB"
```
After you set the mqCCDT property, restart the integration node for the changes to take effect.