Use this command to change properties of a foreign bus.
This command provides only a subset of the properties
available. If you want to modify 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.
This command is only valid when
used with WebSphere® Application
Server Version 6.1 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 foreign bus. A foreign bus represents a bus in another cell (or
within the same cell) or a WebSphere MQ
network, with which a service integration bus can exchange messages.
- Command name
- modifySIBForeignBus
- Target
- None.
- Result
- A bus 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 for which you want to
modify a foreign bus. You can use the listSIBuses command
to list the names of existing buses.
- -name busname
- The name of the foreign bus that you want to modify. You can use
the listSIBForeignBuses command to list the names
of existing buses.
Conditional parameters
None.
Optional parameters
- -description text
- An optional description for the bus, for administrative purposes.
- -sendAllowed True | False
- (Default: True) Whether or not producers can send messages to
the foreign bus.
- False
- Producers cannot send messages to the foreign bus.
- True
- Producers can send messages to the foreign bus.
- -inboundUserid userID
- The inbound user ID is used to authorize individual messages arriving
from the foreign bus to destinations in the service integration bus.
If this is not a secure bus, this property has no affect on messages.
You may wish to specify an inbound user ID:
- if the foreign bus is in a different security domain from this
bus and user IDs from the foreign bus are not recognized in this bus
- to locally-control access of inbound messages to this bus.
If this is a secure bus and the foreign bus is not secure, and
no inbound user ID is set, any inbound messages from the foreign bus
are only authorized to destinations that allow unauthenticated users
access.
- -outboundUserid userID
- The outbound user ID replaces the user ID that identifies the
source of a message in all messages being sent to the foreign bus.
This user ID is also used by the foreign bus to authorize the message
to its destination if both buses are secure buses and the foreign
bus has not overridden the user ID with its own inbound user ID.
- -nextHopBus bus_name
- (If -routingType is Indirect) The name of the next service integration
bus in the sequence of connected buses. An intermediate bus can be
a WebSphere MQ system
rather than a service integration bus.
- -topicSpaceMappings local topicspace_name : remote topicspace_name
- A topic space mapping allows subscribers on the local topic space
to receive messages published in the foreign topic space. For publications
to flow from the local topic space into the foreign bus, an equivalent
topic space mapping is required by the foreign bus. Topic space names
for the local bus are mapped to topic space names defined on the foreign
bus. It is common for these two names to match. Note that mapping
two topic spaces implies that the topics within them are the same.
Example
The
example below specifies the following additional optional properties
for an existing foreign bus called
foreignbus1:
- An inbound user identity called iuserid to
authorize messages sent from foreignbus1 to the
local bus, when security is enabled on foreignbus1,
and the local bus.
- An outbound user identity called ouserid to
authorize messages sent from the local bus to foreignbus1,
when security is enabled on foreignbus1, and the
local bus.
- A topic space mapping between Topic.Space1 on
the local bus and Topic.Space2 on foreignbus1.
The mapping allows subscribers on Topic.Space1 on
the local bus to receive messages published in Topic.Space2 on foreignbus1.
wsadmin>$AdminTask modifySIBForeignBus {-bus SCA.SYSTEM.IBM-AA8DA602255Cell01.Bus -name SCA.SYSTEM.IBM-A
A8DA602255Cell02.Bus -inboundUserid iuserid -outboundUserid ouserid -topicSpaceMappings {{Topic.Space1 Topic.Space2}}}
SCA.SYSTEM.IBM-AA8DA602255Cell02.Bus(cells/IBM-AA8DA602255Cell01/buses/SCA.SYSTEM.IBM-AA8DA602255Cell01.
Bus|sib-bus.xml#SIBForeignBus_1132530748562)
wsadmin>