Use this command to add a member to a service integration bus. A
bus member can be an application server, a WebSphere MQ server, or a server
cluster. A bus member that is an application server or a server cluster contains
a messaging engine, which is the application server component that provides
asynchronous messaging services.
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:
Purpose
This command
adds a new bus member to a service integration bus. When you add an application
server to a bus, a messaging engine with default settings is created automatically.
When you add a WebSphere MQ server as a bus member, a server proxy is created
that can override the parent connection properties (host, port, channel and
SSL security configuration alias) defined in the WebSphere MQ server. By this
means, a different set of connection properties can be assigned to each bus
membership.
- Command name
- addSIBusMember
- Target
- None.
- Result
- A bus member object is created.
When the bus member is an application server or a server cluster, a messaging
engine with default settings is created.
Required parameters
- -bus busname
- The name by which the service integration bus is known. You can use the
listSIBuses command to list the names of existing buses.
- -wmqServer
- The name of the WebSphere MQ server to add to the bus. This is the name
specified in the -name parameter when creating the WebSphere MQ server definition. If
you use this parameter, do not use the cluster, node and server parameters.
- -host
- The override value for the WebSphere MQ server bus member host attribute.
This value is the host name or IP address of the host to which a connection
is established for communicating with a queue manager or queue sharing group.
- -port
- The override value for the WebSphere MQ server bus member port attribute.
The port number is monitored by a queue manager listener or a queue sharing
group listener, which is listening for connections. The default value is 1414.
- -channel
- The override value for the WebSphere MQ server bus member channel attribute.
This value is the name of the server connection channel that is used to establish
a connection to the WebSphere MQ queue manager or queue sharing group. The
default value is SYSTEM.DEF.SVRCONN.
- -securityAuthAlias
- The override value for the WebSphere MQ server bus member securityAuthAlias
attribute. This value is the authentication alias that is supplied when connecting
to WebSphere MQ. This parameter has no default.
- -transportChain
- The override value for the WebSphere MQ server bus member transportChain
attribute. This value is the name of the transport chain that is used when
communicating with WebSphere MQ. This parameter has a default of OutboundBasicWMQClient.
- -trustUserIds TRUE | FALSE
- The override value for the WebSphere MQ server bus member trustUserIds
attribute. This value determines whether or not user identifiers received
in messages from WebSphere MQ are propagated into messages or not. This parameter
has two possible values:
- TRUE
- This value indicates that user identifiers are propagated.
- FALSE
- This value indicates that user identifiers are not propagated. The application
user identifier is always set from the jsAppUserIdRFH2 value. If this value
is not present (either because the key/value pair is not present in the service
integration bus folder of the RFH2 header, or because the message does not
have a RFH2 header), this field is not set.
The default is TRUE.
Conditional parameters
- -node nodename -server servername
- To add 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. If you specified
the -wmqServer parameter, do not specify the node parameter.
- -cluster cluster
- To add a server cluster, specify the name of the cluster.
- -server servername
- To add a server, specify the name of the server.
- -wmqServer
- The name of the WebSphere MQ server to be added to the bus. If this parameter
is supplied, the cluster, node and server parameters must not be supplied.
This is the name specified in the -name parameter when creating the WebSphere
MQ server definition.
Optional parameters
- -description text
- An optional description for the bus member, for administrative purposes.
- -host
- The override value for the WebSphere MQ server bus member host attribute.
This is the name of the host to which a connection will be established for
communicating with a queue manager or queue sharing group.
- -port
- The override value for the WebSphere MQ server bus member port attribute.
The port number is monitored by a queue manager listener or queue sharing
group listener, which is listening for connections. The default value is 1414.
- -channel
- The override value for the WebSphere MQ server bus member channel attribute.
This is the name of the server connection channel that will be used to establish
a connection to the MQ Queue Manager, or on z/OS an MQ Queue Sharing Group.
The default value is SYSTEM.DEF.SVRCONN.
- -securityAuthAlias
- The override value for the WebSphere MQ server bus member securityAuthAlias
attribute. This is the authentication alias that will be supplied when connecting
to the WebSphere MQ server. This parameter has no default.
- -transportChain
- The override value for the WebSphere MQ server bus member transportChain
attribute. This is the name of the transport chain to use when communicating
with WebSphere MQ. This parameter has a default of OutboundBasicWMQClient.
- -trustUserIds TRUE | FALSE
- The override value for the WebSphere MQ server bus member trustUserIds
attribute. This determines whether or not user identifiers received in messages
from WebSphere MQ are propagated into messages or not. This parameter has
two possible values:
- TRUE
- This value indicates that user identifiers are propagated.
- FALSE
- This value indicates that user identifiers are not propagated. The application
user identifier is always set from the jsAppUserIdRFH2 value. If this is
not present (either because the key/value pair is not present in the sib folder
of the RFH2 header, or because the message does not have a RFH2 header), this
field is not set.
The default is TRUE.
- -fileStore
A file store is
a type of message store that directly
uses files in a file system through the operating system.
You
can specify the type of message store of the messaging engine to be a file
store. The type of message store can also be a data store, for more information
see related links.
- -logSize logsize
- Size of the log file in mega bytes.
- -logDirectory logdirectoryname
- If you do not want to use the default log directory you can specify a
different one.
- -minPermanentStoreSize minpermanentstoresize
- Minimum size of the permanent store file in mega bytes.
- -minTemporaryStoreSize mintemporarystoresize
- Minimum size of the temporary store file in mega bytes.
- -maxPermanentStoreSize maxpermanentstoresize
- Maximum size of the permanent store file in mega bytes.
- -maxTemporaryStoreSize maxtemporarystoresize
- Maximum size of the temporary store file in mega bytes.
- -unlimitedPermanentStoreSize TRUE | FALSE
- A boolean parameter specifying whether the permanent store size is unlimited.
- -unlimitedTemporaryStoreSize TRUE | FALSE
- A boolean parameter specifying whether the temporary store size is unlimited.
- -permanentStoreDirectory permanentstoredirectoryname
- If you do not want to use the default permanent store directory you can
specify a different one.
- -temporaryStoreDirectory temporarystoredirectoryname
- If you do not want to use the default temporary store directory you can
specify a different one.
- -dataStore
A data store consists
of the set of tables that a messaging engine uses to store persistent data in a database. Refer to 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. You can create multiple data stores in
the same database only by using a different schema for each data store.
You
can specify the type of message store of the messaging engine to be a data
store, although the default is file store. For more information see related
links.
- -createDefaultDatasource TRUE | FALSE
- Set this to true if a default data source should be created when the messaging
engine is created.
- -createTables datasource
- The database tables are created automatically for the specified data source.
- -authAliasauthalias
- The user also has to provide an authentication alias, which the messaging
engine uses to connect to the database in its data store
- -schemaName schemaname
- If you do not want to use the default schema name you can specify a different
one. For more details on default schema see Creating users and schemas in the database.
- -datasourceJndiName jndiname
- The JNDI name of the data source that the messaging engine uses to access
the relational database management system (RDBMS) for the data store.
Example
Add a bus member with a default file store.
$AdminTask
addSIBusMember -bus busName -server serverName Add a member to
the bus, using a file store to save messages.
$AdminTask addSIBusMember
-bus busName -server serverName -fileStore Add a member to the
bus, using a file store to save messages, with options.
$AdminTask
addSIBusMember -bus busName -server serverName -fileStore {{logDirectory "c:\fred"
logSize 3636363}}Add a member to the bus, using a data store to
save messages.
$AdminTask addSIBusMember -bus busName -server serverName
-dataStoreAdd a member to the bus, using a data store to save
messages, with options.
$AdminTask addSIBusMember -bus busName
-server serverName -dataStore {{createDefaultDatasource true datasourceJndiName
myjndi}}Add a member to the bus, using a data store to save messages,
with syntax.
$AdminTask addSIBusMember -bus busName -server serverName
-createDefaultDatasource true -datasourceJndiName myjndiNote: The
addSIBusMember command adds a server or a server cluster as a member of a
bus, and automatically creates one messaging engine. To create an additional
messaging engine for a server cluster, use the createSIBEngine command.