Version information
This version is compatible with:
- Puppet Enterprise 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x
- Puppet >=5.5.10 <8.0.0
- RedHat,CentOS,OracleLinux,Scientific,Ubuntu,Debian,OpenBSD
Start using this module
Documentation
avahi
Table of Contents
- Description
- Setup - The basics of getting started with avahi
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
This module manages Avahi for mDNS/DNS-SD services.
RHEL/CentOS, Ubuntu, Debian and OpenBSD are supported using Puppet 5 or later.
Setup
Beginning with avahi
In the very simplest case, you can just include the following:
include dbus
include avahi
Usage
Install Avahi and add static service definitions for SSH and SFTP:
include dbus
include avahi
avahi::service { 'ssh':
description => '%h',
replace_wildcards => true,
services => [
{
'type' => '_ssh._tcp',
'port' => 22,
},
],
}
avahi::service { 'sftp-ssh':
description => '%h',
replace_wildcards => true,
services => [
{
'type' => '_sftp-ssh._tcp',
'port' => 22,
},
],
}
Install Avahi and add a static host entry on behalf of an mDNS-unaware router:
include dbus
include avahi
avahi_host { 'router.local':
ensure => present,
ip => '192.0.2.1',
}
Reference
The reference documentation is generated with puppet-strings and the latest version of the documentation is hosted at https://bodgit.github.io/puppet-avahi/ 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.
Reference
Table of Contents
Classes
avahi: Installs and configures Avahi.avahi::configavahi::daemonavahi::installavahi::params
Defined types
avahi::service: Statically define a service in Avahi.
Resource types
avahi_host: Manages an Avahi host entry.
Data types
Classes
avahi
Installs and configures Avahi.
- See also
- puppet_defined_types::avahi::service
- avahi::service
- puppet_defined_types::avahi::service
Examples
Declaring the class
include dbus
include avahi
Parameters
The following parameters are available in the avahi class:
conf_dirdtd_dirgrouppackage_namepolicy_groupservice_nameuservalidatexmllintadd_service_cookieallow_interfacesallow_point_to_pointbrowse_domainscache_entries_maxcheck_response_ttlclients_maxdeny_interfacesdisable_publishingdisable_user_service_publishingdisallow_other_stacksdomain_nameenable_dbusenable_reflectorenable_wide_areaentries_per_entry_group_maxhost_nameobjects_per_client_maxpublish_aaaa_on_ipv4publish_a_on_ipv6publish_addressespublish_dns_serverspublish_domainpublish_hinfopublish_resolv_conf_dns_serverspublish_workstationratelimit_burstratelimit_interval_usecreflect_ipvrlimit_asrlimit_corerlimit_datarlimit_fsizerlimit_nofilerlimit_nprocrlimit_stackuse_iff_runninguse_ipv4use_ipv6
conf_dir
Data type: Stdlib::Absolutepath
The top-level configuration directory, usually /etc/avahi.
Default value: $avahi::params::conf_dir
dtd_dir
Data type: Stdlib::Absolutepath
The directory containing the XML DTD for service validation.
Default value: $avahi::params::dtd_dir
group
Data type: String
The unprivileged group used to run the daemon.
Default value: $avahi::params::group
package_name
Data type: String
The name of the package.
Default value: $avahi::params::package_name
policy_group
Data type: String
The group that is allowed by policy to set the mDNS hostname.
Default value: $avahi::params::policy_group
service_name
Data type: String
The service name.
Default value: $avahi::params::service_name
user
Data type: String
The unprivileged user used to run the daemon.
Default value: $avahi::params::user
validate
Data type: Boolean
Whether to try and validate service files prior to installing them.
Default value: $avahi::params::validate
xmllint
Data type: Stdlib::Absolutepath
The path to the xmllint binary used to validate service files.
Default value: $avahi::params::xmllint
add_service_cookie
Data type: Optional[Boolean]
Whether a unique cookie is added to all locally registered services.
Default value: undef
allow_interfaces
Data type: Optional[Array[String, 1]]
Interfaces to allow mDNS traffic on.
Default value: undef
allow_point_to_point
Data type: Optional[Boolean]
Include Point-to-Point interfaces.
Default value: undef
browse_domains
Data type: Optional[Array[Bodgitlib::Domain, 1]]
Additional browse domains.
Default value: $avahi::params::browse_domains
cache_entries_max
Data type: Optional[Integer[0]]
How many entries are cached per interface.
Default value: undef
check_response_ttl
Data type: Optional[Boolean]
Whether to check the TTL of mDNS packets.
Default value: undef
clients_max
Data type: Optional[Integer[0]]
Maximum number of D-Bus clients permitted.
Default value: undef
deny_interfaces
Data type: Optional[Array[String, 1]]
Interfaces to explicitly deny mDNS traffic on.
Default value: undef
disable_publishing
Data type: Optional[Boolean]
Disable publishing of any records.
Default value: undef
disable_user_service_publishing
Data type: Optional[Boolean]
Disable publishing of records by user applications.
Default value: undef
disallow_other_stacks
Data type: Optional[Boolean]
Whether to allow other mDNS stacks to run on the host.
Default value: undef
domain_name
Data type: Optional[String]
Override the domain name used, .local normally.
Default value: undef
enable_dbus
Data type: Optional[Boolean]
Whether to connect to D-Bus.
Default value: undef
enable_reflector
Data type: Optional[Boolean]
Whether to enable the mDNS reflector.
Default value: undef
enable_wide_area
Data type: Optional[Boolean]
Enable wide-area mDNS.
Default value: $avahi::params::enable_wide_area
entries_per_entry_group_max
Data type: Optional[Integer[0]]
The maximum number of entries to be registered by a single D-Bus client.
Default value: undef
host_name
Data type: Optional[String]
Override the hostname used for the local machine.
Default value: undef
objects_per_client_max
Data type: Optional[Integer[0]]
The maximum number of objects to be registered by a single D-Bus client.
Default value: undef
publish_aaaa_on_ipv4
Data type: Optional[Boolean]
Whether to publish AAAA records via IPv4.
Default value: undef
publish_a_on_ipv6
Data type: Optional[Boolean]
Whether to publish A records via IPv6.
Default value: undef
publish_addresses
Data type: Optional[Boolean]
Whether to publish mDNS address records for all local IP addresses.
Default value: undef
publish_dns_servers
Data type: Optional[Array[Stdlib::IP::Address::NoSubnet, 1]]
List of unicast DNS servers to publish in mDNS.
Default value: undef
publish_domain
Data type: Optional[Boolean]
Whether to announce the local domain name for browsing by other hosts.
Default value: undef
publish_hinfo
Data type: Optional[Boolean]
Whether to publish HINFO records on all interfaces.
Default value: $avahi::params::publish_hinfo
publish_resolv_conf_dns_servers
Data type: Optional[Boolean]
Whether to publish the DNS servers
listed in /etc/resolv.conf in addition to any listed in
publish_dns_servers.
Default value: undef
publish_workstation
Data type: Optional[Boolean]
Whether to publish a workstation record for the local machine.
Default value: $avahi::params::publish_workstation
ratelimit_burst
Data type: Optional[Integer[0]]
Per-interface packet rate-limiting burst parameter.
Default value: $avahi::params::ratelimit_burst
ratelimit_interval_usec
Data type: Optional[Integer[0]]
Per-interface packet rate-limiting interval parameter.
Default value: $avahi::params::ratelimit_interval_usec
reflect_ipv
Data type: Optional[Boolean]
Whether to reflect between IPv4 and IPv6.
Default value: undef
rlimit_as
Data type: Optional[Integer[0]]
Value in bytes for RLIMIT_AS.
Default value: undef
rlimit_core
Data type: Optional[Integer[0]]
Value in bytes for RLIMIT_CORE.
Default value: $avahi::params::rlimit_core
rlimit_data
Data type: Optional[Integer[0]]
Value in bytes for RLIMIT_DATA.
Default value: $avahi::params::rlimit_data
rlimit_fsize
Data type: Optional[Integer[0]]
Value for RLIMIT_FSIZE.
Default value: $avahi::params::rlimit_fsize
rlimit_nofile
Data type: Optional[Integer[0]]
Value for RLIMIT_NOFILE.
Default value: $avahi::params::rlimit_nofile
rlimit_nproc
Data type: Optional[Integer[2]]
Default value: $avahi::params::rlimit_nproc
rlimit_stack
Data type: Optional[Integer[0]]
Default value: $avahi::params::rlimit_stack
use_iff_running
Data type: Optional[Boolean]
Default value: undef
use_ipv4
Data type: Optional[Boolean]
Default value: $avahi::params::use_ipv4
use_ipv6
Data type: Optional[Boolean]
Default value: $avahi::params::use_ipv6
avahi::config
The avahi::config class.
avahi::daemon
The avahi::daemon class.
avahi::install
The avahi::install class.
avahi::params
The avahi::params class.
Defined types
avahi::service
Statically define a service in Avahi.
- See also
- puppet_classes::avahi
- avahi
- https://linux.die.net/man/5/avahi.service
- avahi.service(5)
- puppet_classes::avahi
Examples
Add static service definitions for SSH and SFTP
include dbus
include avahi
avahi::service { 'ssh':
description => '%h',
replace_wildcards => true,
services => [
{
'type' => '_ssh._tcp',
'port' => 22,
},
],
}
avahi::service { 'sftp-ssh':
description => '%h',
replace_wildcards => true,
services => [
{
'type' => '_sftp-ssh._tcp',
'port' => 22,
},
],
}
Add a static service definition for NFS on IPv6 only
include dbus
include avahi
avahi::service { 'nfs':
description => 'NFS on %h',
replace_wildcards => true,
services => [
{
'type' => '_nfs._tcp',
'port' => 2049,
'protocol' => 'ipv6',
'txt-record' => [
'path=/export/some/path',
],
},
],
}
Advertise an AirPrint printer
include dbus
include avahi
avahi::service { 'printer':
description => 'An AirPrint printer',
services => [
{
'type' => '_ipp._tcp',
'subtype' => [
'_universal._sub._ipp._tcp',
],
'port' => 631,
'txt-record' => [
'txtver=1',
'qtotal=1',
'rp=printers/aPrinter',
'ty=aPrinter',
'adminurl=http://198.0.2.1:631/printers/aPrinter',
'note=Office Laserjet 4100n',
'priority=0',
'product=(GPL Ghostscript)',
'printer-state=3',
'printer-type=0x801046',
'Transparent=T',
'Binary=T',
'Fax=F',
'Color=T',
'Duplex=T',
'Staple=F',
'Copies=T',
'Collate=F',
'Punch=F',
'Bind=F',
'Sort=F',
'Scan=F',
'pdl=application/octet-stream,application/pdf,application/postscript,image/jpeg,image/png,image/urf',
'URF=W8,SRGB24,CP1,RS600',
],
},
],
}
Parameters
The following parameters are available in the avahi::service defined type:
description
Data type: String
The description of the service, any occurence of %h will
be replaced with the hostname if $replace_wildcards is set to true.
services
Data type: Array[Avahi::Record, 1]
An array of hashes which must contain type and port keys
and optionally protocol, subtype, domain-name, host-name and
txt-record keys.
replace_wildcards
Data type: Optional[Boolean]
Whether any occurence of %h is replaced with the
hosname.
Default value: undef
service
Data type: String
The name of the service. It is used to construct the filename,
i.e. ${conf_dir}/services/${service}.service.
Default value: $title
Resource types
avahi_host
Manages an Avahi host entry.
Examples
Add a static host entry on behalf of an mDNS-unaware router
include ::dbus
include ::avahi
avahi_host { 'router.local':
ensure => present,
ip => '192.0.2.1',
}
Properties
The following properties are available in the avahi_host type.
ensure
Valid values: present, absent
The basic property that the resource should be in.
Default value: present
ip
The IP address of the host, either IPv4 or IPv6.
Parameters
The following parameters are available in the avahi_host type.
name
namevar
The host name.
provider
The specific backend to use for this avahi_host resource. You will seldom need to specify this --- Puppet will usually
discover the appropriate provider for your platform.
target
The file in which to store the settings, defaults to /etc/avahi/hosts.
Default value: /etc/avahi/hosts
Data types
Avahi::Domain
The Avahi::Domain data type.
Alias of
Pattern[/(?x) ^ ( (?= [a-z0-9._-]{2,255} ) ( (?= [a-z0-9_-]{1,63} \. ) _ [a-z0-9]+ ( - [a-z0-9]+ )* \. )+ _ [a-z]{2,62} ) $/]
Avahi::Record
The Avahi::Record data type.
Alias of
Struct[{'type' => Avahi::Domain, 'port' => Integer[0, 65535], Optional['protocol'] => Enum['ipv4', 'ipv6', 'any'], Optional['subtype'] => Array[Avahi::Domain], Optional['domain-name'] => String, Optional['host-name'] => Bodgitlib::Domain, Optional['txt-record'] => Array[String]}]
Change log
All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v3.0.0 (2021-06-18)
Changed
Added
v2.0.1 (2017-11-08)
v2.0.0 (2017-01-26)
v1.0.0 (2016-08-25)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/stdlib (>=4.25.0 <8.0.0)
- bodgit/bodgitlib (>=1.5.0 <4.0.0)
- bodgit/dbus (>=2.0.0 <4.0.0)
- herculesteam/augeasproviders_core (>=2.2.0 <3.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2013 Puppet Labs
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.