Network Deployment (Distributed operating systems), v8.0 > Reference > Commands (wsadmin scripting)

modifySIBForeignBus command

Use the modifySIBForeignBus command to modify the properties of a foreign bus.

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

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

  print AdminTask.help('SIBAdminCommands')

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

  print AdminTask.help('command_name')

After using the command, save changes to the master configuration; for example, by using the following command:

AdminConfig.save()

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.

Target object

A foreign bus.

Required parameters

-bus busname

The name of the service integration bus for which to modify a foreign bus. We can use the listSIBuses command to list the names of existing buses.

-name busname

The name of the foreign bus to modify. We 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 False | False

(Default: True) Whether 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 might want 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. We can specify multiple pairs of topic spaces.

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.

Example

AdminTask.modifySIBForeignBus('[-bus bus1 -name foreignbus1 -inboundUserid iuserid
-outboundUserid ouserid -topicSpaceMappings [[Topic.Space1 Topic.Space2]]]')
'foreignbus1(cells/cell01/buses/bus1|sib-bus.xml#SIBForeignBus_1213023645293)'

+

Search Tips   |   Advanced Search