Use the modifySIBWMQServer command to modify
a WebSphere MQ server definition.
To run the command, use the AdminTask
object of the wsadmin
scripting client.
The wsadmin scripting client is run from
Qshell. For more information, see the topic "Configure Qshell to
run WebSphere Application Server scripts".
This command is only valid when used with
WebSphere Application Server Version 6.1 and later application servers.
Do not use it with earlier versions.
Command-line help
is provided for service integration bus commands:
After using the command,
save your changes to the master configuration; for example, by using
the following command:
$AdminConfig save
Purpose
You use a WebSphere MQ server to configure a direct (single bus) connection to a WebSphere MQ for z/OS queue manager or queue sharing group. This
command modifies a WebSphere MQ server. It is not possible to modify the name
or type attributes using this command.
Note: When modifying a WebSphere
MQ server, it is important to understand the significance of the name and
serverName attributes. For example, if a WebSphere Application Server administrator
creates a WebSphere MQ server called My European Area Server which represents
a WebSphere MQ queue manager
with the serverName QM1, it would then be possible for the administrator to
create a second WebSphere MQ server called My UK Country Server, which also
represents the same queue manager.
Target object
A selected WebSphere MQ server.
Required parameters
- -name
- The name of the WebSphere MQ server. The name is specified when creating
the WebSphere MQ server.
Conditional parameters
None
Optional parameters
- -serverName
- Name of the queue manager or queue sharing group, and is the name by which
the queue manager or queue sharing group is identified. The value is allocated
by WebSphere MQ administration
to that WebSphere MQ resource.
The administrator always use the name that is allocated by WebSphere 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 WebSphere MQ server represents.
The value is a string and must be one of the following:
- Symbolic host name
- IPv4 address
- IPv6 address
- -bindingsMode TRUE | FALSE
- New value for the bindingsMode attribute. This value determines whether
or not 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:
- TRUE
- Bindings mode is used if available. If you select this option and bindings
mode is not available, the connections mechanism defaults to client transport
mode.
- FALSE
- Client mode is always used.
The default is TRUE.
- -port
- New value for the WebSphere MQ port attribute. This value is the TCP/IP
port number on which the queue manager or queue sharing group that this WebSphere
MQ server represents listens. The default value is 1414.
- -channel
- New value for the WebSphere MQ channel attribute. This value is the WebSphere
MQ client channel name to use when connecting to the queue manager or queue
sharing group that this WebSphere MQ server represents. This name is allocated
by WebSphere MQ administration to the WebSphere MQ object, and must always
be used by the WebSphere Application Server administrator. The default value
is SYSTEM.DEF.SVRCONN.
- -description
- New value for the description attribute. This value is a short description
of the WebSphere 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 WebSphere MQ. The
default is OutboundBasicWMQClient.
- -trustUserIds TRUE | FALSE
- New value for the trustUserIds attribute. Determines whether or not user
identifiers received in messages from WebSphere MQ are
propagated into the message or not (that is, whether or not user identifiers
received as part of message data are used in the service integration bus).
The application user identifier 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 you set this value to FALSE, the user identifier is overwritten
with the WebSphere MQ server's name. This parameter has two possible values:
- TRUE
- User identifiers are propagated into messages.
- FALSE
- User identifiers are not propagated into messages.
The default is TRUE.
- -allowDiscovery TRUE | FALSE
- New value for the allowDiscovery attribute. This value determines whether
or not automated discovery of WebSphere MQ resources is performed. This parameter
has two possible values:
- TRUE
- Automatic resource discovery is enabled.
- FALSE
- Automatic resource discovery is disabled.
The default is TRUE.
- -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 WebSphere MQ administration
to the WebSphere MQ object, and must be the name of a model queue for a temporary
dynamic queue. WebSphere Application Server administration must always use
the name that is agreed with WebSphere MQ administration. The default is SYSTEM.DEFAULT.MODEL.QUEUE.
Example
wsadmin>$AdminTask modifySIBWMQServer {-name "Finance dept QM" -allowDiscovery false}