Version information
Start using this module
Add this module to your Puppetfile:
mod 'dalen-puppetdbquery', '0.0.5'
Learn more about managing modules with a PuppetfileDocumentation
PuppetDB query functions
This module contains query functions for PuppetDB for use from Puppet. They require the json ruby gem and the puppetdb-terminus.
Only queries over HTTPS are supported atm.
Usage
pdbresourcequery
The first argument is the resource query. Second argument is optional but allows you to specify the item you want from the returned hash.
Returns an array of hashes or array of strings if second argument is provided.
Examples
# Return an array of hashes describing all files that are owned by root.
$ret = pdbresourcequery(
['and',
['=',['node','active'],true],
['=','type','File'],
['=',['parameter','owner'],'root']])
# Return an array of host names having those resources
$ret = pdbresourcequery(
['and',
['=',['node','active'],true],
['=','type','File'],
['=',['parameter','owner'],'root']], 'certname')
pdbnodequery
The first argument is the node query. Second argument is optional but allows you to specify a resource query that the nodes returned also have to match.
Returns a array of strings with the certname of the nodes (fqdn by default).
Examples
# Return an array of active nodes with an uptime more than 30 days
$ret = pdbnodequery(
['and',
['=',['node','active'],true],
['>',['fact','uptime_days'],30]])
# Return an array of active nodes with an uptime more than 30 days and
# having the class 'apache'
$ret = pdbnodequery(
['and',
['=',['node','active'],true],
['>',['fact','uptime_days'],30]],
['and',
['=',['node','active'],true],
['=','type','Class'],
['=','title','Apache']])
pdbfactquery
The first argument is the node to get facts for. It can be either a single node or an array of nodes. If it is an array the return value of the function will also be an array. Second argument is optional, if specified only return that specific fact.
Examples
# Get hash of facts for foo.example.com
pdbfactquery('foo.example.com')
# Get the uptime fact for foo.example.com
pdbfactquery('foo.example.com', 'uptime')
# Get the uptime fact for foo.example.com and bar.example.com
pdbfactquery(['foo.example.com', 'bar.example.com'], 'uptime')
pdbstatusquery
The first argument is the node to get the status for. Second argument is optional, if specified only return that specific bit of status, one of 'name', 'deactivated', 'catalog_timestamp' and 'facts_timestamp'.
Returns an array of hashes or a array of strings if second argument is supplied.
Examples
# Get status for foo.example.com
pdbstatusquery('foo.example.com')
# Get catalog_timestamp for foo.example.com
pdbstatusquery('foo.example.com', 'catalog_timestamp')
pdbquery
This is the generic query function that the others make use of, you probably don't have to use it and can use one of the specific functions below instead.
The first argument is the URL path that should be queried, for example 'nodes' or 'status/nodes/'. The second argument if supplied if the query parameter, if it is a string it is assumed to be JSON formatted and sent as is, anything else is converted to JSON and then sent.
Examples
# Get list of all active nodes
$ret = pdbquery('nodes', ['=', ['node', 'active'], true ])
# Query status of current node
$ret2 = pdbquery("status/nodes/${settings::certname}")
See http://docs.puppetlabs.com/puppetdb for more info and examples about the PuppetDB API.
Copyright (C) 2012 by Erik Dalén <erik.gustav.dalen@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.