Skip to content

REFERENCE.md

Latest commit

 

History

History
1295 lines (622 loc) · 25.4 KB

REFERENCE.md

File metadata and controls

1295 lines (622 loc) · 25.4 KB
Raw

Reference

Table of Contents

Classes

Public Classes

Private Classes

  • dhcp::params: Parameter defaults

Defined types

Data types

Classes

dhcp

Manage an ISC DHCP server

Parameters

The following parameters are available in the dhcp class:

dnsdomain

Data type: Optional[Array[String[1]]]

Default value: undef

nameservers

Data type: Array[Stdlib::IP::Address::V4]

Default value: []

nameservers_ipv6

Data type: Array[Stdlib::IP::Address::V6]

Default value: []

ntpservers

Data type: Array[Variant[Stdlib::Fqdn,Stdlib::IP::Address]]

Default value: []

dnssearchdomains

Data type: Array[String[1]]

Default value: []

dhcp_conf_header

Data type: String

Default value: 'INTERNAL_TEMPLATE'

dhcp_conf_ddns

Data type: String

Default value: 'INTERNAL_TEMPLATE'

dhcp_conf_ntp

Data type: String

Default value: 'INTERNAL_TEMPLATE'

dhcp_conf_pxe

Data type: String

Default value: 'INTERNAL_TEMPLATE'

dhcp_conf_extra

Data type: String

Default value: 'INTERNAL_TEMPLATE'

dhcp_conf_fragments

Data type: Hash[String[1], Hash[String[1], String[1]]]

Default value: {}

interfaces

Data type: Optional[Array[String[1]]]

Default value: undef

interface

Data type: String[1]

Default value: 'NOTSET'

dnsupdatekey

Data type: Optional[String[1]]

Default value: undef

ddns_update_style

Data type: String[1]

Default value: 'interim'

dnskeyname

Data type: Optional[String[1]]

Default value: undef

ddns_update_static

Data type: String[1]

Default value: 'on'

ddns_update_optimize

Data type: String[1]

Default value: 'on'

ddns_client_updates

Data type: Enum['allow', 'deny']

Default value: 'allow'

pxeserver

Data type: Optional[Stdlib::Host]

Default value: undef

pxefilename

Data type: Optional[String[1]]

Default value: undef

mtu

Data type: Optional[Integer[1]]

Default value: undef

ipxe_filename

Data type: Optional[String[1]]

Default value: undef

ipxe_bootstrap

Data type: Optional[String[1]]

Default value: undef

logfacility

Data type: Dhcp::Syslogfacility

Default value: 'daemon'

default_lease_time

Data type: Integer[-1]

Default value: 43200

max_lease_time

Data type: Integer[-1]

Default value: 86400

service_ensure

Data type: Stdlib::Ensure::Service

Default value: 'running'

globaloptions

Data type: Optional[Variant[String,Array[String[1]]]]

Default value: undef

omapi_port

Data type: Optional[Stdlib::Port]

Default value: undef

omapi_name

Data type: Optional[String[1]]

Default value: undef

omapi_algorithm

Data type: String[1]

Default value: 'HMAC-MD5'

omapi_key

Data type: Optional[String[1]]

Default value: undef

authoritative

Data type: Boolean

Default value: true

extra_config

Data type: Variant[Array[String[1]],String[1]]

Default value: []

dhcp_dir

Data type: Stdlib::Absolutepath

Default value: $dhcp::params::dhcp_dir

dhcpd_conf_filename

Data type: String[1]

Default value: 'dhcpd.conf'

packagename

Data type: String[1]

Default value: $dhcp::params::packagename

manage_package

Data type: Boolean

Default value: true

servicename

Data type: Variant[String[1],Array[String[1]]]

Default value: $dhcp::params::servicename

manage_service

Data type: Boolean

Default value: true

package_provider

Data type: Optional[String[1]]

Default value: $dhcp::params::package_provider

ldap_port

Data type: Stdlib::Port

Default value: 389

ldap_server

Data type: String[1]

Default value: 'localhost'

ldap_username

Data type: String[1]

Default value: 'cn=root, dc=example, dc=com'

ldap_password

Data type: Optional[String[1]]

Default value: undef

ldap_base_dn

Data type: String[1]

Default value: 'dc=example, dc=com'

ldap_method

Data type: Enum['dynamic', 'static']

Default value: 'dynamic'

ldap_debug_file

Data type: Optional[Stdlib::Absolutepath]

Default value: undef

use_ldap

Data type: Boolean

Default value: false

option_code150_label

Data type: String[1]

Default value: 'pxegrub'

option_code150_value

Data type: String[1]

Default value: 'text'

dhcp_classes

Data type: Hash[String[1], Hash]

Default value: {}

hosts

Data type: Hash[String[1], Hash]

Default value: {}

ignoredsubnets

Data type: Hash[String, Hash]

Default value: {}

pools

Data type: Hash[String, Hash]

Default value: {}

pools6

Data type: Hash[String, Hash]

Default value: {}

sharednetworks

Data type: Hash[String, Hash]

Default value: {}

on_commit

Data type: Array[String[1]]

Default value: []

on_release

Data type: Array[String[1]]

Default value: []

on_expiry

Data type: Array[String[1]]

Default value: []

dhcpd_binary

Data type: Optional[Stdlib::Absolutepath]

Default value: $dhcp::params::dhcpd_binary

dhcp::disable

Remove and Disable the DHCP server

Parameters

The following parameters are available in the dhcp::disable class:

packagename

Data type: String[1]

Default value: $dhcp::params::packagename

servicename

Data type: String[1]

Default value: $dhcp::params::servicename

dhcp::failover

Manage a DHCP failover config

Parameters

The following parameters are available in the dhcp::failover class:

peer_address

Data type: Any

role

Data type: Any

Default value: 'primary'

address

Data type: Any

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

port

Data type: Any

Default value: '519'

max_response_delay

Data type: Any

Default value: '30'

max_unacked_updates

Data type: Any

Default value: '10'

mclt

Data type: Any

Default value: '300'

load_split

Data type: Any

Default value: '128'

load_balance

Data type: Any

Default value: '3'

omapi_key

Data type: Optional[String[1]]

Default value: undef

dhcp_dir

Data type: Any

Default value: $dhcp::dhcp_dir

dhcpd_conf_filename

Data type: Any

Default value: $dhcp::dhcpd_conf_filename

Defined types

dhcp::dhcp_class

Manage a DHCP class in the config

Parameters

The following parameters are available in the dhcp::dhcp_class defined type:

parameters

Data type: Variant[Array[String[1]], String[1]]

dhcp::host

Manage a DHCP host

Parameters

The following parameters are available in the dhcp::host defined type:

ip

Data type: Optional[Stdlib::IP::Address]

The ip address of the DHCP host.

Default value: undef

mac

Data type: Dhcp::Mac

The MAC address.

ddns_hostname

Data type: String

The name parameter should be the hostname that will be used in setting up the client's A and PTR records. If no ddns-hostname is specified in scope, then the server will derive the hostname automatically, using an algorithm that varies for each of the different update methods.

Default value: $name

options

Data type: Hash

A hash with key value pairs to go to the option lines. The word 'option' is not needed.

Default value: {}

comment

Data type: Optional[String[1]]

A comment added to the DHCP host.

Default value: undef

ignored

Data type: Boolean

If set to true results in ignore booting; line in the DHCP host configuration.

Default value: false

default_lease_time

Data type: Optional[Integer]

Default lease length.

Default value: undef

max_lease_time

Data type: Optional[Integer]

The maximum lease length.

Default value: undef

ipxe_filename

Data type: Optional[String[1]]

The ipxe filenme, e. g. ipxe.efi.

Default value: undef

ipxe_bootstrap

Data type: Optional[String[1]]

The bootstrap file of UEFI PXE, e. g. winpe.ipxe

Default value: undef

filename

Data type: Optional[String[1]]

The file to be loaded by TFTP.

Default value: undef

on_commit

Data type: Array[String[1]]

An array with statements to go into the hook on commit.

Default value: []

on_release

Data type: Array[String[1]]

An array with statements to go into the hook on release.

Default value: []

on_expiry

Data type: Array[String[1]]

An array with statements to go into the hook on expiry.

Default value: []

dhcp::ignoredsubnet

Manage an ignored subnet

Parameters

The following parameters are available in the dhcp::ignoredsubnet defined type:

network

Data type: Any

mask

Data type: Any

dhcp::pool

Define a dhcp-pool for IPv4 networks

Parameters

The following parameters are available in the dhcp::pool defined type:

network

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

Base-IP-Address of the pool

mask

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

Networkmask of that pool

host_mask

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

Networkmask that is supplied to the client Defaults to mask. Use it to supply a smaller mask to clients if needed

Default value: $mask

gateway

Data type: Optional[String[1]]

Optional IP-address for the gateway

Default value: undef

range

Data type: Optional[Variant[Array[String[1],1],String[1]]]

Optional IP-range to supply addresses from Specify as String with start- and end-IP-address separated by space

Default value: undef

failover

Data type: Optional[String[1]]

Optional name of the DHCP-server to failover

Default value: undef

options

Data type: Optional[Variant[Array[String[1]],String[1]]]

Optional String or Array of option to set in the pool

Default value: undef

parameters

Data type: Optional[Variant[Array[String[1]],String[1]]]

Optional String or Array of manual parameters to set

Default value: undef

sharednetwork

Data type: Optional[String[1]]

Optional String to group this pool into a shared-network segment by the name sharednetwork. You need to define that segment by using dhcp::sharednetwork

Default value: undef

nameservers

Data type: Optional[Array[String]]

Optional set of IPv4-nameservers to supply to the client

Default value: undef

nameservers_ipv6

Data type: Optional[Array[String]]

Optional set of IPv6-nameservers to supply to the client

Default value: undef

pxeserver

Data type: Optional[String]

Optional name of a PXE-server to boot from

Default value: undef

mtu

Data type: Optional[Integer]

Optional size of the MTU to supply to the client

Default value: undef

domain_name

Data type: Optional[String[1]]

Optional domainname for the client

Default value: undef

ignore_unknown

Data type: Any

Set to true to disable leases for clients not explicitly defined by dhcp::host

Default value: undef

on_commit

Data type: Array[String[1]]

Set of statements to execute when providing a lease

Default value: []

on_release

Data type: Array[String[1]]

Set of statements to execute when a lease is released

Default value: []

on_expiry

Data type: Array[String[1]]

Set of statements to execute when a lease expires

Default value: []

dhcp::pool6

Define a dhcp-pool for IPv6 networks

Parameters

The following parameters are available in the dhcp::pool6 defined type:

network

Data type: Stdlib::IP::Address::V6

prefix

Data type: Integer

range

Data type: Optional[Variant[Array[String[1],1],String[1]]]

Default value: undef

range_temp

Data type: Optional[String[1]]

Default value: undef

failover

Data type: Optional[String[1]]

Default value: undef

options

Data type: Optional[Variant[Array[String[1]],String[1]]]

Default value: undef

parameters

Data type: Optional[Variant[Array[String[1]],String[1]]]

Default value: undef

sharednetwork

Data type: Optional[String[1]]

Default value: undef

nameservers

Data type: Optional[Array[String]]

Default value: undef

nameservers_ipv6

Data type: Optional[Array[String]]

Default value: undef

pxeserver

Data type: Optional[String]

Default value: undef

mtu

Data type: Optional[Integer]

Default value: undef

domain_name

Data type: Optional[String[1]]

Default value: undef

ignore_unknown

Data type: Any

Default value: undef

on_commit

Data type: Array[String[1]]

Default value: []

on_release

Data type: Array[String[1]]

Default value: []

on_expiry

Data type: Array[String[1]]

Default value: []

dhcp::sharednetwork

defines a sharednetwork-segment to wrap several pools together

Parameters

The following parameters are available in the dhcp::sharednetwork defined type:

sharednetwork

Data type: String

Name of the sharednetwork as used in dhcp::pool and dhcp::pool6 defaults to the title of this resource

Default value: $title

parameters

Data type: Optional[Variant[Array[String[1]], String[1]]]

optional defaults you can set for the shared-network can be either a single parameter-string, or an array of several parameters

Default value: undef

Data types

Dhcp::Mac

The Dhcp::Mac data type.

Alias of Pattern[/^[0-9A-Fa-f]{1,2}(:[0-9A-Fa-f]{1,2}){5}$/]

Dhcp::Syslogfacility

The Dhcp::Syslogfacility data type.

Alias of Enum['user', 'mail', 'daemon', 'auth', 'syslog', 'lpr', 'news', 'uucp', 'cron', 'authpriv', 'ftp', 'ntp', 'security', 'console', 'solaris-cron', 'local0', 'local1', 'local2', 'local3', 'local4', 'local5', 'local6', 'local7']