Forge Home

winsnmp

Manages SNMP configuration under Windows.

10,981 downloads

10,821 latest version

4.3 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

  • 1.0.1 (latest)
  • 1.0.0
released Dec 22nd 2014
This version is compatible with:

Start using this module

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

Add this module to your Puppetfile:

mod 'sanoma-winsnmp', '1.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add sanoma-winsnmp
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install sanoma-winsnmp --version 1.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.

Download
Tags: snmp, windows

Documentation

sanoma/winsnmp — version 1.0.1 Dec 22nd 2014

#winsnmp

####Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with winsnmp
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

##Overview

Manages SNMP configuration under Windows.

##Module Description

This module installs the SNMP service and manages its configuration. This includes setting community strings and the standard RFC1156 objects.

##Setup

###What winsnmp affects

  • The SNMP feature and the corresponding service.
  • Registry keys managing configuration of the above.

###Setup Requirements

The following third party modules must be installed:

  • puppetlabs/dism
  • puppetlabs/registry
  • puppetlabs/stdlib

###Beginning with winsnmp

To use the module with its defaults, simply include the winsnmp class.

include winsnmp

##Usage

A more advanced configuration, with community strings and standard RFC1156 objects looks something like the below.

class { 'winsnmp':
  communities => ['public','private'],
  contact     => 'admin@example.com',
  location    => 'Data Center 1',
  services    => 72,
}

##Reference

###Class winsnmp

Installs and configures SNMP.

####Parameters

#####communities Array of valid SNMP Community strings. Defaults to none.

#####contact The value of the RFC1156 sysContact object. Defaults to none.

#####location The value of the RFC1156 sysLocation object. Defaults to none.

#####services The value of the RFC1156 sysServices object. Defaults to 76, which is also the default as installed by the Windows feature.

###Define winsnmp::community

Manages a single SNMP community string. This is usually done via the main winsnmp class.

####Parameters

#####community The SNMP community string. Defaults to the resource title.

###Define winsnmp::object

Manages a single RFC1156 object. The standard objects sysContact, sysLocation and sysServices may be managed via the main winsnmp class.

####Parameters

#####object The name of the object. Defaults to resource title.

#####type The data type of the object. This value is passed as the type parameter of a registry_value resource. The default is string. See documentation at http://forge.puppetlabs.com/puppetlabs/registry for details.

#####value The value the object should contain (required).

##Limitations

This module has been tested on Windows 2008 R2, but may well work on other version.

##Development

For fixes, improvements, etc, please see our project page: https://github.com/sanoma-technology/puppet-winsnmp

##Release Notes/Contributors/Etc

This space intentionally left blank.