Puppet Function: simplib::ip::family_hash

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

Overview

simplib::ip::family_hash(Variant[ Simplib::Host, Simplib::IP::V4::DDQ, Simplib::IP::V4::CIDR, Simplib::IP::V6::CIDR, Simplib::Netlist ] $ip_addresses) ⇒ Hash

Process an array of IP addresses and return them split by IP family and include metadata and/or processed versions.

Examples:


simplib::ip::family_hash(
  [
    '1.2.3.4',
    '2.3.4.5/8',
    '::1',
  ]
)

Returns (YAML Formatted for clarity)

---
ipv4:
  '1.2.3.4':
    address: '1.2.3.4'
    netmask:
      ddq: '255.255.255.255'
      cidr: 32
  '2.3.4.5/8':
    address: '2.0.0.0'
    netmask:
      ddq: '255.0.0.0'
      cidr: 8
ipv6:
  '::1':
    address: '[::1]'
    netmask:
      ddq: nil
      cidr: 128

Parameters:

  • ip_addresses (Variant[ Simplib::Host, Simplib::IP::V4::DDQ, Simplib::IP::V4::CIDR, Simplib::IP::V6::CIDR, Simplib::Netlist ]) —

    The addresses to convert

Returns:

  • (Hash) —

    Converted Hash with the following format (YAML representation):

    “‘ # IPv4 Addresses ipv4:

    <Passed Address>:
  address: <normalized address>
  netmask:
    ddq: <dotted quad notation netmask>
    cidr: <CIDR netmask>

    # IPv6 Addresses ipv6:

    <Passed Address>:
  address: <normalized address>
  netmask:
    # DDQ is not valid for IPv6
    ddq: nil
    cidr: <CIDR netmask>

    “‘



4
5
6
7
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/puppet/functions/simplib/ip/family_hash.rb', line 4

Puppet::Functions.create_function(:'simplib::ip::family_hash') do
  # @param ip_addresses
  #   The addresses to convert
  #
  # @return [Hash]
  #   Converted Hash with the following format (YAML representation):
  #
  #   ```
  #   # IPv4 Addresses
  #   ipv4:
  #     <Passed Address>:
  #       address: <normalized address>
  #       netmask:
  #         ddq: <dotted quad notation netmask>
  #         cidr: <CIDR netmask>
  #   # IPv6 Addresses
  #   ipv6:
  #     <Passed Address>:
  #       address: <normalized address>
  #       netmask:
  #         # DDQ is not valid for IPv6
  #         ddq: nil
  #         cidr: <CIDR netmask>
  #   ```
  #
  # @example
  #
  #   simplib::ip::family_hash(
  #     [
  #       '1.2.3.4',
  #       '2.3.4.5/8',
  #       '::1',
  #     ]
  #   )
  #
  #   Returns (YAML Formatted for clarity)
  #
  #   ---
  #   ipv4:
  #     '1.2.3.4':
  #       address: '1.2.3.4'
  #       netmask:
  #         ddq: '255.255.255.255'
  #         cidr: 32
  #     '2.3.4.5/8':
  #       address: '2.0.0.0'
  #       netmask:
  #         ddq: '255.0.0.0'
  #         cidr: 8
  #   ipv6:
  #     '::1':
  #       address: '[::1]'
  #       netmask:
  #         ddq: nil
  #         cidr: 128
  #
  dispatch :family_hash do
    required_param 'Variant[
      Simplib::Host,
      Simplib::IP::V4::DDQ,
      Simplib::IP::V4::CIDR,
      Simplib::IP::V6::CIDR,
      Simplib::Netlist
    ]', :ip_addresses
  end

  def family_hash(addresses)
    results = {}

    Array(addresses).uniq.each do |addr|
      ip_breakdown = {
        'address' => addr,
        'netmask' => {
          'ddq'  => nil,
          'cidr' => nil,
        },
      }

      begin
        ip = IPAddr.new(addr)

        addr_normalized, cidr_netmask = call_function('simplib::nets2cidr', addr)
                                        .first.split('/')

        addr_normalized.delete!('[]')

        ip_breakdown['address'] = addr_normalized
        ip_breakdown['netmask']['cidr'] = cidr_netmask && cidr_netmask.to_i

        if ip.ipv4?
          ip_family = 'ipv4'

          ip_breakdown['netmask']['ddq'] = call_function('simplib::nets2ddq', addr)
                                           .first.split('/')[1] || '255.255.255.255'

          ip_breakdown['netmask']['cidr'] = 32 unless ip_breakdown['netmask']['cidr']
        elsif ip.ipv6?
          ip_family = 'ipv6'

          ip_breakdown['netmask']['cidr'] = 128 unless ip_breakdown['netmask']['cidr']
        else
          ip_family = 'unknown'
        end
      rescue
        ip_family = 'unknown'
      end

      results[ip_family] ||= {}
      results[ip_family][addr] = ip_breakdown
    end

    results
  end
end