Forge Home


Manages IBM Installation Manager and IBM packages


3,335 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 3.0.1 (latest)
  • 3.0.0
  • 2.2.1
  • 2.2.0
  • 2.1.0
  • 2.0.0
  • 1.0.0
  • 0.6.0
  • 0.5.0
  • 0.4.0
  • 0.3.0
  • 0.2.5
  • 0.2.4
  • 0.2.3
  • 0.2.2
  • 0.2.1
  • 0.2.0
released Apr 12th 2021
This version is compatible with:
  • Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
  • Puppet >= 6.0.0 < 8.0.0
  • , , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppetlabs-ibm_installation_manager', '3.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-ibm_installation_manager
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-ibm_installation_manager --version 3.0.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Tags: ibm, websphere, was, imcl, iim


puppetlabs/ibm_installation_manager — version 3.0.1 Apr 12th 2021


Build Status

Table of Contents

  1. Module Description
  2. Setup - The basics of getting started with ibm_installation_manager
  3. Usage - Configuration options and additional functionality
  4. Reference - Classes and Parameters
  5. Limitations - OS compatibility, etc.
  6. Dependencies
  7. Development and Contributing
  8. Authors

Module Description

This module installs the IBM Installation Manager. Optionally, it can deploy the installation from a source such as HTTP or a local file path.

This module can also manage the installation of software from IBM packages (for example, WebSphere, IHS).


Installing Installation Manager

To install Installation Manager from an HTTP repository source archive:

class { 'ibm_installation_manager':
  deploy_source => true,
  source        => 'http://internal.lan/packages/',

If you've already extracted the archive, install Installation Manager from the existing path:

class { 'ibm_installation_manager':
  source_dir => '/path/to/installation/IM'

To install Installation Manager to a custom location, specify the target location:

class { 'ibm_installation_manager':
  source => 'http://internal.lan/packages/',
  target => '/opt/myorg/IBM',

To install the Installation Manager as a non-root user, specify that user's name and its home directory, and set the installation_mode to 'nonadministrator'

class { 'ibm_installation_manager':
  deploy_source     => true,
  source            => 'http://internal.lan/packages/',
  user              => 'iim_user',
  user_home         => '/home/iim_user',
  installation_mode => 'nonadministrator',

Installing software packages

To install software with IBM Installation Manager, use the ibm_pkg type. This type includes the imcl provider, which uses the Installation Manager's imcl command-line tool to handle installation.

This provider installs the specified version or greater is installed. This is partly due to the nature of how IBM software is deployed (by a downloaded/extracted archive).

To install a package from an extracted source:

ibm_pkg { '':
  ensure     => 'present',
  package    => '',
  version    => '8.5.5000.20130514_1044',
  target     => '/opt/IBM/WebSphere85',
  repository => '/vagrant/ibm/websphere/repository.config',

The above code installs a WebSphere 8.5 package from an extracted source at /vagrant/ibm/websphere/ to /opt/IBM/WebSphere85

You can also provide the package source and other parameters in a custom response file:

ibm_pkg { '':
  ensure   => 'present',
  response => '/mnt/resources/was_response_file.xml',




This module has only been tested with IBM Installation Manager 1.8.7.

For an extensive list of supported operating systems, see metadata.json

Known Issues

The installer exits 0 even if it failed.

ERROR: java.lang.IllegalStateException: No metadata found for installed package 1.6.2000.20130301_2248.


Development and Contributing

Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our module contribution guide.


This module was contributed to by Josh Beard and other contributors.