diff options
Diffstat (limited to 'lib/puppet/util/command_line/ralsh')
| -rwxr-xr-x | lib/puppet/util/command_line/ralsh | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/lib/puppet/util/command_line/ralsh b/lib/puppet/util/command_line/ralsh new file mode 100755 index 000000000..b866eded6 --- /dev/null +++ b/lib/puppet/util/command_line/ralsh @@ -0,0 +1,89 @@ +#!/usr/bin/env ruby + +# +# = Synopsis +# +# Use the Puppet RAL to directly interact with the system. +# +# = Usage +# +# puppet resource [-h|--help] [-d|--debug] [-v|--verbose] [-e|--edit] +# [-H|--host <host>] [-p|--param <param>] [-t|--types] +# type <name> +# +# = Description +# +# This command provides simple facilities for converting current system state +# into Puppet code, along with some ability to use Puppet to affect the current +# state. +# +# By default, you must at least provide a type to list, which case puppet resource +# will tell you everything it knows about all instances of that type. You can +# optionally specify an instance name, and puppet resource will only describe that single +# instance. +# +# You can also add +--edit+ as an argument, and puppet resource will write its output +# to a file, open that file in an editor, and then apply the file as a Puppet +# transaction. You can easily use this to use Puppet to make simple changes to +# a system. +# +# = Options +# +# Note that any configuration parameter that's valid in the configuration file +# is also a valid long argument. For example, 'ssldir' is a valid configuration +# parameter, so you can specify '--ssldir <directory>' as an argument. +# +# See the configuration file documentation at +# http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference for +# the full list of acceptable parameters. A commented list of all +# configuration options can also be generated by running puppet with +# '--genconfig'. +# +# debug:: +# Enable full debugging. +# +# edit: +# Write the results of the query to a file, open the file in an editor, +# and read the file back in as an executable Puppet manifest. +# +# host: +# When specified, connect to the resource server on the named host +# and retrieve the list of resouces of the type specified. +# +# help: +# Print this help message. +# +# param: +# Add more parameters to be outputted from queries. +# +# types: +# List all available types. +# +# verbose:: +# Print extra information. +# +# = Example +# +# This example uses ``puppet resource`` to return Puppet configuration for the user ``luke``:: +# +# $ puppet resource user luke +# user { 'luke': +# home => '/home/luke', +# uid => '100', +# ensure => 'present', +# comment => 'Luke Kanies,,,', +# gid => '1000', +# shell => '/bin/bash', +# groups => ['sysadmin','audio','video','puppet'] +# } +# +# = Author +# +# Luke Kanies +# +# = Copyright +# +# Copyright (c) 2005-2007 Reductive Labs, LLC +# Licensed under the GNU Public License + +#Puppet::Application[:resource].run |