modifySIBusMemberPolicy command

Use the modifySIBusMemberPolicy command to change the messaging engine configuration for a cluster that is a member of a service integration bus.

To run the command, use the AdminTask object of the wsadmin scripting client.

[IBM i][IBM i]The wsadmin scripting client is run from Qshell.

Command-line help is provided for service integration bus commands:
  • For a list of the available service integration bus commands in Jython and a brief description of each command, enter the following command at the wsadmin prompt:

    print AdminTask.help('SIBAdminCommands')

  • For overview help on a given command, enter the following command at the wsadmin prompt:

    print AdminTask.help('command_name')

After using the command, save your changes to the master configuration by using the following command:

AdminConfig.save()

Purpose

This command changes the messaging engine policy that is applied to a cluster that is a member of a service integration bus. You can enable or disable messaging engine policy assistance, or use messaging engine policy assistance to change the messaging engine configuration for a cluster. For example, you can change from a high availability messaging engine policy to a scalability messaging engine policy.

If you enable messaging engine policy assistance and select the high availability policy, the settings of the first messaging engine in the cluster are automatically set to support the policy. If there are currently additional messaging engines in the cluster, you might have to use the deleteSIBEngine command to remove unwanted messaging engines from the cluster and therefore conform with the policy.

If you enable messaging engine policy assistance and select the scalability or scalability with high availability policy, the settings of the messaging engines that are currently in the cluster are automatically set to support the selected policy. You might have to use the createSIBEngine command or deleteSIBEngine commands to achieve the number of messaging engines to conform with the policy (there should be one messaging engine for each application server in the cluster). For each new messaging engine that you create, the settings that support the selected policy are created automatically.

If you enable messaging engine policy assistance and select the custom policy, the settings of the messaging engines that are currently in the cluster are unchanged. You can use the createMissingSIBEnginePolicy command to specify the settings for each messaging engine in the cluster, or the createSIBEngine command to create additional messaging engines.

Target object

None.

The configuration of the messaging engines in the cluster is changed to implement the specified messaging engine policy.

Required parameters

-bus busname
The name of the service integration bus that the cluster belongs to. You can use the listSIBuses command to list the names of existing buses.
-cluster cluster
The name of the cluster that you want to change.

Optional parameters

-enableAssistance TRUE | FALSE
Whether to enable messaging engine policy assistance. This parameter has two possible values:
TRUE
Messaging engine policy assistance is enabled. You must supply a -policyName parameter.
FALSE
Messaging engine policy assistance is not enabled.
The default value is FALSE.
-policyName HA | SCALABILITY | SCALABILITY_HA | CUSTOM
The type of messaging engine policy to apply to the cluster. This parameter has four possible values:
HA
Apply the high availability messaging engine policy to the cluster.
SCALABILITY
Apply the scalability messaging engine policy to the cluster.
SCALABILITY_HA
Apply the scalability with high availability messaging engine policy to the cluster.
CUSTOM
Apply the custom messaging engine policy to the cluster.
This parameter has no default. Use this parameter if the -enableAssistance parameter is set to TRUE.

Example

Enable messaging engine policy assistance for cluster1, a member of bus1, and apply the scalability messaging engine policy:

AdminTask.modifySIBusMemberPolicy('[-bus bus1 -cluster cluster1 
-enableAssistance true -policyName SCALABILITY ]')

Disable messaging engine policy assistance for cluster1, a member of bus1:

AdminTask.modifySIBusMemberPolicy('[-bus bus1 -cluster cluster1 
-enableAssistance false ]')