IBM WebSphere MQ Plugin Reference 10.0.x
The XL Deploy IBM WebSphere MQ (WMQ) plugin adds the capability to manage MQ resources on WebSphere MQ environment.
This document provides information that is specific to this version of the WMQ plugin. For general information about the plugin, refer to Introduction to the XL Deploy WebSphere MQ plugin.
Requirements
- XL Deploy 5.1.0 or later
- IBM WebSphere MQ 7.x
- User credentials for accessing the host running WebSphere MQ (must have rights to run WMQ commands)
Using the deployables and deployeds
Deployable vs. container table
The following table describes which deployable/container combinations are possible.
| Deployable | Container | Generated deployed |
|---|---|---|
| wmq.LocalQueueSpec | wmq.QueueManager | wmq.LocalQueue |
| wmq.AliasQueueSpec | wmq.QueueManager | wmq.AliasQueue |
Deployed actions table
The following table describes the effect a deployed has on its container.
| Deployed | Actions performed for operations | ||
|---|---|---|---|
| Create | Destroy | Modify | |
| wmq.LocalQueue |
|
|
|
| wmq.AliasQueue |
|
|
|
Release notes
Version 9.8.0
Bug fixes
- [ENG-1619] - Fixed syntax error while creating alias queue with DEFBIND
Version 9.7.5
Bug fixes
ENG-1619: Syntax error with the wmq plugin when creating alias queue with DEFBIND
Version 6.0.1
XL Deploy 6.0.0 compatibility.
Version 6.0.0
XL Deploy 6.0.0 compatibility.
Version 5.0.0
XL Deploy 5.0.0 compatibility.
Version 4.0.0
XL Deploy 4.0.0 compatibility.
Version 3.8.0
Updated to use plugin-api-3.8.0
Version 3.7.0
Upgraded to version 3.7.0 of the plugin-api
CI Reference
Configuration Item Overview
Deployables
| CI | Description |
|---|---|
| wmq.AliasQueueSpec | Specification of a alias queue |
| wmq.LocalQueueSpec | Specification of a local queue |
| wmq.RemoteQueueSpec | Specification of a alias queue |
Deployeds
| CI | Description |
|---|---|
| wmq.AliasQueue | An alias queue |
| wmq.LocalQueue | A local queue |
| wmq.RemoteQueue | An alias queue |
| wmq.Resource | Description unavailable |
Containers
| CI | Description |
|---|---|
| wmq.QueueManager | A queue manager manages the resources associated with it, in particular the queues that it owns. It provides queuing services to applications for Message Queuing Interface (MQI) calls and commands to create, modify, display, and delete WebSphere MQ objects |
Configuration Item Details
wmq.AliasQueue
| Type Hierarchy | wmq.Resource >> generic.ExecutedScript >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer |
An alias queue
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
defbind: ENUM [NOTFIXED, OPEN, GROUP] = NOTFIXED
|
|
Load balancing between 2 queues in a Cluster (DEFBIND)
|
||
|
|
|
target: STRING
|
|
The name of the queue or topic object being aliased. The object can be a queue or a topic as defined by TARGTYPE. The maximum length is 48 characters.
|
||
|
|
|
cluster: STRING
|
|
The name of the cluster to which the queue belongs
|
||
|
|
|
defpsist: ENUM [YES, NO] = NO
|
|
Default message persistence
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
descr: STRING
|
|
Queue description
|
||
|
|
|
targtype: ENUM [QUEUE, TOPIC] = QUEUE
|
|
Target type (QUEUE or TOPIC).
|
| Hidden properties | ||
|---|---|---|
|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
createOrder: INTEGER = 60
|
|
The order of the step in the step list for the create operation.
|
||
|
|
|
createScript: STRING = wmq/create-qalias
|
|
Classpath to the script that is uploaded and executed on the generic container for the create operation.
|
||
|
|
|
createVerb: STRING = Create
|
|
Create Verb
|
||
|
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
destroyOrder: INTEGER = 40
|
|
The order of the step in the step list for the destroy operation.
|
||
|
|
|
destroyScript: STRING = wmq/destroy-qalias
|
|
Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
|
||
|
|
|
destroyVerb: STRING = Destroy
|
|
Destroy Verb
|
||
|
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
modifyOrder: INTEGER = 40
|
|
The order of the step in the step list for the modify operation.
|
||
|
|
|
modifyScript: STRING = wmq/modify-qalias
|
|
Classpath to the script that is uploaded and executed on the generic container for the modify operation.
|
||
|
|
|
modifyVerb: STRING = Modify
|
|
Modify Verb
|
||
|
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
noopOrder: INTEGER = 50
|
|
The order of the step in the step list for the noop operation.
|
||
|
|
|
noopVerb: STRING = Modify
|
|
Noop Verb
|
||
|
|
|
standardPropertiesNotToExpose: STRING = deployable, container, createOrder, createScript, createVerb, modifyOrder, modifyScript, modifyVerb, destroyOrder, destroyScript, destroyVerb, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, inspectScript, inspectVerb, securityPermissions, inheritPermissions, provisioners, ordinal, boundConfigurationItems
|
|
Standard properties that are not exposed to any python wsadmin script.
|
||
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
classpathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
|
inspectClasspathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
|
||
|
|
|
inspectScript: STRING
|
|
Classpath to the script used to inspect the generic container.
|
||
|
|
|
inspectTemplateClasspathResources: SET_OF_STRING
|
|
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
|
noopScript: STRING
|
|
Classpath to the script that is uploaded and executed on the generic container for the noop operation.
|
||
|
|
|
remoteWorkingDirectoryPath: STRING
|
|
Name of working directory on target host. Default is to create a temporary directory which is deleted when connection is closed.
|
||
|
|
|
restartRequired: BOOLEAN
|
|
The generic container requires a restart for the action performed by this deployed.
|
||
|
|
|
restartRequiredForNoop: BOOLEAN
|
|
The generic container requires a restart for the NOOP action performed by this deployed.
|
||
|
|
|
retainRemoteWorkingDirectory: BOOLEAN
|
|
Retain the specified working directory on target host after completion.
|
||
|
|
|
templateClasspathResources: SET_OF_STRING
|
|
Additional template classpath resources that should be uploaded to the working directory before executing the script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
wmq.AliasQueueSpec
| Type Hierarchy | generic.Resource >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployable, udm.Taggable |
Specification of a alias queue
| Public properties | ||
|---|---|---|
|
|
|
cluster: STRING
|
|
The name of the cluster to which the queue belongs (string)
|
||
|
|
|
defbind: STRING
|
|
Load balancing between 2 queues in a Cluster (DEFBIND) (enum) values(NOTFIXED, OPEN, GROUP) default(NOTFIXED)
|
||
|
|
|
defpsist: STRING
|
|
Default message persistence (enum) values(YES, NO) default(NO)
|
||
|
|
|
descr: STRING
|
|
Queue description (string)
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
target: STRING
|
|
The name of the queue or topic object being aliased. The object can be a queue or a topic as defined by TARGTYPE. The maximum length is 48 characters. (string)
|
||
|
|
|
targtype: STRING
|
|
Target type (QUEUE or TOPIC). (enum) values(QUEUE, TOPIC) default(QUEUE)
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|
wmq.LocalQueue
| Type Hierarchy | wmq.Resource >> generic.ExecutedScript >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer |
A local queue
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
boqname: STRING
|
|
The excessive backout requeue name
|
||
|
|
|
bothresh: INTEGER
|
|
The backout threshold
|
||
|
|
|
cluster: STRING
|
|
The name of the cluster to which the queue belongs
|
||
|
|
|
defpsist: ENUM [YES, NO] = NO
|
|
Default message persistence
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
descr: STRING
|
|
Queue description
|
||
|
|
|
maxDepth: INTEGER
|
|
The maximum number of messages allowed on the queue
|
||
|
|
|
maxmsgl: INTEGER
|
|
Maximum message length
|
||
|
|
|
qdepthhi: INTEGER = 40
|
|
The threshold against which the queue depth is compared to generate a Queue Depth High event
|
||
|
|
|
qdepthlo: INTEGER = 20
|
|
The threshold against which the queue depth is compared to generate a Queue Depth Low event
|
||
|
|
|
qdphiev: ENUM [ENABLED, DISABLED] = ENABLED
|
|
Controls whether Queue Depth High events are generated
|
||
|
|
|
qdpmaxev: ENUM [ENABLED, DISABLED] = ENABLED
|
|
Controls whether Queue Full events are generated
|
| Hidden properties | ||
|---|---|---|
|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
createOrder: INTEGER = 60
|
|
The order of the step in the step list for the create operation.
|
||
|
|
|
createScript: STRING = wmq/create-qlocal
|
|
Classpath to the script that is uploaded and executed on the generic container for the create operation.
|
||
|
|
|
createVerb: STRING = Create
|
|
Create Verb
|
||
|
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
destroyOrder: INTEGER = 40
|
|
The order of the step in the step list for the destroy operation.
|
||
|
|
|
destroyScript: STRING = wmq/destroy-qlocal
|
|
Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
|
||
|
|
|
destroyVerb: STRING = Destroy
|
|
Destroy Verb
|
||
|
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
modifyOrder: INTEGER = 40
|
|
The order of the step in the step list for the modify operation.
|
||
|
|
|
modifyScript: STRING = wmq/modify-qlocal
|
|
Classpath to the script that is uploaded and executed on the generic container for the modify operation.
|
||
|
|
|
modifyVerb: STRING = Modify
|
|
Modify Verb
|
||
|
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
noopOrder: INTEGER = 50
|
|
The order of the step in the step list for the noop operation.
|
||
|
|
|
noopVerb: STRING = Modify
|
|
Noop Verb
|
||
|
|
|
standardPropertiesNotToExpose: STRING = deployable, container, createOrder, createScript, createVerb, modifyOrder, modifyScript, modifyVerb, destroyOrder, destroyScript, destroyVerb, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, inspectScript, inspectVerb, securityPermissions, inheritPermissions, provisioners, ordinal, boundConfigurationItems
|
|
Standard properties that are not exposed to any python wsadmin script.
|
||
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
classpathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
|
inspectClasspathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
|
||
|
|
|
inspectScript: STRING
|
|
Classpath to the script used to inspect the generic container.
|
||
|
|
|
inspectTemplateClasspathResources: SET_OF_STRING
|
|
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
|
noopScript: STRING
|
|
Classpath to the script that is uploaded and executed on the generic container for the noop operation.
|
||
|
|
|
remoteWorkingDirectoryPath: STRING
|
|
Name of working directory on target host. Default is to create a temporary directory which is deleted when connection is closed.
|
||
|
|
|
restartRequired: BOOLEAN
|
|
The generic container requires a restart for the action performed by this deployed.
|
||
|
|
|
restartRequiredForNoop: BOOLEAN
|
|
The generic container requires a restart for the NOOP action performed by this deployed.
|
||
|
|
|
retainRemoteWorkingDirectory: BOOLEAN
|
|
Retain the specified working directory on target host after completion.
|
||
|
|
|
templateClasspathResources: SET_OF_STRING
|
|
Additional template classpath resources that should be uploaded to the working directory before executing the script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
wmq.LocalQueueSpec
| Type Hierarchy | generic.Resource >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployable, udm.Taggable |
Specification of a local queue
| Public properties | ||
|---|---|---|
|
|
|
boqname: STRING
|
|
The excessive backout requeue name (string)
|
||
|
|
|
bothresh: STRING
|
|
The backout threshold (integer)
|
||
|
|
|
cluster: STRING
|
|
The name of the cluster to which the queue belongs (string)
|
||
|
|
|
defpsist: STRING
|
|
Default message persistence (enum) values(YES, NO) default(NO)
|
||
|
|
|
descr: STRING
|
|
Queue description (string)
|
||
|
|
|
maxDepth: STRING
|
|
The maximum number of messages allowed on the queue (integer)
|
||
|
|
|
maxmsgl: STRING
|
|
Maximum message length (integer)
|
||
|
|
|
qdepthhi: STRING
|
|
The threshold against which the queue depth is compared to generate a Queue Depth High event (integer) default(40)
|
||
|
|
|
qdepthlo: STRING
|
|
The threshold against which the queue depth is compared to generate a Queue Depth Low event (integer) default(20)
|
||
|
|
|
qdphiev: STRING
|
|
Controls whether Queue Depth High events are generated (enum) values(ENABLED, DISABLED) default(ENABLED)
|
||
|
|
|
qdpmaxev: STRING
|
|
Controls whether Queue Full events are generated (enum) values(ENABLED, DISABLED) default(ENABLED)
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|
wmq.QueueManager
| Type Hierarchy | generic.Container >> generic.BaseGenericContainer >> udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Container, generic.GenericContainer, overthere.HostContainer, udm.Taggable |
A queue manager manages the resources associated with it, in particular the queues that it owns. It provides queuing services to applications for Message Queuing Interface (MQI) calls and commands to create, modify, display, and delete WebSphere MQ objects
| Parent | ||
|---|---|---|
|
|
|
host:
CI<overthere.Host>
|
|
Host upon which the container resides
|
| Public properties | ||
|---|---|---|
|
|
|
executablesDirectory: STRING
|
|
absolute path of the directory containing wmq commands like strmqm,runmqsc etc. e.g. /opt/mqm/bin
|
||
|
|
|
envVars: MAP_STRING_STRING
|
|
Environment variables for container
|
||
|
|
|
stopStartRestartConnection:
CI<overthere.Host>
|
|
If set, the connection settings to use to connect to the target system to execute start, stop, restart etc. operations for the container.
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
| Hidden properties | ||
|---|---|---|
|
|
|
restartOrder: INTEGER = 90
|
|
The order of the restart container step in the step list.
|
||
|
|
|
restartWaitTime: INTEGER
|
|
The time to wait in seconds for a container restart action.
|
||
|
|
|
startOrder: INTEGER = 90
|
|
The order of the start container step in the step list.
|
||
|
|
|
startScript: STRING = wmq/qmgr/start
|
|
The command to start queue manager. Arguments containing spaces are not supported
|
||
|
|
|
startWaitTime: INTEGER
|
|
The time to wait in seconds for a container start action.
|
||
|
|
|
stopOrder: INTEGER = 10
|
|
The order of the stop container step in the step list.
|
||
|
|
|
stopScript: STRING = wmq/qmgr/stop
|
|
The command to stop queue manager. Arguments containing spaces are not supported
|
||
|
|
|
stopWaitTime: INTEGER
|
|
The time to wait in seconds for a container stop action.
|
||
|
|
|
inspectClasspathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
|
||
|
|
|
inspectScript: STRING
|
|
Classpath to the script used to inspect the generic container.
|
||
|
|
|
inspectTemplateClasspathResources: SET_OF_STRING
|
|
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
|
restartClasspathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the restart script.
|
||
|
|
|
restartScript: STRING
|
|
Classpath to the script used to restart the generic container.
|
||
|
|
|
restartTemplateClasspathResources: SET_OF_STRING
|
|
Additional template classpath resources that should be uploaded to the working directory before executing the restart script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
|
startClasspathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the start script.
|
||
|
|
|
startTemplateClasspathResources: SET_OF_STRING
|
|
Additional template classpath resources that should be uploaded to the working directory before executing the start script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
|
stopClasspathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the stop script.
|
||
|
|
|
stopTemplateClasspathResources: SET_OF_STRING
|
|
Additional template classpath resources that should be uploaded to the working directory before executing the stop script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
| Control task | Parameter CI | Attributes | Description |
|---|---|---|---|
| start |
Start queue manager |
||
| stop |
Stop queue manager |
wmq.RemoteQueue
| Type Hierarchy | wmq.Resource >> generic.ExecutedScript >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer |
An alias queue
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
cluster: STRING
|
|
The name of the cluster to which the queue belongs
|
||
|
|
|
defpsist: ENUM [YES, NO] = NO
|
|
Default message persistence
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
descr: STRING
|
|
Queue description
|
||
|
|
|
rname: STRING
|
|
Remote Queue name
|
||
|
|
|
rqmname: STRING
|
|
Remote Queue Manager name
|
||
|
|
|
xmitq: STRING
|
|
Transmission queue name
|
| Hidden properties | ||
|---|---|---|
|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
createOrder: INTEGER = 60
|
|
The order of the step in the step list for the create operation.
|
||
|
|
|
createScript: STRING = wmq/create-qremote
|
|
Classpath to the script that is uploaded and executed on the generic container for the create operation.
|
||
|
|
|
createVerb: STRING = Create
|
|
Create Verb
|
||
|
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
destroyOrder: INTEGER = 40
|
|
The order of the step in the step list for the destroy operation.
|
||
|
|
|
destroyScript: STRING = wmq/destroy-qremote
|
|
Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
|
||
|
|
|
destroyVerb: STRING = Destroy
|
|
Destroy Verb
|
||
|
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
modifyOrder: INTEGER = 40
|
|
The order of the step in the step list for the modify operation.
|
||
|
|
|
modifyScript: STRING = wmq/modify-qremote
|
|
Classpath to the script that is uploaded and executed on the generic container for the modify operation.
|
||
|
|
|
modifyVerb: STRING = Modify
|
|
Modify Verb
|
||
|
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
noopOrder: INTEGER = 50
|
|
The order of the step in the step list for the noop operation.
|
||
|
|
|
noopVerb: STRING = Modify
|
|
Noop Verb
|
||
|
|
|
standardPropertiesNotToExpose: STRING = deployable, container, createOrder, createScript, createVerb, modifyOrder, modifyScript, modifyVerb, destroyOrder, destroyScript, destroyVerb, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, inspectScript, inspectVerb, securityPermissions, inheritPermissions, provisioners, ordinal, boundConfigurationItems
|
|
Standard properties that are not exposed to any python wsadmin script.
|
||
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
classpathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
|
inspectClasspathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
|
||
|
|
|
inspectScript: STRING
|
|
Classpath to the script used to inspect the generic container.
|
||
|
|
|
inspectTemplateClasspathResources: SET_OF_STRING
|
|
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
|
noopScript: STRING
|
|
Classpath to the script that is uploaded and executed on the generic container for the noop operation.
|
||
|
|
|
remoteWorkingDirectoryPath: STRING
|
|
Name of working directory on target host. Default is to create a temporary directory which is deleted when connection is closed.
|
||
|
|
|
restartRequired: BOOLEAN
|
|
The generic container requires a restart for the action performed by this deployed.
|
||
|
|
|
restartRequiredForNoop: BOOLEAN
|
|
The generic container requires a restart for the NOOP action performed by this deployed.
|
||
|
|
|
retainRemoteWorkingDirectory: BOOLEAN
|
|
Retain the specified working directory on target host after completion.
|
||
|
|
|
templateClasspathResources: SET_OF_STRING
|
|
Additional template classpath resources that should be uploaded to the working directory before executing the script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
wmq.RemoteQueueSpec
| Type Hierarchy | generic.Resource >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployable, udm.Taggable |
Specification of a alias queue
| Public properties | ||
|---|---|---|
|
|
|
cluster: STRING
|
|
The name of the cluster to which the queue belongs (string)
|
||
|
|
|
defpsist: STRING
|
|
Default message persistence (enum) values(YES, NO) default(NO)
|
||
|
|
|
descr: STRING
|
|
Queue description (string)
|
||
|
|
|
rname: STRING
|
|
Remote Queue name (string)
|
||
|
|
|
rqmname: STRING
|
|
Remote Queue Manager name (string)
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
xmitq: STRING
|
|
Transmission queue name (string)
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|
wmq.Resource
| Virtual Type | |
|---|---|
| Type Hierarchy | generic.ExecutedScript >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer |
Description unavailable
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
| Hidden properties | ||
|---|---|---|
|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
createOrder: INTEGER = 60
|
|
The order of the step in the step list for the create operation.
|
||
|
|
|
createScript: STRING
|
|
Classpath to the script that is uploaded and executed on the generic container for the create operation.
|
||
|
|
|
createVerb: STRING = Create
|
|
Create Verb
|
||
|
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
destroyOrder: INTEGER = 40
|
|
The order of the step in the step list for the destroy operation.
|
||
|
|
|
destroyVerb: STRING = Destroy
|
|
Destroy Verb
|
||
|
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
modifyOrder: INTEGER = 40
|
|
The order of the step in the step list for the modify operation.
|
||
|
|
|
modifyVerb: STRING = Modify
|
|
Modify Verb
|
||
|
|
|
noopOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|
||
|
|
|
noopOrder: INTEGER = 50
|
|
The order of the step in the step list for the noop operation.
|
||
|
|
|
noopVerb: STRING = Modify
|
|
Noop Verb
|
||
|
|
|
standardPropertiesNotToExpose: STRING = deployable, container, createOrder, createScript, createVerb, modifyOrder, modifyScript, modifyVerb, destroyOrder, destroyScript, destroyVerb, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, inspectScript, inspectVerb, securityPermissions, inheritPermissions, provisioners, ordinal, boundConfigurationItems
|
|
Standard properties that are not exposed to any python wsadmin script.
|
||
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
classpathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
|
destroyScript: STRING
|
|
Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
|
||
|
|
|
inspectClasspathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
|
||
|
|
|
inspectScript: STRING
|
|
Classpath to the script used to inspect the generic container.
|
||
|
|
|
inspectTemplateClasspathResources: SET_OF_STRING
|
|
Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|
||
|
|
|
modifyScript: STRING
|
|
Classpath to the script that is uploaded and executed on the generic container for the modify operation.
|
||
|
|
|
noopScript: STRING
|
|
Classpath to the script that is uploaded and executed on the generic container for the noop operation.
|
||
|
|
|
remoteWorkingDirectoryPath: STRING
|
|
Name of working directory on target host. Default is to create a temporary directory which is deleted when connection is closed.
|
||
|
|
|
restartRequired: BOOLEAN
|
|
The generic container requires a restart for the action performed by this deployed.
|
||
|
|
|
restartRequiredForNoop: BOOLEAN
|
|
The generic container requires a restart for the NOOP action performed by this deployed.
|
||
|
|
|
retainRemoteWorkingDirectory: BOOLEAN
|
|
Retain the specified working directory on target host after completion.
|
||
|
|
|
templateClasspathResources: SET_OF_STRING
|
|
Additional template classpath resources that should be uploaded to the working directory before executing the script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|