createSIBMQLink command
Use the createSIBMQLink command to create a new IBM MQ link for a specified service integration bus.
如果要執行這個指令,請使用 wsadmin Scripting 用戶端的 AdminTask 物件。
wsadmin Scripting 用戶端是從 Qshell 執行.
如需相關資訊,請參閱利用 wsadmin Script 配置 Qshell 來執行 WebSphere Script.
- 如需 Jython 中可用的服務整合匯流排指令清單,以及每個指令的簡要說明,請在 wsadmin 提示下,輸入下列指令:
print AdminTask.help('SIBAdminCommands')
- 如需給定指令的概觀說明,請在 wsadmin 提示下,輸入下列指令:
print AdminTask.help('command_name')
AdminConfig.save()
Purpose
The createSIBMQLink command creates a new IBM MQ link for a specified service integration bus. The IBM MQ link connects a messaging engine as a queue manager to IBM MQ, thereby providing a bridge between a service integration bus and a IBM MQ network.
Target object
A bus.
Required parameters
- -bus
- The name of the service integration bus for which you want to create the IBM MQ 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 create the IBM MQ link. The IBM MQ link connects a messaging engine as a queue manager to IBM MQ, thereby providing a bridge between a service integration bus and a IBM MQ network.
- -name
- The name by which you want the IBM MQ link to be known.
- -foreignBusName
- The name of the foreign bus that defines the IBM MQ network for the IBM MQ link. You can use thelistSIBForeignBuses command to list the names of existing foreign buses.
- -queueManagerName
- The name of the virtual queue manager associated with the messaging engine, and by which the
messaging engine is known to a remote IBM MQ network.
The queue manager name must conform to the IBM MQ naming conventions; for example, the name must be a maximum of 48 characters.
- -senderChannelTransportChain OutboundBasicMQLink | OutboundSecureMQLink
- The name of the sender channel that sends messages to the gateway queue manager. The sender channel communicates with a IBM MQ receiver channel on the gateway queue manager, and converts service integration bus messages to MQ format messages.
Conditional parameters
None.
Optional parameters
- -description
- An optional description for the bus, for administrative purposes.
- -exceptionDestination
- The destination for an inbound message when the IBM MQ link
cannot deliver the message to its target bus destination, or to the exception destination that is
configured for that target destination, or when the target destination does not exist.
- 系統
- The IBM MQ 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.Destinationmessaging_engine_name.
- 無
- The IBM MQ 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 through the link to the same bus. This option can be used to preserve message ordering.
- 指定
- The IBM MQ link uses the exception destination specified here. If this is not possible, it uses the system exception destination.
- -batchSize
The batch size does not affect the way the sender and receiver channels for this link transfer messages. Messages are always transferred individually, but are committed or backed out as a batch.
For more information about choosing the batch size, see the description of the batch size (BATCHSZ) property in the Intercommunication section of the IBM MQ information center.
Information Value Default 50 Range 1 through 9999 - -maxMsgSize
For information about how to choose an appropriate number, see the description of the Maximum message length (MAXMSGL) property in the Intercommunication section of the IBM MQ information center.
Information Value Default 4194304 bytes (4MB) Range 0 through 104857600 Specify 0 to use the largest value that the target queue manager will honor.
- -heartBeat
Heartbeats give the receiving channel the opportunity to quiesce the channel connection.
For more information about choosing the value for this property, see the Intercommunication section of the IBM MQ information center.
Information Value Default 300 seconds Range 0 through 999999 - -sequenceWrap
- For example, if you specify a value of 1000, when the message sequence number reaches 1001 it
will restart at 1.
For more information about choosing the value for this property, see the description of the Sequence Number wrap (SEQWRAP) property in the Intercommunication section of the IBM MQ information center.
Information Value Default 999999999 Range 1 through 999999999 - -nonPersistentMessageSpeed Fast | Normal
Information Value Default 快速 Range - 快速
- 如果傳輸失敗,或在傳輸訊息時通道停止,則會遺失非持續訊息。
- 一般
- 如果傳輸失敗,或訊息在傳輸時通道停止,不會失去非持續性訊息。
- -adoptable True | False
- A property of the IBM MQ link, which shows whether a running
instance of a IBM MQ link receiver channel (associated with this
IBM MQ link) should be adopted. In the event of a communications
failure, a running instance of a IBM MQ link receiver channel
might be waiting for messages. When communication is reestablished, and the partner IBM MQ sender channel next attempts to establish a session with the
IBM MQ link receiver channel, the request will fail as there is
already a running instance of the IBM MQ link receiver channel
that believes it is in session with the partner IBM MQ sender
channel. You can overcome this problem by selecting this option, which causes the already running
instance of the IBM MQ link receiver channel to be stopped and a
new instance to be started.
If you set this option to True, the IBM MQ sender channels might reestablish a connection to this IBM MQ link in the event that a communications failure has occurred and the link has not yet detected the failure condition.
Information Value Default True - -initialState Started | Stopped
- The state of the IBM MQ link, which shows whether the link is
started or stopped when the hosting messaging engine is first started. Until it is started, the IBM MQ link is unavailable.
Information Value Default 已啟動 Range - 已停止
- 當啟動相關聯的傳訊引擎時,WebSphere® MQ 鏈結是在已停止狀態中,無法與 IBM MQ 網路通訊。
- 已啟動
- 當啟動相關聯的傳訊引擎時,會自動啟動 IBM MQ 鏈結,並啟用它來與 IBM MQ 網路通訊。
- -senderChannelName
This name must be the same as the name of the receiver channel on IBM MQ.
For more information about choosing channel names, see the description of the channel name (CHANNEL) property in the Intercommunication section of the IBM MQ information center.
- -hostName
- The host name or TCP/IP address for the gateway queue manager that is used to connect into the
IBM MQ network.
Type the host name or IP address of the host on which the gateway queue manager runs.
If this field is blank, the gateway queue manager is assumed to be running on the same host as the messaging engine on which the IBM MQ link is defined.
- -port
Information Value Default 1414 Range 0 through 65535 - -connameList
- The connection name list for the gateway queue manager which is used to connect to the IBM MQ network. The connections are tried in the order in which they
are specified in the connection name list until a connection is successfully established. If no
connection is successful, the channel starts retry processing.
The connection names must be given as a comma separated list in the following format:
Dnsname1(portnumber1) , Dnsname2(portnumber2)
Type the DNS name or the IP address of the host on which the gateway queue manager is running. Type the port number in the range 0 through 65535.
If you do not specify the connection name list parameter, the gateway queue manager is assumed to be running on the same host as the messaging engine on which the IBM MQ link is defined.
If you do specify the connection name list parameter, you must have already specified a value for the sender channel name parameter, otherwise the value that you specify for the connection name list parameter is ignored.
If you specify the host name and port parameter as well as the connection name list parameter, then at runtime the connection name list takes precedence and host name and port values are ignored.
- -discInterval
The default value is a reasonable interval. Change this value only if you understand the implications for performance, and you need a different value for the requirements of the traffic flowing down your channels.
Performance is affected by the value specified for the disconnect interval. A very low value (a few seconds) can cause an unacceptable amount of processing in constantly starting up the channel. A very large value (more than an hour) might mean that system resources are unnecessarily held up.
If you want your channels to be active only when there are messages for them to transmit, you should set the disconnect interval to a fairly low value. Note that the default setting is quite high and so is not recommended for channels where this level of control is required. Because it is difficult to interrupt the receiving channel, the most economical option is to have the channel automatically disconnect and reconnect as the workload demands. For most channels, the appropriate setting of the disconnect interval can be established heuristically.
Information Value Default 900 seconds Range 0 through 999999 A value of 0 (zero) means never disconnect; the channel waits indefinitely for messages.
- -shortRetryCount
For more information about using retry mechanisms with IBM MQ, see the Intercommunication section of the IBM MQ information center.
Information Value Default 10 Range 0 through 999999999 - -shortRetryInterval
For more information about using retry mechanisms with IBM MQ, see the Intercommunication section of the IBM MQ information center.
Information Value Default 60 seconds Range 0 through 999999 - -longRetryCount
For more information about using retry mechanisms with IBM MQ, see the Intercommunication section of the IBM MQ information center.
Information Value Default 999999999 Range 0 through 999999999 - -longRetryInterval
For more information about using retry mechanisms with IBM MQ, see the Intercommunication section of the IBM MQ information center.
Information Value Default 1200 seconds Range 0 through 999999 - -senderChannelInitialState Started | Stopped
- The state of the IBM MQ link, which shows whether the sender
channel is started or stopped when the associated IBM MQ link is
first started. Until it is started, the channel is unavailable.
Information Value Default 已啟動 Range - 已停止
- 當啟動相關聯的傳訊引擎時,IBM MQ 鏈結是在已停止狀態中,無法與 IBM MQ 網路通訊。
- 已啟動
- 當啟動相關聯的傳訊引擎時,會自動啟動 IBM MQ 鏈結,並啟用它來與 IBM MQ 網路通訊。
- -receiverChannelName
This name must be the same as the name of the sender channel on IBM MQ.
- -inboundNonPersistentReliability Best effort | Reliable
This reliability delivery option is assigned to all IBM MQ nonpersistent messages flowing over this receiver channel.
Information Value Default 可靠 Range - 最大努力
- 傳訊引擎停止或失效時捨棄的訊息。訊息也可能因為用來傳送訊息的連線無法使用,或系統資源受到限制,而遭到捨棄。
- Express
- 傳訊引擎停止或失效時捨棄的訊息。如果用來傳送訊息的連線無法使用,也可能捨棄訊息。
- 可靠
- 傳訊引擎停止或失效時捨棄的訊息。
- -inboundPersistentReliability Reliable | Assured
Information Value Default 確定 Range - 可靠
- 當傳訊引擎失敗時,可能會捨棄訊息。
- 確定
- 不捨棄訊息。
- -receiverChannelInitialState Started | Stopped
- The state of the IBM MQ link, which shows whether the
receiver channel is started or stopped when the associated IBM MQ
link is first started. Until it is started, the channel is unavailable.
Information Value Default 已啟動 Range - 已停止
- 當啟動相關聯的傳訊引擎時,IBM MQ 鏈結是在已停止狀態中,無法與 IBM MQ 網路通訊。
- 已啟動
- 當啟動相關聯的傳訊引擎時,會自動啟動 IBM MQ 鏈結,並啟用它來與 IBM MQ 網路通訊。
- -preferLocal TRUE | FALSE
- This option indicates that 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
7.0 版或更新版本 server.
This option is supported only when used by a JMS application that is running with a WebSphere Application Server 7.0 版或更新版本 server or client, and that is connected to a messaging engine running on WebSphere Application Server 7.0 版或更新版本 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
AdminTask.createSIBMQLink('[-bus bus1 -messagingEngine cluster1.000-bus1
-name myMQLink2 -foreignBusName MQNetwork2 -queueManagerName MQMgrIPL
-senderChannelTransportChain OutboundBasicMQLink]')
'myMQLink2(cells/cell01/nodes/node01/servers/server1|sib-engines.xml#
SIBMQLink_1132607756126)'
Create a SIBMQLink that uses queue points on the same messaging engine as the target destination, whenever possible.
AdminTask.createSIBMQLink('[-bus bus1 -messagingEngine cluster1.000-bus1
-name MyMQLink -foreignBusName -MQQMgr1 -queueManagerName bus1
-senderChannelTransportChain OutboundBasicMQLink -preferLocal TRUE]')