{"id":15103573,"url":"https://github.com/sensson/puppet-nfdump","last_synced_at":"2025-02-23T12:55:43.096Z","repository":{"id":57666860,"uuid":"73502314","full_name":"sensson/puppet-nfdump","owner":"sensson","description":"A simple module to manage nfdump and sfcapd","archived":false,"fork":false,"pushed_at":"2018-10-19T17:21:48.000Z","size":22,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-24T20:48:23.468Z","etag":null,"topics":["nfdump","puppet"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sensson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-11T18:41:48.000Z","updated_at":"2018-10-19T17:21:43.000Z","dependencies_parsed_at":"2022-09-02T15:01:04.921Z","dependency_job_id":null,"html_url":"https://github.com/sensson/puppet-nfdump","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sensson%2Fpuppet-nfdump","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sensson%2Fpuppet-nfdump/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sensson%2Fpuppet-nfdump/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sensson%2Fpuppet-nfdump/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sensson","download_url":"https://codeload.github.com/sensson/puppet-nfdump/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240250396,"owners_count":19771782,"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":["nfdump","puppet"],"created_at":"2024-09-25T19:40:33.007Z","updated_at":"2025-02-23T12:55:43.076Z","avatar_url":"https://github.com/sensson.png","language":"Ruby","readme":"# Nfdump\n\n[![Build Status](https://travis-ci.org/sensson/puppet-nfdump.svg?branch=master)](https://travis-ci.org/sensson/puppet-nfdump) [![Puppet Forge](https://img.shields.io/puppetforge/v/sensson/nfdump.svg?maxAge=2592000?style=plastic)](https://forge.puppet.com/sensson/nfdump)\n\nThis module can be used to install nfdump and manages sfcapd processes to capture\nsflow data into nfdump files. It doesn't manage nfsen or the firewall. We recommend\nyou to be restrictive. Only allow traffic from the devices that you trust.\n\n## Examples\n\n### Installation and configuration\n\nThe following example will install nfdump and sets up a single sfcapd process.\n\n```\nclass { '::nfdump':\n  $data_location = '/data/nfdump'\n}\n::nfdump::sfcapd { 'sw1':\n  port =\u003e 6343,\n}\n```\n\n## Reference\n\n### Parameters\n\n#### nfdump\n\nWe provide a number of configuration options to change particular settings\nor to override our defaults when required.\n\n##### `package_name`\n\nDefaults to 'nfdump' on RedHat and 'nfdump-sflow' on Debian based systems.\n\n##### `user_name`\n\nSet the username for any sfcapd processes. Defaults to 'sflow'.\n\n##### `data_location`\n\nSet the location where to store nfdump data. Defaults to '/data/nfdump'.\n\n### Defines\n\n#### nfdump::sfcapd\n\nThis will set up an sflow capture daemon listener.\n\n```\nnfdump::sfcapd { 'device-1.location': }\n```\n\n##### `source`\n\nThis is used as an identifier to the listener. Defaults to '$title'.\n\n##### `port`\n\nThis is the udp port the listener is available on. Defaults to '6343'.\n\n##### `repeater_host`\n\nSfcapd allows you to repeat packages onto another host. Set this to an ip if you want to forward traffic. Defaults to 'undef'.\n\n##### `repeater_port`\n\nSets the port your repeater is available on. Defaults to '6343'.\n\n##### `buffer_len`\n\nSet the buffer length. See -B in `man sfcapd`. Defaults to '200000'.\n\n##### `extension_list`\n\nSet the list of accepted extensions. See -T in `man sfcapd`. Defaults to 'all'.\n\n## Limitations\n\nThis module has been tested on:\n\n* CentOS 7\n* Ubuntu 16.04\n\n## Development\n\nWe strongly believe in the power of open source. This module is our way\nof saying thanks.\n\nThis module is tested against the Ruby versions from Puppet's support\nmatrix. Please make sure you have a supported version of Ruby installed.\n\nIf you want to contribute please:\n\n1. Fork the repository.\n2. Run tests. It's always good to know that you can start with a clean slate.\n3. Add a test for your change.\n4. Make sure it passes.\n5. Push to your fork and submit a pull request.\n\nWe can only accept pull requests with passing tests.\n\nTo install all of its dependencies please run:\n\n```\nbundle install --path vendor/bundle --without development\n```\n\n### Running unit tests\n\n```\nbundle exec rake test\n```\n\n### Running acceptance tests\n\nThe unit tests only verify if the code runs, not if it does exactly\nwhat we want on a real machine. For this we use Beaker. Beaker will\nstart a new virtual machine (using Vagrant) and runs a series of\nsimple tests.\n\nYou can run Beaker tests with:\n\n```\nbundle exec rake spec_prep\nBEAKER_destroy=onpass bundle exec rake beaker:centos7\nBEAKER_destroy=onpass bundle exec rake beaker:ubuntu1604\n```\n\nWe recommend specifying BEAKER_destroy=onpass as it will keep the\nVagrant machine running in case something fails.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsensson%2Fpuppet-nfdump","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsensson%2Fpuppet-nfdump","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsensson%2Fpuppet-nfdump/lists"}