Create or update a queue manager connection
Purpose
Creates or updates a queue manager connection. A queue manager connection specifies the connection details for one queue manager.URI
Use the Eclipse Amlen REST API POST method with the following Eclipse Amlen configuration URI:
http://<admin-endpoint-IP:Port>/ima/v1/configuration/
Object configuration data
Provide QueueManagerConnection object configuration data in the payload of the POST method by using the following schema. Content-type is set to application/json:
{
"QueueManagerConnection": {
"<NameOfQueueManagerConnection>": {
"QueueManagerName": "string",
"ConnectionName": "string",
"ChannelName": "string",
"SSLCipherSpec": "string",
"ChannelUserName": "string",
"ChannelUserPassword": "string",
"MQSSLKey": "string",
"MQStashPassword": "string",
"Verify": true|false,
"Force": true|false,
"Overwrite": true|false
}
}
}
Where:- NameOfQueueManagerConnection
- Required.
- QueueManagerName
- Required if you are creating a queue manager connection.
- ConnectionName
- Required if you are creating a queue manager connection.
- ChannelName
- Required if you are creating a queue manager connection.
- SSLCipherSpec
- Optional.
- ChannelUserName
- Optional.
- ChannelUserPassword
- Optional.
- MQSSLKey
- Specifies the name of the key database file.
- MQStashPassword
- Specifies the name of the password stash file.
- Verify: true|false
- Specifies whether the queue manager connection is tested with the configuration change without committing the configuration change.
- Force: true|false
- Specifies a forced delete or update of the Queue Manager Connection. This action might cause XA transaction IDs to be orphaned.
- Overwrite: true|false
- Specifies whether an existing certificate and key are overwritten if they have the same name.
Usage Notes®
- You must copy the key database file and stash password file to the server before you can apply them to Eclipse Amlen. Copy a file from the local machine to Eclipse Amlen to copy the key database file and stash password file.
- You can copy only one key database file and one stash password file. If you want to use another file, you must overwrite the existing file.
- You can edit a queue manager connection only if all the destination mapping rules that are using the queue manager connection are disabled. You can disable a destination mapping rule by using the REST API POST method described in Create or update a destination mapping rule.
- Ensure that capitalization and double quotation marks are used as shown.
Related REST Administration APIs
Example
Creates a queue manager connection called "MyQMC" by using cURL:
curl -X POST \
-H 'Content-Type: application/json' \
-d '{
"QueueManagerConnection": {
"MyQMC": {
"QueueManagerName": "QM1",
"ConnectionName": "192.0.2.0(1415)",
"ChannelName": "SYSTEM.IMA.SVRCONN",
"MQSSLKey": "my.kdb",
"MQStashPassword": "mq.sth"
}
}
}
' \
http://127.0.0.1:9089/ima/v1/configuration/
An example response to the POST method:
{
"Version": "v1",
"Code": "CWLNA6011",
"Message": "The requested configuration change has completed successfully."
}