createSIBWMQServer command
Use the createSIBWMQServer command to create a new WebSphere MQ server at cell scope.
We can create a new WebSphere MQ server by as described in this topic, or by using the administrative console as described in Create 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 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
the following command at the wsadmin prompt:
print AdminTask.help('SIBAdminCommands')
- For overview help on a given command, enter the following command 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()
Purpose
A WebSphere MQ server represents a WebSphere MQ queue manager or (for WebSphere MQ for z/OS) queue-sharing group. This command creates a new WebSphere MQ server at cell scope, and uses the supplied values to populate its parameters.
When creating a WebSphere MQ server, it is important to understand the significance of the -name and -serverName parameters. For example, if WebSphere Application Server administration created a WebSphere MQ server object with the name "My European area server" that represented a WebSphere MQ queue manager with the serverName QM1. WebSphere Application Server administration could then create a second WebSphere MQ server object with the name "My UK country server", that also represented the same WebSphere MQ queue manager with the serverName QM1.
Target object
A WAS cell.
Required parameters
- -name
- The name of the WebSphere MQ server. This value is for administrative purposes only and can be decided by the administrator. The name is only meaningful inside WebSphere Application Server administration, and must be unique at cell level. There is no default value. This parameter cannot be modified.
- -serverName
- The name of the queue manager or queue-sharing group. This value is the name by which the queue manager or queue-sharing group is identified, and is allocated by WebSphere MQ administration to that WebSphere MQ object. The WebSphere Application Server administrator must always use the name allocated by WebSphere MQ administration.
- -host
- The host to which a connection is established for communicating
with a queue manager or queue-sharing group. Host
name or the IP address of the 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
- symbolic host name
- -transportChain
- The channel framework outbound transport chain to use when establishing a connection with WebSphere MQ. If we do not specify this option, a default value of OutboundBasicWMQClient is assumed.
Conditional parameters
None
Optional parameters
The optional host, port, channel, and authentication alias attributes together specify the connection access path to this WebSphere MQ server, for messaging applications running in service integration. For more information, see WebSphere MQ server: Connection and authentication.
- -port
- 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
- 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 value is the name allocated by WebSphere MQ administration to the WebSphere MQ object, and must always be used by WebSphere Application Server administration. The default value is SYSTEM.DEF.SVRCONN.
- -description
- A short description of the WebSphere MQ server. This value is used for administrative purposes only.
- -securityAuthAlias
- The authentication alias to use when connecting to a queue manager or queue-sharing group. This parameter should not be confused with the discovery authentication alias.
- -trustUserIds
- Determines whether user IDs received in messages
from WebSphere MQ are passed on with the messages by 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 WebSphere MQ
server name. This parameter has two possible values:
- TRUE
- User IDs are propagated into messages.
- FALSE
- User IDs are not propagated into messages.
The default is TRUE.
- -allowDiscovery
- Determines whether automated discovery of WebSphere MQ resources is performed.
This parameter has two possible values:
- TRUE
- Automated discovery is used.
- FALSE
- Automated discovery is not used.
The default is TRUE.
- -discoveryAuthAlias
- The authentication alias to use when establishing a resource discovery connection to the queue manager or queue-sharing group. This value should not be confused with the security authentication alias.
- -replyToQueue
- The reply-to queue to use for resource discovery. This value 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. The WebSphere Application Server administrator must always use the name allocated by WebSphere MQ administration. The default is SYSTEM.DEFAULT.MODEL.QUEUE.
- -type
- Determines whether the WebSphere MQ server object is either a queue manager or a queue-sharing group, as determined
by WebSphere Application Server administration.
This parameter had two possible values:
- MQ_QUEUE_MANAGER
- The WebSphere MQ server represents a queue manager. If we select this value, the resource discovery process retrieves queue names that belong to queue managers.
- MQ_QUEUE_SHARING_GROUP
- The WebSphere MQ server represents a queue-sharing group. If we select this value, the resource discovery process retrieves queue names that belong to queue-sharing groups.
- -bindingsMode
- Determines whether bindings transport mode connections
are used when connecting to a queue manager or queue-sharing group.
Bindings mode connection is available if the application server and the queue manager are on the same node. It is only possible to connect
to a single queue manager in bindings mode, even if multiple queue
managers exist on the same node. This parameter has two possible values:
- 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.
Example
- Jython:
- wsadmin>AdminTask.createSIBWMQServer(["-name", "Finance dept QM", "-serverName", "FDQM", "-type", "MQ_QUEUE_MANAGER", "-bindingsMode", "true", "-host", "findep01.ibm.com", "-port", 1414, "-transportChain", "OutboundSecureWMQClient"])
- Jacl:
- wsadmin>$AdminTask createSIBWMQServer {-name "Finance dept QM" -serverName FDQM -type MQ_QUEUE_MANAGER -bindingsMode true -host findep01.ibm.com -port 1414 -transportChain OutboundSecureWMQClient}
Related concepts
Related tasks
Reference topic