createSIBDestinations command
Use the createSIBDestinations command to create new bus destinations for a 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 createSIBDestinations command creates multiple new bus destinations for a service integration bus, all with the same properties. If the destinations created are alias destinations, they all target the same destination. With this command, the new bus destinations can also be localized to a WebSphere® MQ server bus member.
Target object
A service integration bus.
Required parameters
- -bus
- The name of the service integration bus on which to create the bus destinations. To list the names of existing buses, use the listSIBuses command.
- -nameList
- The list of identifiers by which these destinations are known for administrative purposes.
- -type
- Indicates the type of bus destination that you want to create:
- Alias
- An alias destination, that provides a level of abstraction between applications and the underlying target bus destinations that hold messages. Applications interact with the alias destination, so the target bus destination can be changed without changing the application.
- Foreign
- A foreign destination, which identifies a destination on another bus, and enables applications on one bus to access the destination on another bus directly.
- Port
- Represents a particular message and transport binding for an outbound service that communicates with an externally-hosted target web service.
- Queue
- A queue, for point-to-point messaging.
- TopicSpace
- A topic space, for publish/subscribe messaging.
- WebService
- Represents an externally-hosted target web service.
Conditional parameters
None.
Optional parameters
- -cluster
- To assign the bus destinations to a cluster bus member, specify the name of the cluster. Do not specify the -node, -server or -wmqServer parameters.
- -node
- To assign the bus destinations to a server bus member, specify both the name of the node on which the server runs and the name of the server. Do not specify the -cluster or -wmqServer parameters.
- -server
- To assign the bus destinations to a server bus member, specify both the name of the node on which the server runs and the name of the server. Do not specify the -cluster or -wmqServer parameters.
- -wmqServer
- To assign the bus destinations to a IBM MQ queue, specify both the name of the WebSphere MQ server bus member where the destination is assigned (this parameter), and the name of the IBM MQ queue used to store messages sent to the destinations (the -wmqQueueName parameter). Set the-wmqServer parameter to the name you gave when you created the WebSphere MQ server. Set the -wmqQueueName parameter to the name allocated to the IBM MQ queue by IBM MQ administration. Do not specify the -cluster, -node or -server parameters.
- -aliasBus
- If you are creating alias destinations, specify the source bus name of the alias mapping.
- -targetBus
- If you are creating alias destinations, specify the name of the bus to which the alias destinations are mapped.
- -targetName
- If you are creating alias destinations, specify the name of the destination to which the alias destinations are mapped.
- -foreignBus
- If you are creating foreign destinations specify the name of the foreign bus.
- -description
- Specify a description for the bus destinations for administrative purposes.
- -reliability
- Specify the default reliability level to assign to messages produced
to these destinations when an explicit reliability has not been set
by the producer application. 服務整合支援可靠性層次(也稱為遞送選項或服務品質):
- BEST_EFFORT_NONPERSISTENT
- 傳訊引擎停止或失效時捨棄的訊息。訊息也可能因為用來傳送訊息的連線無法使用,或系統資源受到限制,而遭到捨棄。
- EXPRESS_NONPERSISTENT
- 傳訊引擎停止或失效時捨棄的訊息。如果用來傳送訊息的連線無法使用,也可能捨棄訊息。
- RELIABLE_NONPERSISTENT
- 傳訊引擎停止或失效時捨棄的訊息。
- RELIABLE_PERSISTENT
- 當傳訊引擎失敗時,可能會捨棄訊息。
- ASSURED_PERSISTENT
- 不捨棄訊息。
Note: 可靠性層次越高,效能影響越大。如需服務整合可靠性層次的相關資訊,請參閱Message reliability levels - JMS delivery mode and service integration quality of service。
- -maxReliability
- Specify the maximum reliability level that is accepted for values
specified by producer applications. 服務整合支援可靠性層次(也稱為遞送選項或服務品質):
- BEST_EFFORT_NONPERSISTENT
- EXPRESS_NONPERSISTENT
- RELIABLE_NONPERSISTENT
- RELIABLE_PERSISTENT
- ASSURED_PERSISTENT
如需服務整合可靠性層次的相關資訊,請參閱Message reliability levels - JMS delivery mode and service integration quality of service。
- -nonPersistentReliability
Specify the service integration quality of service to use with nonpersistent IBM MQ messages that are received by service integration from a IBM MQ network. IBM MQ 網路中的訊息有它們自己的服務品質層次。這是持續性或非持續性。 當服務整合應用程式收到這些訊息時,它們會被指派服務整合的服務品質層次,這會隨著它們的 IBM MQ 服務品質層次而不同。
For nonpersistent IBM MQ messages received, the default service integration quality of service is RELIABLE_NONPERSISTENT. If you choose to override this default, you will probably choose one of the other nonpersistent service integration qualities of service BEST_EFFORT_NONPERSISTENT or EXPRESS_NONPERSISTENT. However, you can choose any of the five possible service integration qualities of service:- BEST_EFFORT_NONPERSISTENT
- EXPRESS_NONPERSISTENT
- RELIABLE_NONPERSISTENT
- RELIABLE_PERSISTENT
- ASSURED_PERSISTENT
For more information, see Mapping the JMS delivery option and message reliability to and from the IBM MQ persistence value.
- -persistentReliability
Specify the service integration quality of service to use with persistent IBM MQ messages that are received by service integration from a IBM MQ network. IBM MQ 網路中的訊息有它們自己的服務品質層次。這是持續性或非持續性。 當服務整合應用程式收到這些訊息時,它們會被指派服務整合的服務品質層次,這會隨著它們的 IBM MQ 服務品質層次而不同。
For persistent IBM MQ messages received, the default service integration quality of service is ASSURED_PERSISTENT. If you choose to override this default, you will probably choose the other persistent service integration quality of service RELIABLE_PERSISTENT. However, you can choose any of the five possible service integration qualities of service:- BEST_EFFORT_NONPERSISTENT
- EXPRESS_NONPERSISTENT
- RELIABLE_NONPERSISTENT
- RELIABLE_PERSISTENT
- ASSURED_PERSISTENT
For more information, see Mapping the JMS delivery option and message reliability to and from the IBM MQ persistence value.
- -overrideOfQOSByProducerAllowed TRUE | FALSE
- 控制生產者和目的地之間訊息流程的服務品質。 請選取這個選項,用生產者指定的服務品質來取代定義給目的地的品質。
- -defaultPriority number
- -maxFailedDeliveries number
- Specify a value in the range 0 through 2147483647. A value of 0 (zero) means that if a message cannot be delivered on the first attempt, it is either forwarded to the exception destination or discarded, as defined by the -exceptionDestination parameter.
- -exceptionDestination value
- 依預設,無法遞送到這個目的地的所有訊息,都會重新遞送到已獲指派這個目的地之傳訊引擎的系統預設異常狀況目的地 (_SYSTEM.Exception.Destination.messaging_engine_name)。請利用這個參數來置換預設值。
您可以對這個目的地設定特定的異常狀況目的地,也可以輸入空字串 (""),指定無法遞送的訊息不要重新遞送到異常狀況目的地,這時失敗的遞送次數上限計數沒有作用。 Note: 無法遞送的訊息可能會阻斷等待送往相同目的地之其他訊息的處理。
- 您可以使用這個選項,指定無異常狀況目的地,以保留訊息排序。
- -sendAllowed TRUE | FALSE
- Clear this option (setting it to FALSE) to stop
producers from being able to send messages to these destinations.
- For a queue point of a non-mediated destination, or a mediation point of a mediated destination, if you clear this option then new messages (from attached producers or forwarded from another destination) are redirected to any available message point. If no message points are available, then messages that have already been accepted onto the bus, and new messages from attached producers, are preserved by the bus until a message point becomes available. The only exception to this is the case of a destination with only one message point (queue point or mediation point depending on whether the destination is mediated or non-mediated), where the producer is attached to the same messaging engine. In this case, an exception message is generated on each send call. The exception message indicates that the only extant localization has been disabled for send. The producer remains open as usual, and any more send calls succeed if the Send allowed property of the localization is reselected (reset to TRUE).
- For a queue point of a mediated destination, if you clear this option then messages from mediation instances are redirected to any available message point. If no message points are available, then the messages are preserved by the bus until a message point becomes available. For any mediation instance (that is, on any server that has a mediation point), if the same server hosts a queue point, and that queue point is the only queue point for the destination, then the mediation changes to the "stopped on error" state.
- -receiveAllowed TRUE | FALSE
- For the message point, if you clear this option then any open consumers change state and an exception is generated if the consumer requests a message. Messages can continue to be sent, and accumulate on the message point.
- -receiveExclusive TRUE | FALSE
- Select this option (setting it to true) to allow only one consumer to attach to a destination. If you select this option, only a single consumer can be attached to each queue point of a queue destination at any one time. Subsequent consumers attempting to attach to a queue point with a consumer already attached are rejected.
- -maintainStrictMessageOrder TRUE | FALSE
- Select this option (setting it to TRUE) to maintain the order in which a producer sends messages to a destination.
- At run time, this property has priority over other configuration property values. For information about the configuration properties that are overridden at run time, see Strict message ordering for bus destinations.
- -topicAccessCheckRequired
- Include this option if authorization checks are required for access to topics.
- -replyDestination
- This property is intended for use with mediations on reply messages. For more information about the use of this property, see Configuring a destination reverse routing path.
- -replyDestinationBus
- The name of the bus on which the reply destination is configured. This property is intended for use with mediations on reply messages. For more information about the use of this property, see Configuring a destination reverse routing path.
- -delegateAuthorizationCheckToTarget
- Include this option if you want the authorization check to be performed on the target destination.
- -wmqQueueName
- To assign these bus destinations to a IBM MQ queue, specify both the name of the WebSphere MQ server bus member where the destinations are assigned (the -wmqServer parameter), and the name of the IBM MQ queue used to store messages sent to these destinations (this parameter). Set the-wmqServer parameter to the name you gave when you created the WebSphere MQ server. Set the -wmqQueueName parameter to the name allocated to the IBM MQ queue by IBM MQ administration. Do not specify the -cluster, -node or -server parameters.
- -useRFH2 or -mqRfh2Allowed TRUE | FALSE
- Determines whether messages sent to these destinations have an MQRFH2 header.
- When service integration converts a message from the service integration format to IBM MQ format, by default it includes an MQRHF2 header in the IBM MQ message. This header contains message attributes, such as JMS message attributes, which are not IBM MQ message attributes and therefore do not appear in the IBM MQ message descriptor (MQMD). Some IBM MQ applications cannot process messages that include an MQRFH2 header. If messages sent to this destination will be processed by IBM MQ applications that cannot tolerate an MQRFH2, clear this option (setting it to FALSE).
- If you are assigning queue-type destinations to a WebSphere MQ server bus member, use the -useRFH2 parameter. If you are creating alias destinations or foreign destinations, use the -mqRfh2Allowed parameter.
- -auditAllowed TRUE | FALSE
- Clear this option (setting it to FALSE) to prevent the bus from auditing topic level authorization checks when the bus and application server have auditing enabled. The default value is TRUE. You must have Audit Administrator privileges to use this parameter. The parameter is ignored if it is used in the creation of other types of destination.
- -defaultForwardRoutingPath
- The value to which a message forward routing path is set if the message contains no forward routing path. This identifies a sequential list of intermediary bus destinations that messages must pass through to reach a target bus destination. The format of the field is a list of bus destinations specified as bus_name:destination_name.
- -queuePoints
- A list of the queue points used by users of the alias destination.
If no specific queue points are supplied, all queue points can be
used. The target destination must be a queue destination in the same
bus as the alias destination definition. The target destination must
also be a queue destination with multiple queue points.
A queue point is specified in the form destination_name@messaging_engine_name.
- -mediationPoints
- A list of the mediation points used by users of the alias destination.
If no specific mediation points are supplied, all mediation points
can be used. The target destination must be a mediated queue destination
in the same bus as the alias destination definition. The target destination
must also be a queue destination with multiple mediation points.
A mediation point is specified in the form destination_name@messaging_engine_name.
- -persistRedeliveryCount TRUE | FALSE
- Select this option (setting it to TRUE) to persist
the failed delivery counts of JMS messages in the message store. The
value for the option is set to FALSE by default.Important: Although the property is selected, the property will not be effective until the database tables are upgraded using the sibDBUpgrade command for WebSphere Application Server 9.0 版 and later.
Example 1
- Using Jython:
wsadmin>AdminTask.createSIBDestinations("[-bus bus1 -type QUEUE -cluster cluster1 -nameList [[-identifier myqueue1][-identifier myqueue2]]]") "(cells/9994GKCCell01/buses/bus1|sib-destinations.xml#SIBQueue_1098215169998)"
- Using Jacl:
wsadmin>$AdminTask createSIBDestinations {-bus bus1 -type QUEUE -cluster cluster1 -nameList {{myqueue1} {myqueue2}}} (cells/9994GKCCell01/buses/bus1|sib-destinations.xml#SIBQueue_1098215169998)
Example 2:
- Using Jython:
wsadmin>AdminTask.createSIBDestinations("[-bus bus1 -type ALIAS -nameList [[MyAlias1][MyAlias2]] -aliasBus bus1 -targetName MyDestination1 -reliability INHERIT -maxReliability INHERIT -overrideOfOQSByProducerAllowed INHERIT -sendAllowed INHERIT -receiveAllowed INHERIT -queuePoints [[MyDestination1@cluster1.001-bus1] [MyDestination1@cluster1.002-bus1]]]")
- Using Jacl:
wsadmin>set cluster [ lindex [ $AdminConfig list ServerCluster ] 1 ] wsadmin>$AdminTask createSIBDestinations {-bus bus1 -type ALIAS -nameList {{MyAlias1} {MyAlias2}} -aliasBus bus1 -targetName MyDestination1 -reliability INHERIT -maxReliability INHERIT -overrideOfOQSByProducerAllowed INHERIT -sendAllowed INHERIT -receiveAllowed INHERIT -queuePoints {{"MyDestination1@cluster1.001-bus1"} {"MyDestination1@cluster1.002-bus1}}}