IBM MQ
Schemes: ibmmq://, ibm-mq://
Query parameters recognised as config fields for this connector. The object-typed tls is set with a JSON literal, e.g. ?tls={...}. Unrecognised parameters are not forwarded as driver options, so any other ?key=value pair is rejected rather than silently ignored.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
channel | string | yes | — | Required. Server Connection (SVRCONN) Channel name defined on the QM. |
disable_status_inq | boolean | no | false | If false, attempt to open the queue with INQUIRE permissions to fetch queue depth for status checks. Defaults to false. |
internal_buffer_size | integer | no | null | Internal buffer size for the channel. Defaults to 100. |
max_message_size | integer | no | 4194304 | Maximum message size in bytes (default: 4MB). Optional. |
password | string | no | — | Password for authentication. Optional; required if the channel enforces authentication. |
queue | string | no | — | Target Queue name for point-to-point messaging. Optional if topic is set; defaults to route name if omitted. |
queue_manager | string | yes | — | Required. Name of the Queue Manager to connect to (e.g., QM1). |
tls | object | no | see below | TLS configuration settings (e.g., keystore paths). Optional. |
topic | string | no | — | Target Topic string for Publish/Subscribe. If set, enables Subscriber mode (Consumer) or publishes to a topic (Publisher). Optional if queue is set. |
url | string | yes | — | Required. Connection URL in host(port) format. Supports comma-separated list for failover (e.g., host1(1414),host2(1414)). If it contains userinfo, it will be treated as a secret. |
username | string | no | — | Username for authentication. Optional; required if the channel enforces authentication |
wait_timeout_ms | integer | no | 1000 | (Consumer only) Polling timeout in milliseconds (default: 1000ms). Optional. |
Struct-typed fields
tls
TLS configuration for the IBM MQ native client.
The IBM MQ client doesn’t consume PEM files, so this uses MQ-native field
names rather than the generic [TlsConfig] used by the other endpoints.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
accept_invalid_certs | boolean | no | false | If true, disable server certificate verification (insecure). |
cert_file | string | no | — | For IBM MQ this is the CMS key repository stem (e.g. /path/to/tls for tls.kdb/tls.sth), not a PEM file. Exposed as cert_file for config parity with the generic TlsConfig; the MQ-native name key_repository is still accepted. |
cert_password | string | no | — | Password unlocking the key repository. Requires an IBM MQ client/server at 9.3.0.0+. Exposed as cert_password for parity with TlsConfig; alias key_repository_password. |
cipher_spec | string | no | — | TLS CipherSpec (e.g., ANY_TLS12). Required for encrypted connections. IBM MQ-specific. |
key_repository | string | no | — | MQ-native alias for cert_file: the CMS key repository stem (e.g. /path/to/tls for tls.kdb/tls.sth). |
key_repository_password | string | no | — | MQ-native alias for cert_password: password unlocking the key repository. Requires an IBM MQ client/server at 9.3.0.0+. |
required | boolean | no | false | If true, enable TLS/SSL. |