Forge Home

echo

pdk
Prints messages to Puppet report without logging a change

ipcrm

ipcrm

111,030 downloads

27,373 latest version

5.0 quality score

Version information

  • 0.1.7 (latest)
  • 0.1.6
  • 0.1.5
  • 0.1.4
  • 0.1.3
  • 0.1.1 (deleted)
  • 0.1.0 (deleted)
released Nov 6th 2020
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 3.0.0 < 7.0.0
  • RedHat
    ,
    CentOS
    ,
    OracleLinux
    ,
    Scientific
    ,
    Debian
    ,
    SLES
    ,
    Ubuntu
    ,
    Windows

Start using this module

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

Add this module to your Puppetfile:

mod 'ipcrm-echo', '0.1.7'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add ipcrm-echo
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install ipcrm-echo --version 0.1.7

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.

Download

Documentation

ipcrm/echo — version 0.1.7 Nov 6th 2020

Build Status

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Usage - Configuration options and additional functionality
  4. Known Issues

Overview

The purpose of the module is really to add the echo type. This type allows you to print a message to your report WITHOUT logging a change.

Module Description

You would use this module to print messages to your reports that will only issue a notice and does not get flagged as a change.

Usage

Usage is super basic and follows that of the notify type. You can use echo with the message parameter and it will print the value of message, or if omitted it will just print the title.

echo {'TestMessage':
  message => 'Test message'
}

The expected output looks like this:

Notice: /Echo[TestMessage]/message: Test message

You can optionally provide the withpath parameter to control whether or not the resource path is displayed:

echo {'TestMessageNoPath':
  message  => 'Test message',
  withpath => false
}

The expected output looks like this:

Notice: Test message

Optionally; you can control the loglevel facility the message is printed with:

echo {'TestMessageNoPath':
  message  => 'Test message',
  loglevel => 'err',
}

The expected output looks like this:

Error: /Echo[TestMessage]/message: Test message

You als might want to show the message only during a puppet schedule. This in coordination with a resource change you have put on this schedule.

schedule { 'maintenance':
  range  => '2 - 4',
  period => daily,
  repeat => 1,
}

echo {'This will only show in the maintenace window':
  message  => 'Test message',
  schdule  => 'maintenance',
}