bodgit / puppet-lldpd

Puppet Module for managing lldpd

lldpd

Table of Contents

1. Description
2. Setup - The basics of getting started with lldpd
   • Setup requirements
   • Beginning with lldpd
3. Usage - Configuration options and additional functionality
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module

Description

This module installs and manages lldpd which provides LLDP advertisements to connected network devices.

RHEL/CentOS, Ubuntu, Debian and OpenBSD are supported using Puppet 5 or later.

Setup

Setup Requirements

On RHEL/CentOS platforms you will need to have access to the EPEL repository by using puppet/epel or by other means.

Beginning with lldpd

In the very simplest case, applying the module will install and start the lldpd agent and enable LLDP advertisements:

include lldpd

Usage

If you want to also enable the Cisco Discovery Protocol, which comprises two versions, use the following:

class { 'lldpd':
  enable_cdpv1 => true,
  enable_cdpv2 => true,
}

Enabling the SNMP AgentX sub-agent can be done with:

class { 'lldpd':
  enable_snmp => true,
  snmp_socket => ['127.0.0.1', 705],
}

Reference

The reference documentation is generated with puppet-strings and the latest version of the documentation is hosted at https://bodgit.github.io/puppet-lldpd/ and available also in the REFERENCE.md.

Limitations

This module has been built on and tested against Puppet 5 and higher.

The module has been tested on:

• Red Hat/CentOS Enterprise Linux 6/7/8
• Ubuntu 16.04/18.04/20.04
• Debian 9/10
• OpenBSD 6.9

Development

The module relies on PDK and has both rspec-puppet and Litmus tests. Run them with:

$ bundle exec rake spec
$ bundle exec rake litmus:*

Please log issues or pull requests at github.

puppet-lldpd's Issues

Drop old OS versions

Drop thrnio/ip dependency

Convert to PDK

Convert to Litmus

Test on OpenBSD 6.2 & 6.3

AgentX support should be usable again in the OS-provided snmpd(8) so maybe try and test with that again.

Convert to Hiera

Move to Hiera data in module

This should be really easy to do as there's only two parameters.

Test SNMP support

Requires some sort of SNMP agent installing for acceptance tests. On OpenBSD prefer the included snmpd(8), use Net-SNMP everywhere else most likely.

Drop old Puppet versions