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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
.TH "" "" ""
.SH NAME
\-
.\" Man page generated from reStructeredText.
vim: softtabstop=4 shiftwidth=4 expandtab
.SH SYNOPSIS
Use the Puppet RAL to directly interact with the system.
.SH USAGE
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B ralsh [\-h|\-\-help] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-edit] [\-H|\-\-host <host>]
[\-p|\-\-param <param>] [\-t|\-\-types] type <name>
.UNINDENT
.UNINDENT
.UNINDENT
.SH 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 ralsh
will tell you everything it knows about all instances of that type. You
can optionally specify an instance name, and ralsh will only describe
that single instance.
You can also add +\-\-edit+ as an argument, and ralsh 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.
.SH 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
\fI\%http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference\fP 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:
.INDENT 0.0
.INDENT 3.5
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.
.UNINDENT
.UNINDENT
host:
.INDENT 0.0
.INDENT 3.5
When specified, connect to the resource server on the named host
and retrieve the list of resouces of the type specified.
.UNINDENT
.UNINDENT
help:
.INDENT 0.0
.INDENT 3.5
Print this help message.
.UNINDENT
.UNINDENT
param:
.INDENT 0.0
.INDENT 3.5
Add more parameters to be outputted from queries.
.UNINDENT
.UNINDENT
types:
.INDENT 0.0
.INDENT 3.5
List all available types.
.UNINDENT
.UNINDENT
verbose: Print extra information.
.SH EXAMPLE
This example uses \fBralsh\fP to return Puppet configuration for the user
\fBluke\fP:
.nf
$ ralsh user luke
user { \'luke\':
home => \'/home/luke\',
uid => \'100\',
ensure => \'present\',
comment => \'Luke Kanies,,,\',
gid => \'1000\',
shell => \'/bin/bash\',
groups => [\'sysadmin\',\'audio\',\'video\',\'puppet\']
}
.fi
.SH AUTHOR
Luke Kanies
.SH COPYRIGHT
Copyright (c) 2005\-2007 Reductive Labs, LLC Licensed under the GNU
Public License
.\" Generated by docutils manpage writer on 2009-12-30 19:24.
.\"
|
