Forge Home

netstdlib

A collection of network functions and facts

457,563 downloads

457,563 latest version

4.1 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.0.1 (latest)
released Oct 8th 2014

Start using this module

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

Add this module to your Puppetfile:

mod 'yelp-netstdlib', '0.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add yelp-netstdlib
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install yelp-netstdlib --version 0.0.1

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

yelp/netstdlib — version 0.0.1 Oct 8th 2014

##Overview Build Status

netstdlib is a collection of puppet functions and facts for network related work.

These functions and facts are very handy when using puppet to do complex logic on code that deals with configuring or interpreting network interfaces.

Most of them simply expose the native ruby implementations into the puppet manifest so you can use them to say, edit OpenStack config files, or manipulate DCHP server pools.

Examples

# Use macaddress_rand instead of FQDNs because we have lots of VMs with
# the same hostname
cron::d { 'puppet_agent':
  ensure  => $ensure,
  minute  => macaddress_rand(60),
  user    => 'root',
  command => 'puppet agent -t >/dev/null 2>&1',
}
# Have the puppet server query DNS to get the current round-robin A records
$web_server_ips_array = gethostbyname2array("webs.yourdomain.com")
validate_array($web_server_ips_array)
# Reverse Lookup your ip to a name:
$my_name = gethostbyaddr2array($::ipaddress)
notify { "My reverse dns seems to be: ${my_name}": }

##Functions

cidr_to_broadcast

Converts an CIDR address of the form 192.168.0.1/24 into its broadcast address

cidr_to_netmask

Converts an CIDR address of the form 192.168.0.1/24 into its netmask address

cidr_to_network

Converts an CIDR address of the form 192.168.0.1/24 into its network address

fqdn_mac

Generate MAC addresses based on the results of fqdn_rand. Useful for VMs that might have the same hostname.

gethostbyaddr2array

Resolve an IP address into one or more names. (Looks up reverse DNS PTRs)

gethostbyname2array

Resolve a name into one or more IP addresses.

int_to_ip

Converts an IP in its 32 bit integer representation to a dotted address of the form 192.168.0.1

ip_in_cidr

Checks if an ip address is contained within a CIDR address of the form 192.168.0.1/24

ip_to_int

Converts a dotted address of the form 192.168.0.1 into its 32 bit integer representation

netmask_to_masklen

Converts a netmask of the form 255.255.0.0 to the mask length (e.g. 16)

##Limitations

Puppet functions are server-side, facts are client side. Keep this in mind as any DNS related functions will take place on the server.