.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "FOREMANCLI" "1" "July 2012" "ff" ""
.
.SH "NAME"
\fBforemancli\fR \- comandline search interface to Foreman
.
.SH "SYNOPSIS"
\fBforemancli\fR \fIoptions\fR
.
.SH "DESCRIPTION"
Query Foreman server for stored node information\.
.
.SH "OPTIONS"
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Output more information
.
.TP
\fB\-u\fR, \fB\-\-user\fR \fIUSER\fR
Foreman user\. Instead of providing the user via the command\-line you can also set the \fBFOREMAN_USER\fR environment variable\. The user specified via the command\-line takes precedence over the environment variable\.
.
.TP
\fB\-p\fR, \fB\-\-pass\fR \fIPASSWORD\fR
Foreman password\. Instead of providing the password via the command\-line you can also set the \fBFOREMAN_PASSWORD\fR environment variable\. The password specified via the command\-line takes precedence over the environment variable\.
.
.TP
\fB\-s\fR, \fB\-\-server\fR \fIURL\fR
Foreman Server URL\. Instead of providing the URL via the command\-line you can also set \fBFOREMAN_SERVER\fR environment variable\. The url specified via the command\-line takes precedence over the environment variable\.
.
.TP
\fB\-\-json\fR
JSON output
.
.TP
\fB\-\-yaml\fR
YAML output
.
.TP
\fB\-\-status\fR
Foreman status
.
.TP
\fB\-\-custom\fR \fICOLLECTION\fR
Custom COLLECTION string, see: http://theforeman\.org/projects/foreman/wiki/API for more information
.
.TP
\fB\-\-architectures\fR \fIfilter\fR
Retrieve a list of architectures
.
.TP
\fB\-\-common_parameters\fR \fIfilter\fR
Retrieve a list of common_parameters
.
.TP
\fB\-\-config_templates\fR \fIfilter\fR
Retrieve a list of config_templates
.
.TP
\fB\-\-domains\fR \fIfilter\fR
Retrieve a list of domains
.
.TP
\fB\-\-environments\fR \fIfilter\fR
Retrieve a list of environments
.
.TP
\fB\-\-fact_values\fR \fIfilter\fR
Retrieve a list of fact_values
.
.TP
\fB\-\-hosts\fR \fIfilter\fR
Retrieve a list of hosts
.
.TP
\fB\-\-hostgroups\fR \fIfilter\fR
Retrieve a list of hostgroups
.
.TP
\fB\-\-media\fR \fIfilter\fR
Retrieve a list of media
.
.TP
\fB\-\-puppetclasses\fR \fIfilter\fR
Retrieve a list of puppetclasses
.
.TP
\fB\-\-reports\fR \fIfilter\fR
Retrieve a list of reports
.
.TP
\fB\-\-roles\fR \fIfilter\fR
Retrieve a list of roles
.
.TP
\fB\-\-settings\fR \fIfilter\fR
Retrieve a list of settings
.
.TP
\fB\-\-lookup_keys\fR \fIfilter\fR
Retrieve a list of lookup_keys
.
.TP
\fB\-\-dashboard\fR \fIfilter\fR
Retrieve a list of dashboard
.
.TP
\fB\-\-operatingsystems\fR \fIfilter\fR
Retrieve a list of operatingsystems
.
.TP
\fB\-\-subnets\fR \fIfilter\fR
Retrieve a list of subnets
.
.TP
\fB\-\-ptables\fR \fIfilter\fR
Retrieve a list of ptables
.
.TP
\fB\-\-users\fR \fIfilter\fR
Retrieve a list of users
.
.TP
\fB\-\-auth_source_ldaps\fR
Retrieve a list of auth_source_ldaps
.
.TP
\fB\-\-hypervisors\fR
Retrieve a list of hypervisors
.
.TP
\fB\-\-lookup_values\fR
Retrieve a list of lookup_values
.
.TP
\fB\-\-smart_proxies\fR
Retrieve a list of smart_proxies
.
.TP
\fB\-\-statistics\fR
Retrieve a list of statistics
.
.TP
\fB\-\-usergroups\fR
Retrieve a list of usergroups
.
.TP
\fB\-\-audits\fR
Not implemented
.
.TP
\fB\-\-bookmarks\fR
Not implemented
.
.TP
\fB\-h\fR, \fB\-\-help\fR
Show help message
.
.SH "ENVIRONMENT"
Instead of specifying server credentials on the command\-line you can specify following environment variables:
.
.TP
\fBFOREMAN_SERVER\fR
Foreman Server URL
.
.TP
\fBFOREMAN_USER\fR
Foreman user
.
.TP
\fBFOREMAN_PASSWORD\fR
Foreman password
.
.P
The options specified on the command\-line take precedence over \fBENVIRONMENT VARIABLES\fR\.
.
.SH "FILTERS"
Please see http://theforeman\.org/projects/foreman/wiki/Search_API for more information
.
.SH "Examples"
foremancli \-\-hosts "domain = domain\.com AND class = squid"
.
.P
foremancli \-\-hosts "domain = domain\.com AND facts\.architecture = x86_64 AND class = module::class\-\-classes name = squid"`
.
.P
foremancli \-\-domains "name = domain\.com"