createSIBForeignBus command

Use the createSIBForeignBus command to create a new service integration foreign bus.

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

[IBM i][IBM i]The wsadmin scripting client is run from Qshell.

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

    print AdminTask.help('command_name')

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

AdminConfig.save()

Purpose

This command creates a new foreign bus for a specified service integration bus. A foreign bus represents a bus with which another bus can exchange messages.

Target object

A specified service integration bus.

Required parameters

-bus busname
The name of the service integration bus for which you want to create the foreign bus. You can use the listSIBuses command to list the names of existing buses.
-name busname
The name by which you want the foreign bus to be known.
Notes:
  • When you create a foreign bus that represents another service integration bus, the name of the foreign bus must match the name of the other service integration bus.
  • When you intend to link two buses directly, you must assign them unique names.
  • You must not change the name of a foreign bus name after it has been configured.
-routingType Direct | Indirect
Create a foreign bus with the physical link (also known as the routing type) specified:
Direct
A service integration bus link from a messaging engine in the local bus to a messaging engine in the foreign bus.
Indirect
An indirect link, that is, a link that is made through one or more intermediate foreign buses.

Conditional parameters

None.

Optional parameters

-description text
An optional description for the bus, for administrative purposes.
-type MQ | SIBus
Create a foreign bus with the type specified:
MQ
Create a foreign bus to link the service integration bus to an IBM MQ network.
SIBus
Create a foreign bus to link the service integration bus to another service integration bus.
-sendAllowed True | 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 inbound messages sent from a foreign bus to destinations in a secure service integration bus. If the bus is not secure, the inbound user ID property has no affect on messages. You might want to specify an inbound user ID for use in the following scenarios:
  • The foreign bus and the secure service integration bus are in different security domains, and the foreign bus user IDs are not recognized by the secure bus.
  • You want local control over access to the secure bus by inbound messages.
Note that if the receiving service integration bus is secure but the foreign bus is not secure, and an inbound user ID is not set, an inbound message from the foreign bus is 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 an IBM 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. You can specify multiple pairs of topic spaces.

Example 

AdminTask.createSIBForeignBus('[-bus bus1 -name foreignbus1 -routingType Direct
-type SIBus]') 
'foreignbus1(cells/cell01/buses/bus1|sib-bus.xml#SIBForeignBus_1213023645293)'