Use the modifySIBEngine command to modify
the properties of a messaging engine for a service integration bus
member.
Purpose
This command modifies the properties
of a messaging engine.
Target object
A messaging engine.
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.
- -restrictLongDBLock TRUE | FALSE
- A parameter that specifies whether the active messaging engine
must retain long running locks on the SIBOWNER table in the database.
When this option is selected, the messaging engine establishes a lock
over the database only for short durations. In the event of the active
messaging engine not responding to the database, the standby messaging
engine will be able to take ownership of the database because the
active messaging engine only holds short duration locks. This parameter
has two possible values:
- TRUE
- Restrict long running locks on the database.
- FALSE
- Do not restrict long running locks on the database.
Use this parameter if the -dataStore parameter
is specified.
Important: Although the property is selected,
the property will not be effective until the database tables are upgraded
using the sibDBUpgrade command for WebSphere Application Server Version 8.5 and later.
Example
wsadmin>AdminTask.showSIBEngine('[-bus bus1 -node node01 -server server1
-engine node01.server1-bus1 ]')
'{initialState=STARTED, targetGroups=[], name=node01.server1-bus1,
highMessageThreshold=50000, messageStoreType=FILESTORE, uuid=56F8FE11AB84188D,
busName=bus1, busUuid=6DF19B02BC879BD1}'
wsadmin>AdminTask.modifySIBEngine('[-bus bus1 -node node01 -server server1
-engine node01.server1-bus1 -initialState STOPPED ]')
wsadmin>AdminTask.showSIBEngine('[-bus bus1 -node node01 -server server1
-engine node01.server1-bus1 ]')
'{initialState=STOPPED, targetGroups=[], name=node01.server1-bus1,
highMessageThreshold=50000, messageStoreType=FILESTORE, uuid=56F8FE11AB84188D,
busName=bus1, busUuid=6DF19B02BC879BD1}'