Forge Home


puppet module to manage OpenBGPd


5,836 latest version

4.6 quality score

Version information

  • 0.2.3 (latest)
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.0
released Feb 13th 2018
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 'icann-openbgpd', '0.2.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add icann-openbgpd
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install icann-openbgpd --version 0.2.3

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.



icann/openbgpd — version 0.2.3 Feb 13th 2018

Build Status Puppet Forge Puppet Forge Downloads


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 openbgpd
  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


Manage the installation and configuration of OpenBGPd (Routing Daemons) .

Module Description

This modules allows for the manging of the openbgpd daemon.


What openbgpd affects

  • Manages the openbgpd configueration file

Setup Requirements

  • depends on stdlib 4.12.0 (may work with earlier versions)
  • depends on icann-tea 0.2.2 (may work with earlier versions)

Beginning with openbgpd

Install the package an make sure it is enabled and running with default options, this will just configure zebra to run with no bgp config:

class { '::openbgpd': }

With some bgp peers

class { '::openbgpd': }
class { '::openbgpd::bgpd':
  my_asn => 64496,
  router_id => '',
  networks4 => [ ''],
  peers => {
    '64497' => {
      'addr4' => [''],
      'desc'  => 'TEST Network'

and in hiera

openbgpd::my_asn: 64496,
- ''
    - ''
    desc: TEST Network


Add config but disable advertisments and add nagios checks

class { '::openbgpd::bgpd':
  my_asn => 64496,
  router_id => '',
  networks4 => [ ''],
  enable_advertisements => false,
  peers => {
    '64497' => {
      'addr4' => [''],
      'desc'  => 'TEST Network'

Full config

class { '::openbgpd::bgpd':
  my_asn                   => 64496,
  router_id                => '',
  networks4                => [ '', ''],
  failsafe_networks4       => [''],
  networks6                => ['2001:DB8::/48'],
  failsafe_networks6       => ['2001:DB8::/32'],
  enable_advertisements    => false,
  enable_advertisements_v4 => false,
  enable_advertisements_v6 => false,
  peers => {
    '64497' => {
      'addr4'          => [''],
      'addr6'          => ['2001:DB8::2'],
      'desc'           => 'TEST Network',
      'inbound_routes' => 'all',
      'communities'    => ['no-export', '64497:100' ],
      'multihop'       => 5,
      'prepend'        => 3,



Public Classes

Class: openbgpd

configure BGP settings

Parameters (all optional)
  • my_asn (Int, Default: undef): The local ASN to use
  • router_id (IP Address, Default: undef): IP address for the router ID
  • networks4 (Array, Default: []): Array ip IPv4 networks in CIDR format to configure
  • failsafe_networks4 (Array, Default: []): Array ip IPv4 failsafe networks in CIDR format to configure. Failsafe networks consist of covering prefixes for the IPv4 networks. if the policy decided to disable advertising due to detected errors it will leave the failsafe network inplace. This is a specific use case for anycast networks which effectivly disables an anycast node as all others will still be advertising a more specific network; however if something goes wrong and all nodes have the most specific route removed then we would still have this failsafe network in place.
  • networks6 (Array, Default: []): Array ip IPv6 networks in CIDR format to configure
  • failsafe_networks4 (Array, Default: []): Array ip IPv6 failsafe networks in CIDR format to configure. See failsafe_networks4 for a description
  • failsafe_server (Bool, Default: false): If this is set to true then we will only ever advertise the failsafe networks. i.e. the node will be effectivly ofline unless all other nodes are either out of commision or remove ther most specific networks (networks4 and networks6)
  • enable_advertisements (Bool, Default: true): If this is set to false then no networks, including the failsafe networks, will be advertised.
  • enable_advertisements_v4 (Bool, Default: true): If this is set to false then no IPv4 networks, including the failsafe IPv4 networks, will be advertised.
  • enable_advertisements_v6 (Bool, Default: true): If this is set to false then no IPv6 networks, including the failsafe IPv6 networks, will be advertised.
  • conf_file (Absolute file path, Default: '/etc/openbgpd/bgpd.conf'): The fully qualified path to the managed config file

Defined openbgpd::peer

Creat config for individual peers

  • namevar (Int): ASN of the peer
  • addr4 (Array, Default: []): Array of IPv4 neighbor addresses
  • addr6 (Array, Default: []): Array of IPv6 neighbor addresses
  • desc (String, Default: undef): Description of the peer
  • inbound_routes (String /^(all|none|defaultv4|default|v6default)$/, Default: 'none'): what ACL to apply for inbound routes.
    • all: accept all but the default route
    • none: accept no routes
    • default: only accept default routes
    • v4default: only accept default routes over ipv4
    • v6default: accept a default v6 route
  • communities (Array, Default: []): Array of comminuties to set on advertised routes.
  • multihop (Int, Default: undef): Multihop setting to set on peers neighbor addresses
  • prepend (Int, Default: undef): Number of times to prepend your own ASN on advertised routes


This module has been tested on:

  • FreeBSD 10


Pull requests welcome but please also update documentation and tests.