puppet-node(8) - Linux man page
Name
puppet-node - View and manage node definitions.Synopsis
puppet node action [--terminus TERMINUS] [--extra HASH]Description
This subcommand interacts with node objects, which are used by Puppet to build a catalog. A node object consists of the node's facts, environment, node parameters (exposed in the parser as top-scope variables), and classes.Options
See the configuration file documentation at http://docs.puppetlabs.com/references/stable/configuration.html for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppet with --genconfig.
- --mode MODE
- The run mode to use for the current action. Valid modes are user, agent, and master.
- --render-as FORMAT
- The format in which to render output. The most common formats are json, s (string), yaml, and console, but other options such as dot are sometimes available.
- --verbose
- Whether to log verbosely.
- --debug
- Whether to log debug information.
- --extra HASH
- A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back-end. Anything passed as the extra value is just send direct to the back-end.
- --terminus TERMINUS
- Indirector faces expose indirected subsystems of Puppet. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of find, search, save, and destroy) from an arbitrary number of pluggable backends. In Puppet parlance, these backends are called terminuses.
- Almost all indirected subsystems have a rest terminus that interacts with the puppet master's data. Most of them have additional terminuses for
various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request.
- The terminus for an action is often determined by context, but occasionally needs to be set explicitly. See the "Notes" section of this face's manpage for more details.
Actions
- clean - Clean up everything a puppetmaster knows about a node: SYNOPSIS
- puppet node clean [--terminus TERMINUS] [--extra HASH] [--[no-]unexport] host1 [host2 ...]
- DESCRIPTION
- This includes
- DESCRIPTION
- puppet node clean [--terminus TERMINUS] [--extra HASH] [--[no-]unexport] host1 [host2 ...]
- Signed certificates ($vardir/ssl/ca/signed/node.domain.pem)
- Cached facts ($vardir/yaml/facts/node.domain.yaml)
- Cached node stuff ($vardir/yaml/node/node.domain.yaml)
- Reports ($vardir/reports/node.domain)
- Stored configs: it can either remove all data from an host in your storedconfig database, or with --unexport turn every exported resource supporting ensure
to absent so that any other host checking out their config can remove those exported configurations.
- This will unexport exported resources of a host, so that consumers of these resources can remove the exported resources and we will safely remove the node
from our infrastructure.
- OPTIONS
- --[no-]unexport - Unexport exported resources
- OPTIONS
- This will unexport exported resources of a host, so that consumers of these resources can remove the exported resources and we will safely remove the node
from our infrastructure.
- destroy - Invalid for this subcommand.: SYNOPSIS
- puppet node destroy [--terminus TERMINUS] [--extra HASH] key
- DESCRIPTION
- Invalid for this subcommand.
- DESCRIPTION
- puppet node destroy [--terminus TERMINUS] [--extra HASH] key
- find - Retrieve a node object.: SYNOPSIS
- puppet node find [--terminus TERMINUS] [--extra HASH] host
- DESCRIPTION
- Retrieve a node object.
- RETURNS
- A hash containing the node's classes, environment, expiration, name, parameters (its facts, combined with any ENC-set parameters), and time. When used from the Ruby API: a Puppet::Node object.
- RENDERING ISSUES: Rendering as string and json are currently broken; node objects can only be rendered as yaml.
- DESCRIPTION
- puppet node find [--terminus TERMINUS] [--extra HASH] host
- info - Print the default terminus class for this face.: SYNOPSIS
- puppet node info [--terminus TERMINUS] [--extra HASH]
- DESCRIPTION
- Prints the default terminus class for this subcommand. Note that different run modes may have different default termini; when in doubt, specify the run mode with the '--mode' option.
- DESCRIPTION
- puppet node info [--terminus TERMINUS] [--extra HASH]
- save - Invalid for this subcommand.: SYNOPSIS
- puppet node save [--terminus TERMINUS] [--extra HASH] key
- DESCRIPTION
- Invalid for this subcommand.
- DESCRIPTION
- puppet node save [--terminus TERMINUS] [--extra HASH] key
- search - Invalid for this subcommand.: SYNOPSIS
- puppet node search [--terminus TERMINUS] [--extra HASH] query
- DESCRIPTION
- Invalid for this subcommand.
- DESCRIPTION
Examples
- find
Retrieve an "empty" (no classes, no ENC-imposed parameters, and an environment of "production") node:
$ puppet node find somenode.puppetlabs.lan --terminus plain --render-as yaml
Retrieve a node using the puppet master's configured ENC:
$ puppet node find somenode.puppetlabs.lan --terminus exec --mode master --render-as yaml
Retrieve the same node from the puppet master:
$ puppet node find somenode.puppetlabs.lan --terminus rest --render-as yaml
Notes
This subcommand is an indirector face, which exposes find, search, save, and destroy actions for an indirected subsystem of Puppet. Valid termini for this face include:- active_record
- exec
- ldap
- memory
- plain
- rest
- store_configs
- yaml
Copyright and License
Copyright 2011 by Puppet Labs Apache 2 license;- see COPYING
- puppet node search [--terminus TERMINUS] [--extra HASH] query