Skip to content

Latest commit

 

History

History
127 lines (74 loc) · 3.02 KB

REFERENCE.md

File metadata and controls

127 lines (74 loc) · 3.02 KB
Raw

Reference

Table of Contents

Classes

Public Classes

  • anycast_rip: Class 'anycast_rip' Configure bird and bird6 for anycast with rip This class can be used to announce the availability of service IP address

Private Classes

  • anycast_rip::config: Configure bird and bird6 instances
  • anycast_rip::install: Install the bird package
  • anycast_rip::service: Manage the bird services.

Classes

anycast_rip

Class 'anycast_rip'

Configure bird and bird6 for anycast with rip

This class can be used to announce the availability of service IP addresses on the host to the next router, using the RIP routing protocol. Whenever an IP address exists on the host, and it matches one of the configured network prefixes, it is announced by the RIP daemon.

Examples

Declaring the class
include anycast_rip
Actually doing something useful
class { 'anycast_rip':
  network_interface => 'team0',
  network_prefixes  => ['192.0.2.0/24', '2001:db8::/64'],
}

Parameters

The following parameters are available in the anycast_rip class:

instances

Data type: Array[Enum['bird', 'bird6']]

The bird instances to control

Default value: ['bird', 'bird6']

config_dir

Data type: Stdlib::Absolutepath

The path to the configuration directory

Default value: '/etc/bird'

config_file_owner

Data type: String

The owner of the configuration files

Default value: 'root'

config_file_group

Data type: String

The group ownership of the configuration files

Default value: 'bird'

network_prefixes

Data type: Array[Variant[Stdlib::IP::Address::V6::CIDR, Stdlib::IP::Address::V4::CIDR]]

A list of IPv4 and IPv6 network prefixes used to filter IP addresses to announce.

Default value: []

router_id

Data type: Stdlib::IP::Address::V4::Nosubnet

Router ID for this RIP instance

Default value: $facts['networking']['ip']

network_interface

Data type: String

The network interface to announce prefixes to

Default value: 'lo'

auth_password

Data type: Optional[String]

An optional password for authenticating with the next hop

Default value: undef