Forge Home

hosts

A simple puppet module to manage hosts file

11,186 downloads

8,690 latest version

3.8 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.3.0 (latest)
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.9
  • 0.1.8
  • 0.1.7
  • 0.1.6
  • 0.1.5
  • 0.1.4
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Jul 16th 2015

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'jsy-hosts', '0.3.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jsy-hosts
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jsy-hosts --version 0.3.0

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.

Download

Documentation

jsy/hosts — version 0.3.0 Jul 16th 2015

hosts

Table of Contents

  1. Overview
  2. Usage - Configuration options and additional functionality
  3. Validations
  4. Limitations - OS compatibility, etc.

Overview

This is a simple puppet module to manage hosts file. You provide the IP, Host and Alias as a hash value and it will update /etc/hosts by default. Alternatively you can also provide a file location.

Usage

Provide one or mulitple entries like below. If you have multiple hostnames or aliases then separate each with a space.

class {'hosts':
         hosts => {entry1 => {ip=>'127.0.0.1',host=>'localhost',alias=>'localdomain'}},
      }

You may also provide the path to the file that will be updated.

class {'hosts':
         file => '/root/somefile',
     hosts => {entry1 => {ip=>'127.0.0.1',host=>'localhost',alias=>'localdomain'},
          entry2 => {ip=>'127.0.0.1',host=>'',alias=>'localdomain'}
         }
      }

Provide more than one hostname or alias as a space separated list.

class {'hosts':
         file => '/root/somefile',
     hosts => {entry1 => {ip=>'127.0.0.1',host=>'localhost localhost.localdomain',alias=>'localdomain'},
          entry2 => {ip=>'127.0.0.1',host=>'',alias=>'localdomain loopback'}
         }
      }

Hiera Example

hosts:
  entry1:
    ip: 127.0.0.1
    host: localhost.localdomain
    alias: localdomain loopback

Using Hiera

class {'hosts':
         file => '/root/somefile',
         hosts => hiera("hosts")
      }

Validations

This modules require that the IP address must not be empty and either host or alias is provided. If the IP is empty or both the host and alias are missing then it will not process that entry. At the moment there is no validation for correct IP or hostname which will be added in the future so please take care when adding these values.

Limitations

This module should be compatible with all systems. Please pay extra attention to IP and hostnames as these are not validated yet.