modifySIBMQLink command
Use the modifySIBMQLink command to modify the properties of a Link do WebSphere® MQ.
Para executar o comando, utilize o objeto AdminTask do cliente de script wsadmin.
O cliente de script wsadmin é executado do Qshell.
Para obter informações adicionais, consulte Configurando o Qshell para Executar Scripts do WebSphere Usando o Script wsadmin.
- Para obter uma lista dos comandos de barramento de integração de
serviços disponíveis no Jython e uma breve descrição de cada comando, digite o seguinte
comando no prompt wsadmin:
print AdminTask.help('SIBAdminCommands')
- Para obter ajuda de visão geral sobre um determinado comando, digite o seguinte comando no prompt wsadmin:
print AdminTask.help('command_name')
AdminConfig.save()
Purpose
The modifySIBMQLink command modifies the properties of a IBM MQ link.
Target object
A IBM MQ link.
Required parameters
- -bus
- The name of the service integration bus for which you created the Link do IBM MQ. You can use the listSIBuses command to list the names of existing buses.
- -messagingEngine
- The name of the messaging engine for which you created the IBM MQ link. You can use the listSIBEngines command to list the names of existing messaging engines.
- -name
- The name of the IBM MQ link.
Conditional parameters
None.
Optional parameters
- -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.
- -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.
- System
- 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.
- Nenhum
- 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.
- Especificar
- 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 100 through 999999999 - -nonPersistentMessageSpeed Fast | Normal
Information Value Default Rápido Range - Rápido
- As mensagens não persistentes podem ser perdidas se houver um defeito de transmissão ou se o canal parar quando as mensagens estiverem em trânsito.
- Normal
- As mensagens não persistentes não serão perdidas se houver um defeito de transmissão ou se o canal parar quando as mensagens estiverem em trânsito.
- -adoptable True | False
- A property of the Link do IBM MQ, which shows whether a running instance of a Link do IBM MQ receiver channel
(associated with this Link do IBM MQ) should be adopted. In the event of a communications failure, a running
instance of a Link do IBM MQ 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
Link do IBM MQ receiver channel, the request will fail as there is already a running instance of the Link do IBM MQ
receiver channel that believes it is in session with the partner Link do IBM MQ sender channel. You
can overcome this problem by selecting this option, which causes the already running instance of the
Link do IBM MQ 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 Link do IBM MQ 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 Link do IBM MQ, which shows
whether the link is started or stopped when the hosting messaging
engine is first started. Until it is started, the Link do IBM MQ is unavailable.
Information Value Default Started Range - Parado
- Quando o mecanismo do sistema de mensagens associado for iniciado, o Link do IBM MQ estará em um estado pausado e não poderá se comunicar com o IBM MQ 1.2.
- Started
- Quando o mecanismo do sistema de mensagens associado for iniciado, o Link do IBM MQ será iniciado automaticamente e será ativado para comunicação com o IBM MQ 1.2.
- -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 Link do IBM MQ 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 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
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 Link do IBM MQ, which shows whether the sender
channel is started or stopped when the associated Link do IBM MQ is first started. Until it is started, the channel is unavailable.
Information Value Default Started Range - Parado
- Quando o mecanismo do sistema de mensagens associado for iniciado, o Link do IBM MQ estará em um estado pausado e não poderá se comunicar com o IBM MQ 1.2.
- Started
- Quando o mecanismo do sistema de mensagens associado for iniciado, o Link do IBM MQ será iniciado automaticamente e será ativado para comunicação com o IBM MQ 1.2.
- -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 Confiável Range - Melhor Esforço
- As mensagens são descartadas quando um mecanismo do sistema de mensagens para ou falha. As mensagens também podem ser descartadas se uma conexão usada para enviá-las torna-se disponível ou como um resultado de recursos do sistema restrito.
- Express
- Confiável
- As mensagens são descartadas quando um mecanismo do sistema de mensagens para ou falha.
- -inboundPersistentReliability Reliable | Assured
Information Value Default Assegurada Range - Confiável
- As mensagens podem ser descartadas quando um mecanismo do sistema de mensagens falha.
- Assegurada
- As mensagens não são descartadas.
- -receiverChannelInitialState Started | Stopped
- The state of the Link do IBM MQ, which shows
whether the receiver channel is started or stopped when the associated Link do IBM MQ is first started. Until
it is started, the channel is unavailable.
Information Value Default Started Range - Parado
- Quando o mecanismo do sistema de mensagens associado for iniciado, o Link do IBM MQ estará em um estado pausado e não poderá se comunicar com o IBM MQ 1.2.
- Started
- Quando o mecanismo do sistema de mensagens associado for iniciado, o Link do IBM MQ será iniciado automaticamente e será ativado para comunicação com o IBM MQ 1.2.
- -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 Version 7.0 or
later server.
This option is supported only when used by a JMS application that is running with a WebSphere Application ServerVersão 7.0 ou posterior server or client, and that is connected to a messaging engine running on WebSphere Application ServerVersão 7.0 ou posterior 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
Show the properties of a Link do IBM MQ, modify the link to change the batch size, then show the properties of the link again.
wsadmin>AdminTask.showSIBMQLink('[-bus myBus -messagingEngine myHostNode01.server1-myBus
-mqLink myMQLink]')
'{nonPersistentMessageSpeed=FAST, qmName=myBus, adoptable=false, sequenceWrap=999999999,
name=myMQLink, targetUuid=738AE126B908E5451A3D4691, initialState=STARTED,
senderChannel=null, brokerProfile=[], receiverChannel=null, preferLocalQueuePoints=true,
batchSize=50, uuid=6B89C4F08AB072C5, heartBeat=300, description=null, maxMsgSize=4194304,
exceptionDestination=_SYSTEM.Exception.Destination.myHostNode01.server1-myBus}'
wsadmin>
wsadmin>AdminTask.modifySIBMQLink('[-bus myBus -messagingEngine myHostNode01.server1-myBus
-name myMQLink -batchSize 100]')
'myMQLink(cells/cell01/nodes/node01/servers/server1|sib-engines.xml#SIBMQLink_1132608724468)'
wsadmin>AdminTask.showSIBMQLink('[-bus myBus -messagingEngine myHostNode01.server1-myBus
-mqLink myMQLink]')
'{nonPersistentMessageSpeed=FAST, qmName=myBus, adoptable=false, sequenceWrap=999999999,
name=myMQLink, targetUuid=738AE126B908E5451A3D4691, initialState=STARTED,
senderChannel=null, brokerProfile=[], receiverChannel=null, preferLocalQueuePoints=true,
batchSize=100, uuid=6B89C4F08AB072C5, heartBeat=300, description=null, maxMsgSize=4194304,
exceptionDestination=_SYSTEM.Exception.Destination.myHostNode01.server1-myBus}'
wsadmin>
Modify a Link do IBM MQ so that the link has no preference for which queue points to use.
wsadmin>AdminTask.modifySIBMQLink('[-bus Bus1 -messagingEngine
node1.node1server1-Bus1 -name MQLink -queueManagerName QM2 -preferLocal FALSE]')
wsadmin>