createSIBEngine command

Use the createSIBEngine command to create a messaging engine for a server or cluster bus member using the wsadmin tool. When we add a server or a cluster as a member of a service integration bus, at least one messaging engine is created automatically. Use the createSIBEngine command to create an additional messaging engine for a cluster bus member.

Each server bus member has exactly one messaging engine, but cluster bus members can support additional engines. If we create an additional messaging engine for a cluster, and we use a data store for the message store, we must explicitly configure both the data store and the JDBC data source that the messaging engine uses to interact with the data store. We must create the data source at cluster scope, not node scope. For more information about creating messaging engines, see Configure a data source for a messaging engine running in a cluster.

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

(iSeries) (iSeries) The wsadmin scripting client is run from Qshell. (iSeries) See Configure Qshell to run WebSphere scripts .

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 at the wsadmin prompt:

  print AdminTask.help('SIBAdminCommands')

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

  print AdminTask.help('command_name')

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

AdminConfig.save()

The createSIBEngine command creates a new messaging engine for a server or cluster bus member. Use this command to create an additional messaging engine for a cluster bus member.

If the cluster has messaging engine policy assistance enabled and the scalability or scalability with high availability policy specified, the messaging engine settings are created automatically to conform with the specified policy.

After we use this command, if the cluster has messaging engine policy assistance enabled and the custom policy specified, we can create a core group policy for a messaging engine using the createMissingSIBEnginePolicy command.

Target object

None.

Required parameters

-bus bus_name

The name of the service integration bus on which the bus member is configured. Use the listSIBuses command to list the names of existing buses.

Conditional parameters

-node node

-server server

To create a messaging engine for a server that is a bus member, specify both the name of the node on which the server runs, and the name of the server.

-cluster cluster_name

To create a messaging engine for a server cluster that is a bus member, specify the name of the cluster.

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 or server cluster is started.

STARTED

When the associated application server is started, the messaging engine is started and is available to process messages.

STOPPED

When the associated application server is started, the messaging engine is stopped and is not 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.

-failover TRUE | FALSE

A parameter that specifies whether the messaging engine in the cluster can fail over to another server in the cluster if the host server for the messaging engine fails. This parameter has two possible values:

TRUE

The messaging engine can fail over.

FALSE

The messaging engine cannot fail over.

The default is FALSE. Use this parameter if the cluster has messaging engine policy assistance enabled and the custom policy specified. To do this, use the addSIBusMember or modifySIBusMemberPolicy commands.

-failback TRUE | FALSE

A parameter that specifies whether the messaging engine in the cluster that has failed over can fail back to a more preferred server in the preferred servers list if that server becomes available again. This parameter has two possible values:

TRUE

The messaging engine can fail back. If we use this option, supply a -preferredServerList parameter.

FALSE

The messaging engine cannot fail back.

The default is FALSE. Use this parameter if the cluster has messaging engine policy assistance enabled and the custom policy set. To do this, we use the addSIBusMember or modifySIBusMemberPolicy commands.

-preferredServersOnly TRUE | FALSE

A parameter that specifies whether the messaging engine in the cluster can run only on servers in the preferred servers list, or on any server in the cluster. This parameter has two possible values:

TRUE

The messaging engine can run only on servers in the preferred servers list. If we use this option, supply a -preferredServerList parameter.

FALSE

The messaging engine can run on any server in the cluster.

The default is FALSE. Use this parameter if the cluster has messaging engine policy assistance enabled and the custom policy set. To do this, use the addSIBusMember or modifySIBusMemberPolicy commands.

-preferredServerList {{node server}}

The list of servers, in order of preference, on which the messaging engine in the cluster prefers to run. For each server in the list, specify both the name of the node on which the server runs, and the name of the server. There is no default value for this parameter. Use this parameter if the cluster has messaging engine policy assistance enabled and the custom policy set. To do this, use the addSIBusMember or modifySIBusMemberPolicy commands.

-fileStore

Create a file store to use as a message store for the messaging engine.A file store is a type of message store that directly uses files in a file system through the operating system. The alternative is to use a data store. See related links.

-logSize size

The size of the log file in MB. Use this parameter if the -fileStore parameter is specified.

-logDirectory directory_name

The name of the log file directory if we do not want to use the default log directory. Use this parameter if the -fileStore parameter is specified.

-minPermanentStoreSize size

The minimum size of the permanent store file in MB. Use this parameter if the -fileStore parameter is specified.

-minTemporaryStoreSize size

The minimum size of the temporary store file in MB. Use this parameter if the -fileStore parameter is specified.

-maxPermanentStoreSize size

The maximum size of the permanent store file in MB. Use this parameter if the -fileStore parameter is specified.

-maxTemporaryStoreSize size

The maximum size of the temporary store file in MB. Use this parameter if the -fileStore parameter is specified.

-unlimitedPermanentStoreSize TRUE | FALSE

A parameter that specifies whether the permanent store size is unlimited. This parameter has two possible values:

TRUE

The permanent store size is unlimited.

FALSE

The permanent store size is limited. If we use this option, supply a -maxPermanentStoreSize parameter.

Use this parameter if the -fileStore parameter is specified.

-unlimitedTemporaryStoreSize TRUE | FALSE

A parameter that specifies whether the temporary store size is unlimited. This parameter has two possible values:

TRUE

The temporary store size is unlimited.

FALSE

The temporary store size is limited. If we use this option, supply a -maxTemporaryStoreSize parameter.

Use this parameter if the -fileStore parameter is specified.

-permanentStoreDirectory directory_name

The name of the permanent store directory if we do not want to use the default permanent store directory. Use this parameter if the -fileStore parameter is specified.

-temporaryStoreDirectory directory_name

The name of the temporary store directory if we do not want to use the default temporary store directory. Use this parameter if the -fileStore parameter is specified.

-dataStore

Create a data store to use as a message store for the messaging engine.

A data store consists of the set of tables that a messaging engine uses to store persistent data in a database. See Data store tables for a list of the tables that comprise a data store. All the tables in a data store are held in the same database schema. We can create multiple data stores in the same database, provided that we use a different schema name for each data store.

The alternative is to use file store (the default). See related links.

-createDefaultDatasource TRUE | FALSE

A parameter that specifies whether to create a default data source when the messaging engine is created. This parameter has two possible values:

TRUE

Create a default data source.

FALSE

Do not create a default data source.

Use this parameter if the -dataStore parameter is specified. Do not use this parameter if the -cluster parameter is specified.

-datasourceJndiName jndi_name

The JNDI name of the data source that the messaging engine uses to access the relational database management system (RDBMS) for the data store. Use this parameter if the -dataStore parameter is specified.

-authAlias auth_alias

The name of the authentication alias that the messaging engine uses to connect to the database in its data store. Use this parameter if the -dataStore parameter is specified.

-createTables TRUE | FALSE

A parameter that specifies whether to create the database tables for the data source automatically. This parameter has two possible values:

TRUE

Create the database tables for the data source.

FALSE

(iSeries) (Dist) Do not create the database tables for the data source. If we use this option, the database administrator must create the tables.

(ZOS) Do not create the database tables for the data source. For the z/OS operating system, we must use this option because we must not create tables.

Use this parameter if the -dataStore parameter is specified.

-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 v9.0 and later.

-schemaName schema_name

The name of the database schema containing the tables for the data store, if we do not want to use the default schema name. For details about the default schema, see Create users and schemas in the database. Use this parameter if the -dataStore parameter is specified.

Depending on the choice of the message store and its attributes, we specify different combinations of the parameters. To avoid errors when we specify the message store for the messaging engine, see Avoiding errors when creating a messaging engine with a file store or a data store .

Examples

Create a messaging engine for cluster1 on bus1 that uses a default file store.

AdminTask.createSIBEngine ('[-bus bus1 -cluster cluster1]') 

Create a messaging engine for cluster1 on bus1 that uses a file store with defaults.

AdminTask.createSIBEngine ('[-bus bus1 -cluster cluster1 -fileStore]') 

Create a messaging engine for cluster1 on bus1 that uses a file store with options.

AdminTask.createSIBEngine ('[-bus bus1 -cluster cluster1 -fileStore 
-logSize 3636363 -logDirectory C:\mylogdirectory]') 

Create a messaging engine for cluster1 on bus1 that uses a data store with defaults.

AdminTask.createSIBEngine ('[-bus bus1 -cluster cluster1 -dataStore]') 

Create a messaging engine for cluster1 on bus1 that uses a data store with options.

AdminTask.createSIBEngine ('[-bus bus1 -cluster cluster1 -dataStore 
-createDefaultDatasource true -datasourceJndiName myjndi]') 

Add a new messaging engine to cluster1 that is a member of bus1 and that uses a file store as the message store for the messaging engine.

AdminTask.createSIBEngine('[-bus bus1 -cluster cluster1 -fileStore true 
-logSize 100 -minPermanentStoreSize 200 -maxPermanentStoreSize 500 
-unlimitedPermanentStoreSize false -permanentStoreDirectory C:\myfilestore 
-minTemporaryStoreSize 200 -maxTemporaryStoreSize 500 
-unlimitedTemporaryStoreSize false -temporaryStoreDirectory C:\myfilestore 
-logDirectory C:\myfilestore ]') 

Add a new messaging engine to cluster1 that is a member of bus1, where cluster1 has messaging engine policy assistance enabled and the custom messaging engine policy specified. Use a file store as the message store for the messaging engine. Set the messaging engine to fail over, not to fail back, and to run only on server1 and server2.

AdminTask.createSIBEngine('[-bus bus1 -cluster cluster1 -fileStore true 
-logSize 100 -minPermanentStoreSize 200 -maxPermanentStoreSize 500 
-unlimitedPermanentStoreSize false -permanentStoreDirectory C:\myfilestore 
-minTemporaryStoreSize 200 -maxTemporaryStoreSize 500 
-unlimitedTemporaryStoreSize false -temporaryStoreDirectory C:\myfilestore 
-logDirectory C:\myfilestore -failover true -failback false 
-preferredServersOnly true -preferredServerList [[node1 server1] [node2 server2]]]')