Puppet Function: simplib::nets2cidr

Defined in:
lib/puppet/functions/simplib/nets2cidr.rb
Function type:
Ruby 4.x API

Overview

Take an input list of networks and returns an equivalent ‘Array` in CIDR notation.

  • Hostnames are passed through untouched.

  • Terminates catalog compilation if any input item is not a valid network or hostname.

Signatures:

  • simplib::nets2cidr(String $network_list) ⇒ Array[String]

    Returns Array of networks in CIDR notation.

    Examples:

    Convert space-separated network string

    $networks = '1.2.0.0/255.255.0.0 myhost.test.local'
$cidrs = nets2cidr($networks)

returns $cidrs = [ '1.2.0.0/16',
                   'myhost.test.local'
                 ]

    Parameters:

    • network_list (String) —

      List of 1 or more networks separated by spaces, commas, or semicolons

    Returns:

    • (Array[String]) —

      Array of networks in CIDR notation

    Raises:

    • (RuntimeError) —

      if any input item is not a valid network or hostname

  • simplib::nets2cidr(Array $networks) ⇒ Array[String]

    Returns Array of networks in CIDR notation.

    Examples:

    Convert array of networks

    $networks = [ '1.2.0.0/255.255.0.0',
              '2001:db8:85a3::8a2e:370:0/112',
              '1.2.3.4',
              'myhost.test.local'
            ]
$cidrs = nets2cidr($networks)

returns $cidrs = [ '1.2.0.0/16',
                   '2001:db8:85a3::8a2e:370:0/112',
                   '1.2.3.4',
                   'myhost.test.local'
                 ]

    Parameters:

    • networks (Array) —

      Array of networks

    Returns:

    • (Array[String]) —

      Array of networks in CIDR notation

    Raises:

    • (RuntimeError) —

      if any input item is not a valid network or hostname



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/puppet/functions/simplib/nets2cidr.rb', line 8

Puppet::Functions.create_function(:'simplib::nets2cidr') do

  # @param network_list List of 1 or more networks separated by spaces,
  #   commas, or semicolons
  # @return [Array[String]] Array of networks in CIDR notation
  # @raise [RuntimeError] if any input item is not a valid network
  #   or hostname
  #
  # @example Convert space-separated network string
  #    $networks = '1.2.0.0/255.255.0.0 myhost.test.local'
  #    $cidrs = nets2cidr($networks)
  #
  #    returns $cidrs = [ '1.2.0.0/16',
  #                       'myhost.test.local'
  #                     ]
  dispatch :nets2cidr_list do
    required_param 'String', :network_list
  end

  # @param networks Array of networks
  # @return [Array[String]] Array of networks in CIDR notation
  # @raise [RuntimeError] if any input item is not a valid network
  #   or hostname
  #
  # @example Convert array of networks
  #    $networks = [ '1.2.0.0/255.255.0.0',
  #                  '2001:db8:85a3::8a2e:370:0/112',
  #                  '1.2.3.4',
  #                  'myhost.test.local'
  #                ]
  #    $cidrs = nets2cidr($networks)
  #
  #    returns $cidrs = [ '1.2.0.0/16',
  #                       '2001:db8:85a3::8a2e:370:0/112',
  #                       '1.2.3.4',
  #                       'myhost.test.local'
  #                     ]
  #
  dispatch :nets2cidr do
    required_param 'Array', :networks
  end

  def nets2cidr_list(network_list)
    networks = network_list.split(/\s|,|;/).delete_if{ |y| y.empty? }
    nets2cidr(networks)
  end

  def nets2cidr(networks)

    require  File.expand_path(File.dirname(__FILE__) + '/../../../puppetx/simp/simplib.rb')
    require 'ipaddr'

    retval = Array.new
    networks.each do |lnet|
      # Skip any hostnames that we find.
      if PuppetX::SIMP::Simplib.hostname_only?(lnet)
        retval << lnet
        next
      end

      begin
        ipaddr = IPAddr.new(lnet)
      rescue
        fail("simplib::nets2cidr: '#{lnet}' is not a valid network!")
      end

      # Just add it if it doesn't have a specified netmask.
      if lnet =~ /\//
        retval << "#{ipaddr.to_s}/#{IPAddr.new(ipaddr.inspect.split('/').last.chop).to_i.to_s(2).count('1')}"
      else
        retval << lnet
      end
    end
    retval
  end
end