Puppet Function: query_resources

Defined in:
lib/puppet/parser/functions/query_resources.rb
Function type:
Ruby 3.x API

Overview

query_resources() ⇒ Any

Accepts two or three arguments: a query used to discover nodes, a resource query for the resources that should be returned from those hosts, and optionally a boolean for whether or not to group the results by host.

The result is a hash (by default) that maps the name of the nodes to a list of resource entries. This is a list because there’s no single reliable key for resource operations that’s of any use to the end user.

If the third parameters is false the result will be a an array of all resources found.

Examples:

Returns the parameters and such for the ntp class for all CentOS nodes:

  query_resources('operatingsystem=CentOS', 'Class["ntp"]')

Returns information on the apache user on all nodes that have apache installed on port 443:

  query_resources('Class["apache"]{ port = 443 }', 'User["apache"]')

Returns the parameters and such for the apache class for all nodes:

  query_resources(false, 'Class["apache"]')

Returns the parameters for the apache class for all nodes in a flat array:

  query_resources(false, 'Class["apache"]', false)

Returns:

  • (Any) 


1
2
3
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
 
# File 'lib/puppet/parser/functions/query_resources.rb', line 1

Puppet::Parser::Functions.newfunction(:query_resources, :type => :rvalue, :arity => -3, :doc => <<-EOT

  Accepts two or three arguments: a query used to discover nodes, a
  resource query for the resources that should be returned from
  those hosts, and optionally a boolean for whether or not to group the results by host.

  The result is a hash (by default) that maps the name of the nodes to a list of
  resource entries.  This is a list because there's no single
  reliable key for resource operations that's of any use to the end user.

  If the third parameters is false the result will be a an array of all resources found.

  Examples:

    Returns the parameters and such for the ntp class for all CentOS nodes:

      query_resources('operatingsystem=CentOS', 'Class["ntp"]')

    Returns information on the apache user on all nodes that have apache installed on port 443:

      query_resources('Class["apache"]{ port = 443 }', 'User["apache"]')

    Returns the parameters and such for the apache class for all nodes:

      query_resources(false, 'Class["apache"]')

    Returns the parameters for the apache class for all nodes in a flat array:

      query_resources(false, 'Class["apache"]', false)

EOT
                                     ) do |args|
  nodequery, resquery, grouphosts = args

  require 'puppet/util/puppetdb'
  # This is needed if the puppetdb library isn't pluginsynced to the master
  $LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..'))
  begin
    require 'puppetdb/connection'
  ensure
    $LOAD_PATH.shift
  end

  PuppetDB::Connection.check_version

  uri = URI(Puppet::Util::Puppetdb.config.server_urls.first)
  puppetdb = PuppetDB::Connection.new(uri.host, uri.port, uri.scheme == 'https')
  parser = PuppetDB::Parser.new
  nodequery = parser.parse nodequery, :facts if nodequery and nodequery.is_a? String
  resquery = parser.parse resquery, :none if resquery and resquery.is_a? String

  # Construct query
  if resquery && !resquery.empty?
    if nodequery && !nodequery.empty?
      q = ['and', resquery, nodequery]
    else
      q = resquery
    end
  else
    fail "PuppetDB resources query error: at least one argument must be non empty; arguments were: nodequery: #{nodequery.inspect} and requery: #{resquery.inspect}"
  end

  # Fetch the results
  results = puppetdb.query(:resources, q)

  # If grouphosts is true create a nested hash with nodes and resources
  if grouphosts
    results.reduce({}) do |ret, resource|
      ret[resource['certname']] = [] unless ret.key? resource['certname']
      ret[resource['certname']] << resource
      ret
    end
  else
    results
  end
end