Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voxpupuli/puppet-nsclient
Module that will install the NSClient on Windows
https://github.com/voxpupuli/puppet-nsclient
hacktoberfest puppet windows-puppet-module
Last synced: 4 days ago
JSON representation
Module that will install the NSClient on Windows
- Host: GitHub
- URL: https://github.com/voxpupuli/puppet-nsclient
- Owner: voxpupuli
- License: mit
- Created: 2014-02-20T11:39:34.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T07:31:59.000Z (4 months ago)
- Last Synced: 2024-10-29T14:22:39.959Z (2 months ago)
- Topics: hacktoberfest, puppet, windows-puppet-module
- Language: Ruby
- Homepage: https://forge.puppet.com/puppet/nsclient
- Size: 266 KB
- Stars: 8
- Watchers: 47
- Forks: 26
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# puppet-nsclient
####Table of Contents
1. [Overview](#overview)
2. [Module Description - What the module does and why it is useful](#module-description)
3. [Setup - The basics of getting started with nsclient](#setup)
* [What nsclient affects](#what-nsclient-affects)
* [Setup requirements](#setup-requirements)
* [Beginning with nsclient](#beginning-with-nsclient)
4. [Usage - Configuration options and additional functionality](#usage)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
##Overview
This is a module that will manage and install the NSClient on Windows servers from the official NSClient site.
[](https://travis-ci.org/puppet-community/puppet-nsclient)
##Module Description
Module that will install the NSClient on windows servers to be able to interact with Nagios and Icinga.
It will also manage the list of hosts that the server can communicate with.
##Setup
###What nsclient affects
* Installs a new package
* Creates a new windows service
###Beginning with nsclient
Usage
--
To install nsclient with defaults:
```puppet
include 'nsclient'
```
To install a different version:
```puppet
class { 'nsclient':
package_source_location => 'http://myhost.com',
package_name => 'NSClient++ (Win32)'
package_source => '0.3.1.msi'
}
```
In order to configure the nagios hosts to communicate with:
```puppet
class { 'nsclient':
allowed_hosts => ['10.21.0.0/22','10.21.4.0/22'],
}
```
in order to use proxy for downloading the package
```puppet
class { 'nsclient':
proxy_url => 'http://proxy.domain.local:8080',
}
```
##Usage
###Classes and Defined Types
####Class: `nsclient`
One of the primary classes of the nsclient module. This class will install the nsclient binaries
**Parameters within `nsclient`:**
#####`allowed_hosts`
Array of hosts that your client can communicate with. You can use netmasks (/ syntax) or * to create ranges.
#####`service_state`
Whether you want to nsclient service to start up. Defaults to running
#####`service_enable`
Whether you want to nsclient service to start up at boot. Defaults to true
#####`package_source_location`
This is the default site to download your package from (e.g. http://files.nsclient.org/stable)
#####`package_source`
This is the source name of the package to be downloaded
#####`package_name`
This is name of the package to download (e.g. NSCP-0.4.1.101-x64.msi)
#####`download_destination`
This is the folder to where we need to download the NSCP Installer. Package cannot take a remote file source
Because of Windows, we need to set this to be a top level directory (e.g. c:\\temp) or we would need to
recursively check the file path.
#####`config_template`
This is the template to use as the config file.
#####`proxy_url`
Specify a proxy url if needed for downloading the package
#####`password`
Password used to authenticate against server
##Reference
###Classes
####Public Classes
* [`nsclient`](#class-nsclient): Guides the basic installation of the nsclient application
####Private Classes
* [`nsclient::config`] Manages all the default configuration of the nsclient application
* [`nsclient::install`] Manages the installation of the nsclient
* [`nsclient::service`] Manages the nclient service
##Limitations
This module is tested on the following platforms:
* Windows 2008 R2
It is tested with the OSS version of Puppet only.
##Development
###Contributing
Please read CONTRIBUTING.md for full details on contributing to this project.