.\" Man page generated from reStructuredText.
.
.TH "RECLASS" "1" "Mar 11, 2017" "1.4" "reclass"
.SH NAME
reclass \- command-line interface
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.nf
\fBreclass\fP \-\-help
\fBreclass\fP \fI[options]\fP \-\-inventory
\fBreclass\fP \fI[options]\fP \-\-nodeinfo=NODENAME
.fi
.sp
.SH DESCRIPTION
.sp
\fBreclass\fP is an "external node classifier" (ENC) as can be used with
automation tools, such as \fI\%Puppet\fP, \fI\%Salt\fP, and \fI\%Ansible\fP\&. It is also
a stand\-alone tool for merging data sources recursively.
.sp
The purpose of an ENC is to allow a system administrator to maintain an
inventory of nodes to be managed, completely separately from the configuration
of the automation tool. Usually, the external node classifier completely
replaces the tool\-specific inventory (such as \fBsite.pp\fP for Puppet,
\fBext_pillar\fP/\fBmaster_tops\fP for Salt, or \fB/etc/ansible/hosts\fP).
.sp
With respect to the configuration management tool, the ENC then fulfills two
jobs:
.INDENT 0.0
.IP \(bu 2
it provides information about groups of nodes and group memberships
.IP \(bu 2
it gives access to node\-specific information, such as variables
.UNINDENT
.sp
\fBreclass\fP allows you to define your nodes through class inheritance, while
always able to override details further up the tree (i.e. in more specific
nodes). Think of classes as feature sets, as commonalities between nodes, or
as tags. Add to that the ability to nest classes (multiple inheritance is
allowed, well\-defined, and encouraged), and you can assemble your
infrastructure from smaller bits, eliminating duplication and exposing all
important parameters to a single location, logically organised. And if that
isn\(aqt enough, \fBreclass\fP lets you reference other parameters in the very
hierarchy you are currently assembling.
.sp
\fBreclass\fP will be used indirectly through adapters most of the time. However,
there exists a command\-line interface that allows querying the database. This
manual page describes this interface.
.SH OPTIONS
.sp
Please see the output of \fBreclass \-\-help\fP for the default values of these
options:
.SS Database options
.INDENT 0.0
.TP
.B \-s\fP,\fB  \-\-storage\-type
The type of storage backend to use
.TP
.B \-b\fP,\fB  \-\-inventory\-base\-uri
The base URI to prepend to nodes and classes
.TP
.B \-u\fP,\fB  \-\-nodes\-uri
The URI to the nodes storage
.TP
.B \-c\fP,\fB  \-\-classes\-uri
The URI to the classes storage
.UNINDENT
.SS Output options
.INDENT 0.0
.TP
.B \-o\fP,\fB  \-\-output
The output format to use (yaml or json)
.TP
.B \-y\fP,\fB  \-\-pretty\-print
Try to make the output prettier
.UNINDENT
.SS Modes
.INDENT 0.0
.TP
.B \-i\fP,\fB  \-\-inventory
Output the entire inventory
.TP
.B \-n\fP,\fB  \-\-nodeinfo
Output information for a specific node
.UNINDENT
.SS Information
.INDENT 0.0
.TP
.B \-h\fP,\fB  \-\-help
Help output
.TP
.B \-\-version
Display version number
.UNINDENT
.SH SEE ALSO
.sp
Please visit \fI\%http://reclass.pantsfullofunix.net/\fP for more information about
\fBreclass\fP\&.
.sp
The documentation is also available from the \fB\&./doc\fP subtree in the source
checkout, or from \fB/usr/share/doc/reclass\-doc\fP\&.
.SH AUTHOR
martin f. krafft
.SH COPYRIGHT
2017, martin f. krafft
.\" Generated by docutils manpage writer.
.