hammer – Administration von Foreman auf der Kommandozeile

Die Administration von Foreman erfolgt normalerweise über die graphische Oberfläche. In den neueren Versionen steht mit hammer ein Kommandozeilenwerkzeug zur Verfügung, mit dem sehr viele Aufgaben ebenfalls umgesetzt werden können.

Die Dokumentation des Kommandos ist leider noch etwas knapp, eine Beschreibung erhält man mit dem Kommando hammer –help.

Die generelle Syntax des Kommandos sieht so aus:

hammer [optionen] unterkommando [parameter] ...

Zu jedem Unterkommando steht mit der Option -h wieder eine Beschreibung zur Verfügung. Dies setzt sich weiter fort. Um die Möglichkeiten des Unterkommandos zum Anlegen eines Benutzers zu sehen wird damit das folgende Kommando verwendet:

hammer user create -h

Da das Kommando hammer für administrative Arbeiten verwendet wird, muss man sich entsprechend authentifizieren. Dazu können die beiden Optionen -u (Benutzername) und -p (Kennwort) übergeben werden. Wichtig ist in diesem Fall die Reihenfolge: Die Optionen zur Authentifizierung müssen vor allen anderen Optionen aufgeführt werden.

Die Liste aller vorhandenen Benutzer erhalten Sie mit dem folgenden Kommando. Die Authentifizierung erfolgt als Benutzer admin mit dem Kennwort linux:

# hammer -u admin -p linux user list
---|----------|--------------|-------------------------
ID | LOGIN    | NAME         | EMAIL
---|----------|--------------|-------------------------
3  | admin    | Admin User   | root@example.com
5  | jexample | John Example | john.example@example.com
4  | tux      | Tux Pinguin  | tux@example.com
---|----------|--------------|-------------------------

Zur Konfiguration des Kommandos hammer kann im Heimatverzeichnis eines Benutzers das Verzeichnis .hammer erstellt werden. In dem Unterverzeichnis cli.modules.d kann die Datei foreman.yml angelegt werden, in der die Konfigurationsparameter eingetragen werden. Im folgenden Beispiel werden der Benutzername (admin) und das Kennwort (linux) für den Aufruf von hammer definiert:

:foreman:
  # Credentials. You'll be asked for the interactively if you leave them blank  # here
  :username: 'admin'
  :password: 'linux'

Da sowohl das Verzeichnis .hammer als auch die Dateien darin nur das Leserecht für den Eigentümer besitzt, ist das Risiko des Kennwortes im Klartext relativ gering. Soll das Kennwort jedesmal abgefragt werden, wird der Eintrag leer gelassen:

:foreman:
  # Credentials. You'll be asked for the interactively if you leave them blank
here
  :username: admin
  :password:

In einem weiteren Artikel zu Foreman erfahren Sie, was mit der Foreman REST API alles möglich ist. Hier geht es weiter:
Was kann man mit der Foreman REST API eigentlich alles machen?