Puppet Function: extlib::read_url

Defined in:
lib/puppet/functions/extlib/read_url.rb
Function type:
Ruby 4.x API

Overview

extlib::read_url(Stdlib::HTTPUrl $url) ⇒ String

Fetch a string from a URL (should only be used with ‘small’ remote files).

This function should only be used with trusted/internal sources. This is especially important if using it in conjunction with ‘inline_template` or `inline_epp`. The current implementation is also very basic. No thought has gone into timeouts, support for redirects, CA paths etc.

Examples:

Calling the function

extlib::read_url('https://example.com/sometemplate.epp')

Parameters:

  • url (Stdlib::HTTPUrl) —

    The URL to read from

Returns:

  • (String) —

    Returns the contents of the url as a string



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/puppet/functions/extlib/read_url.rb', line 10

Puppet::Functions.create_function(:'extlib::read_url') do
  # @param url The URL to read from
  # @return Returns the contents of the url as a string
  # @example Calling the function
  #   extlib::read_url('https://example.com/sometemplate.epp')
  dispatch :read_url do
    param 'Stdlib::HTTPUrl', :url
    return_type 'String'
  end

  def read_url(url)
    require 'open-uri'
    uri = URI.parse(url)
    uri.read
  end
end