modifySIBDestination command
Use the modifySIBDestination command to change properties of a bus destination 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 modifySIBDestination changes properties of a bus destination for a service integration bus.
Target object
A bus destination.
Required parameters
- -bus
- The name of the service integration bus on which the bus destination is configured. You can use the listSIBuses command to list the names of existing buses.
- -name
- The identifier by which this destination is known for administrative purposes.
Conditional parameters
None.
Optional parameters
- -description
- Specify a description for the bus destination, for administrative purposes.
- -reliability
- Specify the default reliability level to assign to a message produced
to this destination 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。
- -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 this destination.
- 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 the 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.Note: If the strict message ordering is enabled on an existing topic destination, any existing durable subscriptions along with the messages associated become invalid. When the strict message ordering is enabled and the environment is restarted, the existing durable subscriptions are deleted and re-created; the messages that are associated with the durable subscriptions are also deleted.
- -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.
- -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 following form: destination_name@messaging_engine_name
- -useAllQueuePoints TRUE | FALSE
- If you set this option to TRUE all available queue points are used whereas, if you set this option to FALSE, only those queue points in the list specified by the -queuePoints option are used.
- -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 following form: destination_name@messaging_engine_name
- -useAllMediationPoints TRUE | FALSE
- If you set this option to TRUE all available queue points are used whereas, if you set this option to FALSE, only those queue points in the list specified by the -mediationPoints option are used.
- -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
- Using Jython:
wsadmin>AdminTask.showSIBDestination(["-bus", "abus", "-name", "myqueue"]) "{receiveExclusive=false, defaultForwardRoutingPath=[], defaultPriority=0, exceptionDestination=_SYSTEM.Exception.Destination.node01.aserver-abus, uuid=97CC75AC71E5932CAB3417AC, overrideOfQOSByProducerAllowed=true, sendAllowed=true, maxFailedDeliveries=5, maxReliability=ASSURED_PERSISTENT, reliability=ASSURED_PERSISTENT, receiveAllowed=true, identifier=myqueue}" wsadmin>AdminTask.modifySIBDestination(["-bus", "abus", "-name", "myqueue", "-receiveAllowed", "FALSE"]) wsadmin>AdminTask.showSIBDestination(["-bus", "abus", "-name", "myqueue"]) "{receiveExclusive=false, defaultForwardRoutingPath=[], defaultPriority=0, exceptionDestination=_SYSTEM.Exception.Destination.node01.aserver-abus, uuid=97CC75AC71E5932CAB3417AC, overrideOfQOSByProducerAllowed=true, sendAllowed=true, maxFailedDeliveries=5, maxReliability=ASSURED_PERSISTENT, reliability=ASSURED_PERSISTENT, receiveAllowed=false, identifier=myqueue}"
- Using Jacl:
wsadmin>$AdminTask showSIBDestination {-bus abus -name myqueue} {receiveExclusive=false, defaultForwardRoutingPath=[], defaultPriority=0, exceptionDestination=_SYSTEM.Exception.Destination.node01.aserver-abus, uuid=97CC75AC71E5932CAB3417AC, overrideOfQOSByProducerAllowed=true, sendAllowed=true, maxFailedDeliveries=5, maxReliability=ASSURED_PERSISTENT, reliability=ASSURED_PERSISTENT, receiveAllowed=true, identifier=myqueue} wsadmin>$AdminTask modifySIBDestination {-bus abus -name myqueue -receiveAllowed FALSE} (cells/9994GKCCell01/buses/abus|sib-destinations.xml#SIBQueue_1098215169998) wsadmin>$AdminTask showSIBDestination {-bus abus -name myqueue} {receiveExclusive=false, defaultForwardRoutingPath=[], defaultPriority=0, exceptionDestination=_SYSTEM.Exception.Destination.node01.aserver-abus, uuid=97CC75AC71E5932CAB3417AC, overrideOfQOSByProducerAllowed=true, sendAllowed=true, maxFailedDeliveries=5, maxReliability=ASSURED_PERSISTENT, reliability=ASSURED_PERSISTENT, receiveAllowed=false, identifier=myqueue}
Example: Modify a destination alias "MyAlias2" to use a subset of the available queue points and mediation points:
- Using Jython:
cluster=AdminConfig.list("ServerCluster").splitlines()[0] Qp1=AdminConfig.list("SIBQueueLocalizationPoint" , cluster).splitlines()[0] Mp1=AdminConfig.list("SIBMediationLocalizationPoint").splitlines()[0] AdminTask.modifySIBDestination(["-bus" , "bus1" , "-name" , "MyAlias2", "-queuePoints", [[Qp1]], "-mediationPoints" , [[Mp1]]])
- Using Jacl:
set cluster [ lindex [ $AdminConfig list ServerCluster ] 1 ] set Qp1 [ lindex [ $AdminConfig list SIBQueueLocalizationPoint $cluster ] 0 ] set Mp1 [ lindex [ $AdminConfig list SIBMediationLocalizationPoint ] 0 ] $AdminTask modifySIBDestination {-bus bus1 -name MyAlias2 -queuePoints [[$Qp1]]-mediationPoints [[$Mp1]]}
Example: Modify a destination alias to remove any limitation on the queue points used:
- Using Jython:
AdminTask.modifySIBDestination(["-bus" , "bus1" , "-name" , "MyAlias2", "-queuePoints", [[]]])
- Using Jacl:
$AdminTask modifySIBDestination {-bus bus1 -name MyAlias2 -useAllQueuePoints=true -useAllMediationPoints=true}