Modifying a messaging engine using the wsadmin tool

Use this command to change properties of a messaging engine for a bus member.

This command provides only a subset of the properties available. If you want to show other properties, you need to use the administrative console or wsadmin and JACL

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

The wsadmin scripting client is run from Qshell. For more information, see the topic "Configure Qshell to run WebSphere® Application Server scripts".

This command is only valid when used with WebSphere Application Server Version 6 and later application servers. Do not use it with earlier versions.

Command-line help is provided for service integration bus commands:

For additional details of the command properties, see the related reference topic.

Purpose

This command modifies the properties of a messaging engine.

Command name
modifySIBEngine
Target
None.
Result
A messaging engine object (modified).

To save the changes made by the command, invoke the "save" command on the AdminConfig object.

Required parameters

-bus busname
The name of the service integration bus on which the bus member is configured. You can use the listSIBuses command to list the names of existing buses.

Conditional parameters

-node nodename -server servername
To change properties of a messaging engine for an application server as a bus member, specify both the name of the node on which the server runs and the name of the server.
-cluster cluster
To change properties of a messaging engine for a server cluster as a bus member, specify the name of the cluster.

This option should be used only in WebSphere Application Server environments that support server clusters.

-engine enginename
If the bus member has only one messaging engine, you do not need to specify the engine name. If the bus member has several messaging engines, you must specify the name of the engine for which you want to change properties.

Optional parameters

-description text
An optional description for the messaging engine, for administrative purposes.
-initialState STARTED | STOPPED
The initial state determines whether the messaging engine is started automatically when the server is started.
Stopped
When the associated application server is started, the messaging engine is stopped and is not available to process messages.
Started
When the associated application server is started, the messaging engine is started and is available to process messages.
-highMessageThreshold number
The maximum total number of messages that the messaging engine can place on its message points.

When the messaging engine is created, the high message threshold of the bus is used to set the default value for this property. When a message point is created on this messaging engine, the value of this property is used to set the default high message threshold for the message point.

Example

wsadmin>$AdminTask showSIBEngine {-bus abus -cluster cluster1 -engine cluster1.001-abus}
{busUuid=E90C76CC83FEA6F9, description=Messaging engine for server1 of cluster1,
 highMessageThreshold=999999999, name=cluster1.001-abus, initialState=STARTED,
 busName=abus, uuid=6A4A980750CB1D2D}
wsadmin>$AdminTask modifySIBEngine {-bus abus -cluster cluster1 -engine cluster1.001-abus
 -initialState STOPPED}
cluster1.001-abus(cells/9994GKCCell01/clusters/cluster1|sib-engines.xml#SIBMessagingEngine_1098182309278)
wsadmin>$AdminTask showSIBEngine {-bus abus -cluster cluster1 -engine cluster1.001-abus}
{busUuid=E90C76CC83FEA6F9, description=Messaging engine for server1 of cluster1,
 highMessageThreshold=999999999, name=cluster1.001-abus, initialState=STOPPED,
 busName=abus, uuid=6A4A980750CB1D2D}



Related reference
Messaging engine administrative commands
Reference topic Reference topic    

Terms and conditions for information centers | Feedback

Last updatedLast updated: Aug 30, 2013 8:21:57 PM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=pix&product=was-express-iseries&topic=rjj_cli_me_modify
File name: rjk_cli_me_modify.html