Overview

This resource allows you to manage a MQ listener.

Here is an example on how you should use this: mq_listener { ‘IIB10QM/SYSTEM.DEFAULT.LISTENER.TCP’: ensure => ‘present’, backlog => ‘0’, control => ‘MANUAL’, port => ‘0’, trptype => ‘TCP’, }

If you want to play and experiment with this type, please take a look at our playgrounds. At our playgrounds, we provide you with a pre-installed environment, where you experiment with these Puppet types.

Look at our playgrounds here

Attributes

Attribute Name Short Description
adapter The adapter number on which NetBIOS listens.
backlog The number of concurrent connection requests that the listener supports.
commands The number of commands that the listener can use.
control Specifies how the listener is to be started and stopped.
descr Plain-text comment.
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.
ipaddr IP address for the listener specified in IPv4 dotted decimal, IPv6 hexadecimal notation, or alphanumeric host name form.
listener The name of the listener.
loclname The NetBIOS local name that the listener uses.
name The full name of the listener.
ntbnames The number of names that the listener can use.
port The port number for TCP/IP.
provider resource.
qmgr The name of the queue manager containing the specfied queue.
sessions The number of sessions that the listener can use.
socket The SPX socket on which to listen.
status The status of the Listener.
tpname The LU 6.2 transaction program name (maximum length 64 characters).
trptype The transmission protocol to be used.

adapter

The adapter number on which NetBIOS listens. This parameter is valid only on Windows when TRPTYPE is NETBIOS.

Back to overview of mq_listener

backlog

The number of concurrent connection requests that the listener supports.

Back to overview of mq_listener

commands

The number of commands that the listener can use. This parameter is valid only on Windows when TRPTYPE is NETBIOS.

Back to overview of mq_listener

control

Specifies how the listener is to be started and stopped.

Valid values are:

  • MANUAL The listener is not to be started automatically or stopped automatically. It is to be controlled by use of the START LISTENER and STOP LISTENER commands.
  • QMGR The listener being defined is to be started and stopped at the same time as the queue manager is started and stopped.
  • STARTONLY The listener is to be started at the same time as the queue manager is started, but is not requested to stop when the queue manager is stopped.

Valid values are MANUAL, QMGR, STARTONLY.

Back to overview of mq_listener

descr

Plain-text comment. It provides descriptive information about the listener when an operator issues the DISPLAY LISTENER command (see DISPLAY LISTENER ). It should contain only displayable characters. The maximum length is 64 characters. In a DBCS installation, it can contain DBCS characters (subject to a maximum length of 64 bytes).

Note If characters are used that are not in the coded character set identifier (CCSID) for this queue manager, they might be translated incorrectly if the information is sent to another queue manager.

Back to overview of mq_listener

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_listener

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_listener

ensure

The basic property that the resource should be in.

Valid values are present, absent.

Back to overview of mq_listener

ipaddr

IP address for the listener specified in IPv4 dotted decimal, IPv6 hexadecimal notation, or alphanumeric host name form. If you do not specify a value for this parameter, the listener listens on all configured IPv4 and IPv6 stacks.

Back to overview of mq_listener

listener

The name of the listener.

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_listener

loclname

The NetBIOS local name that the listener uses. This parameter is valid only on Windows when TRPTYPE is NETBIOS

Back to overview of mq_listener

name

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

QMGR1/SYSTEM.DEFAULT.LISTENER.TCP

Back to overview of mq_listener

ntbnames

The number of names that the listener can use. This parameter is valid only on Windows when TRPTYPE is NETBIOS.

Back to overview of mq_listener

port

The port number for TCP/IP. This is valid only when TRPTYPE is TCP. It must not exceed 65535.

Back to overview of mq_listener

provider

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

simple
Manage MQ listners

Back to overview of mq_listener

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_listener

sessions

The number of sessions that the listener can use. This parameter is valid only on Windows when TRPTYPE is NETBIOS.

Back to overview of mq_listener

socket

The SPX socket on which to listen. This is valid only if TRPTYPE is SPX.

Back to overview of mq_listener

status

The status of the Listener.

Here is an example on how to use this:

mq_listener { 'IIB10QM/SYSTEM.DEFAULT.LISTENER.TCP':
  ensure  => 'present',
  ...
  status  => 'running',
  ...
}

This will define the listener and directly start it.

Valid values are stopped, running.

Back to overview of mq_listener

tpname

The LU 6.2 transaction program name (maximum length 64 characters). This parameter is valid only on Windows when TRPTYPE is LU62.

Back to overview of mq_listener

trptype

The transmission protocol to be used. Valid values are:

  • LU62 SNA LU 6.2. This is valid only on Windows.
  • NETBIOS NetBIOS. This is valid only on Windows.
  • SPX Sequenced packet exchange. This is valid only on Windows.
  • TCP TCP/IP.

Valid values are LU62, NETBIOS, SPX, TCP.

Back to overview of mq_listener