ralsh (8) - Linux Manuals

Command to display ralsh manual in Linux: $ man 8 ralsh

NAME

vim: softtabstop=4 shiftwidth=4 expandtab

SYNOPSIS

Use the Puppet RAL to directly interact with the system.

USAGE

ralsh [-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 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.

OPTIONS

Note that any configuration parameter thataqs valid in the configuration file is also a valid long argument. For example, aqssldiraq is a valid configuration parameter, so you can specify aq--ssldir <directory>aq as an argument.

See the configuration file documentation at http://puppetlabs.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 aq--genconfigaq.

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 ralsh to return Puppet configuration for the user luke:

$ ralsh user luke
user { aqlukeaq:
  home => aq/home/lukeaq,
  uid => aq100aq,
  ensure => aqpresentaq,
  comment => aqLuke Kanies,,,aq,
  gid => aq1000aq,
  shell => aq/bin/bashaq,
  groups => [aqsysadminaq,aqaudioaq,aqvideoaq,aqpuppetaq]
}

AUTHOR

Luke Kanies