Settings API - IBM MQ queue managers schema table

IBM MQ queue managers (`builtin:ibmmq.queue-managers`)

Dynatrace needs to know the IBM MQ definition of your alias queues, remote queues, and cluster queues for the end-to-end tracing. Without this information, Dynatrace can still trace all requests but producer and consumer services would not be stitched together.

Schema ID	Schema groups	Scope
`builtin:ibmmq.queue-managers`	`group:mainframe`	`environment`

Retrieve schema via Settings API

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:ibmmq.queue-managers`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:ibmmq.queue-managers`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:ibmmq.queue-managers`

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Property	Label	Type	Description	Required
name	Queue manager name	text	-	required
clusters	Clusters	set	Name of the cluster(s) this queue manager is part of	required
aliasQueues	Alias queues	set	-	required
remoteQueues	Remote queues	set	-	required
clusterQueues	Cluster queues	set	-	required

Request body objects

The `AliasQueue` object

Property	Label	Type	Description	Required
aliasQueue	Alias queue name	text	-	required
baseQueue	Base queue name	text	-	required
clusterVisibility	Cluster visibility	set	Name of the cluster(s) this alias should be visible in	required

The `RemoteQueue` object

Property	Label	Type	Description	Required
localQueue	Local queue name	text	-	required
remoteQueue	Remote queue name	text	-	required
remoteQueueManager	Remote queue manager name	text	-	required
clusterVisibility	Cluster visibility	set	Name of the cluster(s) this local definition of the remote queue should be visible in	required

The `LocalQueue` object

Property	Label	Type	Description	Required
localQueue	Local queue	text	Local queue	required

The `ClusterQueue` object

Property	Label	Type	Description	Required
localQueue	Local queue name	text	-	required
clusterVisibility	Cluster visibilities	set	Name of the cluster(s) this local queue should be visible in	required

Settings API - IBM MQ queue managers schema table

IBM MQ queue managers (builtin:ibmmq.queue-managers)

Authentication

Parameters

Request body objects

The AliasQueue object

The RemoteQueue object

The LocalQueue object

The ClusterQueue object

IBM MQ queue managers (`builtin:ibmmq.queue-managers`)

The `AliasQueue` object

The `RemoteQueue` object

The `LocalQueue` object

The `ClusterQueue` object