Overview

This resource allows you to manage a MQ topic.

Here is an example on how you should use this:

mq_subscription { 'QUEUENAME/SUBNAME':
  ensure   => 'present',
  topicstr => 'b_topic',
  dest     => 'QUEUENAME',
}

mq_subscription {'QM1/SUB1':
  ensure   => 'present',
  dest     => 'SYSTEM.DEFAULT.REMOTE.QUEUE',
  topicstr => 'SYSTEM.DEFAULT.TOPIC'
}

Experience the Power of Puppet for IBM MQ

If you want to play and experiment with Puppet and IBM MQ, please take a look at our playgrounds. At our playgrounds, we provide you with a pre-installed environment, where you experiment fast and easy.

Attributes

Attribute Name Short Description
dest this parameter is the name of a queue.
destqmgr this parameter is the name of a queue.
disable_corrective_change Disable the modification of a resource when Puppet decides it is a corrective change.
disable_corrective_ensure Disable the creation or removal of a resource when Puppet decides is a corrective change.
ensure The basic property that the resource should be in.
expiry The time to expiry of the subscription object from the creation date and time.
name The full name of the subscription.
provider resource.
psprop The manner in which publish subscribe related message properties are added to messages sent to this subscription.
pubacct published to this subscription in the AccountingToken field of the MQMD.
pubappid to this subscription in the ApplIdentityData field of the MQMD.
pubprty The priority of the message sent to this subscription.
qmgr The name of the queue manager containing the specfied queue.
replace The definition replaces any existing definition of the same name.
reqonly or whether all publications are delivered to this subscription.
selector A selector that is applied to messages published to the topic.
subscope so that the subscriber receives messages published at those other queue managers.
subscription The name of the subscription.
subuser the subscription.
topicobj The name of a topic object used by this subscription.
topicstr The topic is fully specified as the TOPICSTR attribute.
varuser and take over ownership of the subscription.
wschema The schema to be used when interpreting any wildcard characters in the topic string.

dest

The destination for messages published to this subscription; this parameter is the name of a queue.

Back to overview of mq_subscription

destqmgr

The destination for messages published to this subscription; this parameter is the name of a queue.

Back to overview of mq_subscription

disable_corrective_change

Disable the modification of a resource when Puppet decides it is a corrective change.

(requires easy_type V2.11.0 or higher)

When using a Puppet Server, Puppet knows about adaptive and corrective changes. A corrective change is when Puppet notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet is managing. The normal Puppet process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.

Using the disable_corrective_change parameter, you can disable corrective changes on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ...
  disable_corrective_change => true,
  ...
}

When a corrective ensure does happen on the resource Puppet will not modify the resource and signal an error:

    Error: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/parameter: change from '10' to '20' failed: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change. (corrective)

Back to overview of mq_subscription

disable_corrective_ensure

Disable the creation or removal of a resource when Puppet decides is a corrective change.

(requires easy_type V2.11.0 or higher)

When using a Puppet Server, Puppet knows about adaptive and corrective changes. A corrective change is when Puppet notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet is managing. The normal Puppet process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.

Using the disable_corrective_ensure parameter, you can disable corrective ensure present or ensure absent actions on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ensure                    => 'present',
  ...
  disable_corrective_ensure => true,
  ...
}

When a corrective ensure does happen on the resource Puppet will not create or remove the resource and signal an error:

    Error: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure.
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/ensure: change from 'absent' to 'present' failed: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure. (corrective)

Back to overview of mq_subscription

ensure

The basic property that the resource should be in.

Valid values are present, absent.

Back to overview of mq_subscription

expiry

The time to expiry of the subscription object from the creation date and time.

Back to overview of mq_subscription

name

The full name of the subscription. A subscription’s full name constists of the name of the Queue manager a slash and then the name of the subscription. Here is an example:

QMGR1/SUBNAME

This is a puppet parameter and not a managed property. Therefor it is only used during creation of the resource. Changes to this parameter in your manifest, do NOT result in modifications on the system.

Back to overview of mq_subscription

provider

The specific backend to use for this mq_subscription resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.Available providers are:

simple
Manage MQ Subscription

Back to overview of mq_subscription

psprop

The manner in which publish subscribe related message properties are added to messages sent to this subscription.

This is a puppet parameter and not a managed property. Therefor it is only used during creation of the resource. Changes to this parameter in your manifest, do NOT result in modifications on the system.

Back to overview of mq_subscription

pubacct

Accounting token passed by the subscriber, for propagation into messages published to this subscription in the AccountingToken field of the MQMD.

Back to overview of mq_subscription

pubappid

Identity data passed by the subscriber, for propagation into messages published to this subscription in the ApplIdentityData field of the MQMD.

Back to overview of mq_subscription

pubprty

The priority of the message sent to this subscription.

This is a puppet parameter and not a managed property. Therefor it is only used during creation of the resource. Changes to this parameter in your manifest, do NOT result in modifications on the system.

Back to overview of mq_subscription

qmgr

The name of the queue manager containing the specfied queue.

This is a puppet parameter and not a managed property. Therefor it is only used during creation of the resource. Changes to this parameter in your manifest, do NOT result in modifications on the system.

Back to overview of mq_subscription

replace

The definition replaces any existing definition of the same name. If a definition does not exist, one is created. You cannot change TOPICOBJ, TOPICSTR, WSCHEMA, SELECTOR, SUBSCOPE, or DESTCLAS with DEFINE REPLACE.

This is a puppet parameter and not a managed property. Therefor it is only used during creation of the resource. Changes to this parameter in your manifest, do NOT result in modifications on the system.

Back to overview of mq_subscription

reqonly

Indicates whether the subscriber polls for updates using the MQSUBRQ API call, or whether all publications are delivered to this subscription.

This is a puppet parameter and not a managed property. Therefor it is only used during creation of the resource. Changes to this parameter in your manifest, do NOT result in modifications on the system.

Back to overview of mq_subscription

selector

A selector that is applied to messages published to the topic.

This is a puppet parameter and not a managed property. Therefor it is only used during creation of the resource. Changes to this parameter in your manifest, do NOT result in modifications on the system.

Back to overview of mq_subscription

subscope

Determines whether this subscription is forwarded to other queue managers, so that the subscriber receives messages published at those other queue managers.

This is a puppet parameter and not a managed property. Therefor it is only used during creation of the resource. Changes to this parameter in your manifest, do NOT result in modifications on the system.

Back to overview of mq_subscription

subscription

The name of the subscription.

This is a puppet parameter and not a managed property. Therefor it is only used during creation of the resource. Changes to this parameter in your manifest, do NOT result in modifications on the system.

Back to overview of mq_subscription

subuser

Specifies the user ID that is used for security checks that are performed to ensure that publications can be put to the destination queue associated with the subscription. This ID is either the user ID associated with the creator of the subscription or, if subscription takeover is permitted, the user ID that last took over the subscription. The length of this parameter must not exceed 12 characters.

Back to overview of mq_subscription

topicobj

The name of a topic object used by this subscription.

This is a puppet parameter and not a managed property. Therefor it is only used during creation of the resource. Changes to this parameter in your manifest, do NOT result in modifications on the system.

Back to overview of mq_subscription

topicstr

The topic is fully specified as the TOPICSTR attribute.

Back to overview of mq_subscription

varuser

Specifies whether a user other than the subscription creator can connect to and take over ownership of the subscription.

This is a puppet parameter and not a managed property. Therefor it is only used during creation of the resource. Changes to this parameter in your manifest, do NOT result in modifications on the system.

Back to overview of mq_subscription

wschema

The schema to be used when interpreting any wildcard characters in the topic string.

This is a puppet parameter and not a managed property. Therefor it is only used during creation of the resource. Changes to this parameter in your manifest, do NOT result in modifications on the system.

Back to overview of mq_subscription