https://github.com/frimik/puppet-ircnotify

IRC notifications from Puppet
https://github.com/frimik/puppet-ircnotify

Last synced: 3 months ago
JSON representation

IRC notifications from Puppet

• Host: GitHub
• URL: https://github.com/frimik/puppet-ircnotify
• Owner: frimik
• Created: 2012-02-13T21:52:33.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2012-02-13T23:05:06.000Z (over 13 years ago)
• Last Synced: 2025-01-20T07:13:16.389Z (5 months ago)
• Language: Puppet
• Homepage:
• Size: 89.8 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README

Awesome Lists containing this project

README

        
Perform IRC notifications via a simple irc bot.

== Parameters

[*channel*]

Default IRC channel to send notifications

[*host*]

Default host where irc bot is listening.

[*port*]

Default port where irc bot is listening.

== Exposed variables

This module exposes the variable [*enabled*]. See Examples for usage.

== Examples

  To enable the irc notifications to be used by other module include the

  following in your base manifests or module of choice:

  class {'ircnotify':

    channel => '#puppet',

    host    => 'ircbot.example.com',

    port    => 5050

  }

 In your module/manifest of choice you can do the following:

 if $::ircnotify::enabled {

   ircnotify::privmsg { "foo bar baz":

     channel => "#puppet",

   }

 }

== Authors

Mikael Fridh 

== Copyright

Copyright 2012 Marin Software Inc, unless otherwise noted.

Definition: privmsg

== Parameters

$message - the message string

$channel - the channel string

[*message*]

  You can skip the message parameter if you like, in which case the message

  is taken from the namevar by default.

[*channel*]

  This parameter sets the channel for which the message is intended.

== Examples

  ircnotify::privmsg {

    "foo":

      channel => "#bar",

  }

This sends the message "foo" to the channel #bar, relying on the namevar.

  ircnotify::privmsg { "foo-bar-notification":

    message => "foo",

    channel => "#bar",

  }

This sends the same message, "foo" to the #bar channel, but sets an explicit

resource title and by using the message parameter.