{"id":14994556,"url":"https://github.com/voxpupuli/puppet-nsclient","last_synced_at":"2025-12-11T21:32:04.088Z","repository":{"id":14309524,"uuid":"17018379","full_name":"voxpupuli/puppet-nsclient","owner":"voxpupuli","description":"Module that will install the NSClient on Windows","archived":false,"fork":false,"pushed_at":"2024-09-17T07:31:59.000Z","size":272,"stargazers_count":8,"open_issues_count":4,"forks_count":26,"subscribers_count":47,"default_branch":"master","last_synced_at":"2024-10-29T14:22:39.959Z","etag":null,"topics":["hacktoberfest","puppet","windows-puppet-module"],"latest_commit_sha":null,"homepage":"https://forge.puppet.com/puppet/nsclient","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/voxpupuli.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"open_collective":"vox-pupuli","github":"voxpupuli"}},"created_at":"2014-02-20T11:39:34.000Z","updated_at":"2024-09-17T07:32:02.000Z","dependencies_parsed_at":"2023-07-12T14:29:40.135Z","dependency_job_id":"e2835353-5581-41da-8ef9-d5984b0c7caf","html_url":"https://github.com/voxpupuli/puppet-nsclient","commit_stats":{"total_commits":188,"total_committers":26,"mean_commits":7.230769230769231,"dds":0.5691489361702128,"last_synced_commit":"a0cd31ec9805347961ee10092cd472b07d98e1c9"},"previous_names":["opentable/puppet-nsclient"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-nsclient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-nsclient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-nsclient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-nsclient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/voxpupuli","download_url":"https://codeload.github.com/voxpupuli/puppet-nsclient/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244600725,"owners_count":20479307,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","puppet","windows-puppet-module"],"created_at":"2024-09-24T16:03:51.295Z","updated_at":"2025-12-11T21:31:59.050Z","avatar_url":"https://github.com/voxpupuli.png","language":"Ruby","funding_links":["https://opencollective.com/vox-pupuli","https://github.com/sponsors/voxpupuli"],"categories":[],"sub_categories":[],"readme":"# puppet-nsclient\n\n####Table of Contents\n\n1. [Overview](#overview)\n2. [Module Description - What the module does and why it is useful](#module-description)\n3. [Setup - The basics of getting started with nsclient](#setup)\n    * [What nsclient affects](#what-nsclient-affects)\n    * [Setup requirements](#setup-requirements)\n    * [Beginning with nsclient](#beginning-with-nsclient)\n4. [Usage - Configuration options and additional functionality](#usage)\n5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)\n5. [Limitations - OS compatibility, etc.](#limitations)\n6. [Development - Guide for contributing to the module](#development)\n\n##Overview\n\nThis is a module that will manage and install the NSClient on Windows servers from the official NSClient site.\n\n[![Build Status](https://travis-ci.org/puppet-community/puppet-nsclient.png?branch=master)](https://travis-ci.org/puppet-community/puppet-nsclient)\n\n\n##Module Description\nModule that will install the NSClient on windows servers to be able to interact with Nagios and Icinga.\nIt will also manage the list of hosts that the server can communicate with.\n\n##Setup\n\n###What nsclient affects\n\n* Installs a new package\n* Creates a new windows service\n\n###Beginning with nsclient\n\nUsage\n--\nTo install nsclient with defaults:\n\n```puppet\ninclude 'nsclient'\n```\n\nTo install a different version:\n\n```puppet\nclass { 'nsclient':\n  package_source_location =\u003e 'http://myhost.com',\n  package_name            =\u003e 'NSClient++ (Win32)'\n  package_source          =\u003e '0.3.1.msi'\n}\n```\n\nIn order to configure the nagios hosts to communicate with:\n\n```puppet\nclass { 'nsclient':\n  allowed_hosts =\u003e ['10.21.0.0/22','10.21.4.0/22'],\n}\n```\n\nin order to use proxy for downloading the package\n```puppet\nclass { 'nsclient':\n  proxy_url =\u003e 'http://proxy.domain.local:8080',\n}\n```\n\n##Usage\n\n###Classes and Defined Types\n\n####Class: `nsclient`\nOne of the primary classes of the nsclient module. This class will install the nsclient binaries\n\n**Parameters within `nsclient`:**\n#####`allowed_hosts`\nArray of hosts that your client can communicate with. You can use netmasks (/ syntax) or * to create ranges.\n\n#####`service_state`\nWhether you want to nsclient service to start up. Defaults to running\n\n#####`service_enable`\nWhether you want to nsclient service to start up at boot. Defaults to true\n\n#####`package_source_location`\nThis is the default site to download your package from (e.g. http://files.nsclient.org/stable)\n\n#####`package_source`\nThis is the source name of the package to be downloaded\n\n#####`package_name`\nThis is name of the package to download (e.g. NSCP-0.4.1.101-x64.msi)\n\n#####`download_destination`\nThis is the folder to where we need to download the NSCP Installer. Package cannot take a remote file source\nBecause of Windows, we need to set this to be a top level directory (e.g. c:\\\\temp) or we would need to\nrecursively check the file path.\n\n#####`config_template`\nThis is the template to use as the config file.\n\n#####`proxy_url`\nSpecify a proxy url if needed for downloading the package\n\n#####`password`\nPassword used to authenticate against server\n\n##Reference\n\n###Classes\n####Public Classes\n* [`nsclient`](#class-nsclient): Guides the basic installation of the nsclient application\n\n####Private Classes\n* [`nsclient::config`]  Manages all the default configuration of the nsclient application\n* [`nsclient::install`] Manages the installation of the nsclient\n* [`nsclient::service`] Manages the nclient service\n\n##Limitations\n\nThis module is tested on the following platforms:\n\n* Windows 2008 R2\n\nIt is tested with the OSS version of Puppet only.\n\n##Development\n\n###Contributing\n\nPlease read CONTRIBUTING.md for full details on contributing to this project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoxpupuli%2Fpuppet-nsclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoxpupuli%2Fpuppet-nsclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoxpupuli%2Fpuppet-nsclient/lists"}