QUEUE_MANAGER.md

queue_manager.py

Module to create, start, delete a queue manager and run MQSC files.

Parameters

• qmname : IBM MQ queue manager name.
• state : Desired state of the queue manager (present, absent, running).
• description : IBM MQ queue manager description - optional.
• unit_test: flag used for unit tests of modules.
• mqsc_file : Specified MQSC command file to run - optional.

Return values

• msg : message of the performed task.
• rc : return code.
• state

Examples for playbooks

Creating a Queue Manager task

- name: Create queue manager
    queue_manager:
      qmname: 'queue_manager_name'
      state: present

Starting a Queue Manager task

- name: Start queue manager
    queue_manager:
      qmname: 'queue_manager_name'
      state: running

Deleting a Queue Manager task

- name: Start queue manager
    queue_manager:
      qmname: 'queue_manager_name'
      state: absent

Run MQSC command file task

- name: Run MQSC command file 
    queue_manager:
      qmname: 'queue_manager_name'
      state: running
      mqsc_file: 'commfile.in'

Use of ALL_QMGRS value

This may be used to refer to all queue managers currently defined to a system, e.g to start/stop both QM1 and QM2 defined in mq-setup.yml.

- name: Run MQSC command file 
    queue_manager:
      qmname: 'ALL_QMGRS'
      state: running

Example of unit testing of a module

Note: Exeption classes AnsibleExitJson and AnsibleFailJson should be set. See test_queue_manager.py for reference.

def test_delete_qm(self):
    set_module_args({
        'qmname': 'qm1',
        'state': 'absent',
        'description': 'testing',
        'unit_test': True
    })
    with self.assertRaises(AnsibleExitJson) as result:
        queue_manager.main()
    self.assertEquals(result.exception.args[0]['state'], 'absent')