modifySIBLink command
Use the modifySIBLink command to modify the properties of a service integration bus link.
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 Configuring Qshell to run WebSphere scripts using wsadmin scripting.
- 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')
AdminConfig.save()
Purpose
The modifySIBLink command modifies the properties of a service integration bus link.
Target object
None.
Required parameters
- -bus
- The name of the service integration bus for which you want to modify the service integration bus link. You can use the listSIBuses command to list the names of existing buses.
- -messagingEngine
- The name of the messaging engine for which you want to modify the service integration bus link. The service integration bus link connects a messaging engine to another messaging engine in a different service integration bus, thereby providing a bridge between two service integration buses.
- -name
- The name by which you want the service integration bus link to be known.
- -foreignBusName
- The name of the foreign bus that defines the remote service integration bus for the service integration bus link. You can use the listSIBForeignBuses command to list the names of existing foreign buses.
Conditional parameters
None.
Optional parameters
- -bootstrapEndpoints
- The comma-separated list of endpoints used to connect to a bootstrap server. This property is set in the same way as the Provider endpoint property in the JMS connection factory settings. For more information, see the steps relating to setting bootstrap endpoints in Configuring a connection to a non-default bootstrap server.
The port for the bootstrap endpoint is the port defined on the SIB endpoint address that is configured on the target application server on the foreign bus.
- -remoteMessagingEngineName
- The messaging engine on the foreign bus to which this link connects.
- -description
- An optional description for the bus, for administrative purposes.
- -protocolName
- The type of transport chain used for communication with the foreign bus.
The transport chain name must be the name of the transport chain as defined on the server on which the target messaging engine is hosted.
- -authAlias
- The name of the authentication alias, used to authenticate access to the foreign bus.
You must have predefined a J2C authentication alias.
- -exceptionDestination
- The destination for an inbound message when the service integration
bus link cannot deliver the message to its target destination, or
to the exception destination that is configured for that target destination,
or when the target destination does not exist.
- System
- The service integration bus link uses the default exception destination. All messages that cannot be delivered to the bus destination are rerouted automatically to the system default exception destination for the messaging engine that this link is assigned to: _SYSTEM.Exception.Destination.messaging_engine_name.
- None
- The service integration bus link has no exception destination. Undeliverable messages are not rerouted to an exception destination and can block the processing of other messages waiting for delivery to the same destination. This option can be used to preserve message ordering.
- Specify
- The service integration bus link uses the exception destination specified here. If this is not possible, it uses the system exception destination.
- -initialState Started | Stopped
- The state of the gateway link, which shows whether the link is
started automatically when the messaging engine is started.
Information Value Default Started Range - Stopped
- When the associated messaging engine is started, the gateway link is in a stopped state and cannot process any new requests for connections.
- Started
- When the associated messaging engine is started, the gateway link is in a started state and can process any new requests for connections.
- -preferLocal TRUE | FALSE
- Indicates whether the link prefers to send incoming messages to
the queue point of the target destination that is located on the same
messaging engine as the link, if available. The link must be owned
by a messaging engine running on a WebSphere® Application
Server Version 7.0 or later server.
This option is supported only when used by a JMS application that is running with a WebSphere Application ServerVersion 7.0 or later server or client, and that is connected to a messaging engine running on WebSphere Application ServerVersion 7.0 or later server. Use on previous versions of WebSphere Application Server will result in an exception to the application.
Information Value Default TRUE Range - TRUE
- Send each incoming message to the queue point of the target destination that is located on the same messaging engine as the link, if available.
- FALSE
- Send incoming messages to any queue points of the target destinations.
Examples
wsadmin>AdminTask.showSIBLink('[-bus bus1 -messagingEngine node01.server1-bus1 -sibLink
mySIBLink]')
'{bootstrapEndpoints=host1:1111:chain1, protocolName=null, authAlias=null,
preferLocalQueuePoints=true, name=mySIBLink, uuid=34647E59163B253D,
remoteMessagingEngineName=node02.server2-bus2, description=null,
targetUuid=BAD49BA75CD36D740E366978, initialState=STARTED,
exceptionDestination=$DEFAULT_EXCEPTION_DESTINATION}'
wsadmin>AdminTask.modifySIBLink('[-bus bus1 -messagingEngine node01.server1-bus1
-name MySIBLink -foreignBusName -bus2
-bootstrapEndpoints anotherhost:2222:BootstrapBasicMessaging]')
wsadmin>AdminTask.showSIBLink('[-bus bus1 -messagingEngine node01.server1-bus1 -sibLink
mySIBLink]')
'{bootstrapEndpoints=anotherhost:2222:BootstrapBasicMessaging, protocolName=null,
authAlias=null, preferLocalQueuePoints=true, name=mySIBLink, uuid=34647E59163B253D,
remoteMessagingEngineName=node02.server2-bus2, description=null,
targetUuid=BAD49BA75CD36D740E366978, initialState=STARTED,
exceptionDestination=$DEFAULT_EXCEPTION_DESTINATION}'
Modify a service integration bus link so that there is no preference for which queue points to use.
AdminTask.modifySIBLink('[-bus bus1 -messagingEngine cluster1.000-bus1 -name MyLink
-foreignBusName -FB1 bootstrapEndpoints host1:1111:chain1 -remoteMessagingEngineName
-cluster2.000-FB1 -preferLocal FALSE]')