---
name: "foremancli"
section: "1"
platform: "linux"
package: "foremancli"
version: "1.0-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/foremancli"
---

# foremancli(1)

comandline search interface to Foreman

## NAME

**foremancli** - comandline search interface to Foreman

## SYNOPSIS

**foremancli** *options*

## DESCRIPTION

Query Foreman server for stored node information.

## OPTIONS

- **-d**, **--debug**

  Output more information

- **-u**, **--user** *USER*

  Foreman user. Instead of providing the user via the command-line you can also set the **FOREMAN\_USER** environment variable. The user specified via the command-line takes precedence over the environment variable.

- **-p**, **--pass** *PASSWORD*

  Foreman password. Instead of providing the password via the command-line you can also set the **FOREMAN\_PASSWORD** environment variable. The password specified via the command-line takes precedence over the environment variable.

- **-s**, **--server** *URL*

  Foreman Server URL. Instead of providing the URL via the command-line you can also set **FOREMAN\_SERVER** environment variable. The url specified via the command-line takes precedence over the environment variable.

- **--json**

  JSON output

- **--yaml**

  YAML output

- **--status**

  Foreman status

- **--custom** *COLLECTION*

  Custom COLLECTION string, see: http://theforeman.org/projects/foreman/wiki/API for more information

- **--architectures** *filter*

  Retrieve a list of architectures

- **--common\_parameters** *filter*

  Retrieve a list of common\_parameters

- **--config\_templates** *filter*

  Retrieve a list of config\_templates

- **--domains** *filter*

  Retrieve a list of domains

- **--environments** *filter*

  Retrieve a list of environments

- **--fact\_values** *filter*

  Retrieve a list of fact\_values

- **--hosts** *filter*

  Retrieve a list of hosts

- **--hostgroups** *filter*

  Retrieve a list of hostgroups

- **--media** *filter*

  Retrieve a list of media

- **--puppetclasses** *filter*

  Retrieve a list of puppetclasses

- **--reports** *filter*

  Retrieve a list of reports

- **--roles** *filter*

  Retrieve a list of roles

- **--settings** *filter*

  Retrieve a list of settings

- **--lookup\_keys** *filter*

  Retrieve a list of lookup\_keys

- **--dashboard** *filter*

  Retrieve a list of dashboard

- **--operatingsystems** *filter*

  Retrieve a list of operatingsystems

- **--subnets** *filter*

  Retrieve a list of subnets

- **--ptables** *filter*

  Retrieve a list of ptables

- **--users** *filter*

  Retrieve a list of users

- **--auth\_source\_ldaps**

  Retrieve a list of auth\_source\_ldaps

- **--hypervisors**

  Retrieve a list of hypervisors

- **--lookup\_values**

  Retrieve a list of lookup\_values

- **--smart\_proxies**

  Retrieve a list of smart\_proxies

- **--statistics**

  Retrieve a list of statistics

- **--usergroups**

  Retrieve a list of usergroups

- **--audits**

  Not implemented

- **--bookmarks**

  Not implemented

- **-h**, **--help**

  Show help message

## ENVIRONMENT

Instead of specifying server credentials on the command-line you can specify following environment variables:

- **FOREMAN\_SERVER**

  Foreman Server URL

- **FOREMAN\_USER**

  Foreman user

- **FOREMAN\_PASSWORD**

  Foreman password

The options specified on the command-line take precedence over **ENVIRONMENT VARIABLES**.

## FILTERS

Please see http://theforeman.org/projects/foreman/wiki/Search\_API for more information

## Examples

foremancli --hosts "domain = domain.com AND class = squid"

foremancli --hosts "domain = domain.com AND facts.architecture = x86\_64 AND class = module::class--classes name = squid"\`

foremancli --domains "name = domain.com"