modifySIBWMQServer command
Use the modifySIBWMQServer command to modify a IBM MQ server.
We can modify a IBM MQ server using the wsadmin tool, or using the administrative console as described in Modifying an IBM MQ server definition.
To run the command, use the AdminTask object of the wsadmin scripting client.
(iSeries) (iSeries) The wsadmin scripting client is run from Qshell. (iSeries) See Configure Qshell to run WebSphere scripts .
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 at the wsadmin prompt:
print AdminTask.help('SIBAdminCommands')
- For overview help on a given command, enter at the wsadmin prompt:
print AdminTask.help('command_name')
After using the command, save the changes to the master configuration using the following command:
AdminConfig.save()
A IBM MQ server represents an IBM MQ queue manager or (for IBM MQ for z/OS) queue-sharing group. This command modifies a IBM MQ server. It is not possible to modify the name or type attributes using this command.
When modifying a IBM MQ server, it is important to understand the significance of the name and serverName attributes. For example, if a WAS administrator creates a IBM MQ server called "My European Area Server" that represents an IBM MQ queue manager with the serverName QM1, it would then be possible for the administrator to create a second IBM MQ server called "My UK Country Server", which also represents the same queue manager.
Target object
A selected IBM MQ server.
Required parameters
- -name
- The name of the IBM MQ server. The name is specified when creating the IBM MQ server definition.
Conditional parameters
None
Optional parameters
- -serverName
- Name of the queue manager or queue-sharing group. This is the name by which the queue manager or queue-sharing group is identified. The value is allocated by IBM MQ administration to that IBM MQ resource. The administrator always uses the name that is allocated by IBM MQ administration.
- -host
- New value for the host attribute. This value is the name or the IP address of the host to which a connection is established when communicating with a queue manager or queue-sharing group that this IBM MQ server represents. The value is a string and must be one of the following:
- Symbolic host name
- IPv4 address
- IPv6 address
- -bindingsMode
- New value for the bindingsMode attribute. This value determines whether bindings transport mode connections are used when connecting to a queue manager or queue-sharing group. Bindings mode connection is possible if the application server and the queue manager are on the same node, but connection is only allowed to a single queue manager, even if multiple queue managers exist on the same node. This parameter has two possible values:
The default is TRUE.
- TRUE
- Bindings mode is used if available. If we select this option and bindings mode is not available, the connections mechanism defaults to client transport mode.
- FALSE
- Client mode is always used.
- -port
- New value for the IBM MQ port attribute. This value is the TCP/IP port number on which the queue manager or queue-sharing group that this IBM MQ server represents listens. The default is 1414.
- -channel
- New value for the IBM MQ channel attribute. This value is the IBM MQ client channel name to use when connecting to the queue manager or queue sharing group that this IBM MQ server represents. This name is allocated by IBM MQ administration to the IBM MQ object, and must always be used by the WAS administrator. The default is SYSTEM.DEF.SVRCONN.
- -description
- New value for the description attribute. This value is a short description of the IBM MQ server, and is used for administrative purposes only.
- -securityAuthAlias
- New value for the securityAuthorizationAlias attribute. This value is the authentication alias to use when connecting to a queue manager or queue-sharing group. This parameter is not the same as the discovery authentication alias.
- -transportChain
- New value for the transportChain attribute. This value is the outbound transport chain to use when establishing a connection with IBM MQ. The default is OutboundBasicWMQClient.
- -trustUserIds
- New value for the trustUserIds attribute. Determines whether user IDs received in messages from IBM MQ are propagated into the message or not (that is, whether user IDs received as part of message data are used in the service integration bus). The application user ID is always set from the jsAppUserId RFH2 value. If this is not present (either because the key/value pair is not present in the RFH2 header, or because the message does not have a RFH2 header), this field is not set. If we set this value to FALSE, the user ID is overwritten with the IBM MQ server name. This parameter has two possible values:
The default is TRUE.
- TRUE
- User IDs are propagated into messages.
- FALSE
- User IDs are not propagated into messages.
- -allowDiscovery
- New value for the allowDiscovery attribute. This value determines whether automated discovery of IBM MQ resources is performed. This parameter has two possible values:
The default is TRUE.
- TRUE
- Automatic resource discovery is enabled.
- FALSE
- Automatic resource discovery is disabled.
- -discoveryAuthAlias
- New value for the discoveryAuthAlias attribute. This value is the authentication alias to use when establishing a resource discovery connection to a queue manager or queue-sharing group, and is not the same as the security authentication alias parameter.
- -replyToQueue
- New value for the replyToQueue attribute. This value is the reply-to queue to use for resource discovery, is the name allocated by IBM MQ administration to the IBM MQ object, and must be the name of a model queue for a temporary dynamic queue. WAS administration must always use the name that is agreed with IBM MQ administration. The default is SYSTEM.DEFAULT.MODEL.QUEUE.
Example
- Use Jython:
wsadmin>AdminTask.modifySIBWMQServer(["-name", "Finance dept QM", "-allowDiscovery", "false"] )- Use Jacl:
wsadmin>$AdminTask modifySIBWMQServer {-name "Finance dept QM" -allowDiscovery false}