Launcher Produkte Bitnami Dokumentationimaxe CLI Blog Kontakt
imaxe.cloud/ imaxe CLI/ Module/ info
imaxe info inventar v1.0.0

Das Inventar deines Servers auf einen Blick

Sondiert die Maschine und schreibt ein lesbares Inventar mit dem Betriebssystem, der installierten Software und ihren Versionen, der Datenbank und dem imaxe-Produkt nach /etc/imaxe/info.yaml. Ohne Geheimnisse, ohne Überraschungen: ein Befehl und du weißt genau, was du hast.

$ imaxe info create
Version
v1.0.0
Unterbefehle
3
Inventar
/etc/imaxe/info.yaml
Erfordert root
ja (create)
Geheimnisse
niemals

Was dieses Modul tut #

Wenn du eine imaxe-AMI startest, ist die erste Frage oft die grundlegendste: Was steckt drin? Welche Version des Betriebssystems, welche Software ist installiert und in welcher Version, welche Datenbank steckt dahinter und welches imaxe-Produkt wurde ausgerollt.

Das Modul info beantwortet das in einem Zug: es sondiert das laufende System und schreibt ein klares, lesbares Inventar nach /etc/imaxe/info.yaml. Diese Datei fasst das Betriebssystem, die Software und ihre Versionen, die Datenbank und das imaxe-Produkt zusammen, bereit zur Anzeige am Bildschirm oder als JSON zur Automatisierung.

Das Inventar enthält keine Geheimnisse

Die Datei /etc/imaxe/info.yaml ist rein beschreibend: Namen und Versionen. Sie speichert niemals Passwörter, Schlüssel oder Tokens, sodass du sie bedenkenlos lesen, kopieren oder an ein Ticket anhängen kannst.

SchnellstartAufgaben Schritt für Schritt

Häufige Aufgaben #

Wähle, was du tun möchtest. Jedes Rezept bringt den Befehl schon fertig mit — einfach kopieren und Kopieren drücken.

Inventar erzeugen Sehen, was installiert ist Inventar als JSON abrufen Nach einer Änderung neu erzeugen
1

Inventar erzeugen

Sondiert die Maschine und schreibt /etc/imaxe/info.yaml zum ersten Mal.

Verbinde dich per SSH mit deinem Server über den Benutzer ubuntu.

Starte create: es durchläuft das System und schreibt das Inventar auf die Festplatte.

Terminal
$ sudo imaxe info create
Die Datei /etc/imaxe/info.yaml wird mit dem Betriebssystem, der Software und ihren Versionen, der Datenbank und dem imaxe-Produkt geschrieben.
2

Sehen, was installiert ist

Zeigt das bereits erzeugte Inventar am Bildschirm an.

Sieh dir das in /etc/imaxe/info.yaml gespeicherte Inventar an:

Terminal
$ imaxe info show
Du siehst am Bildschirm das Betriebssystem, die Software mit ihrer Version, die Datenbank und das imaxe-Produkt. Falls das Inventar noch nicht existiert, erzeuge es mit dem vorherigen Rezept.
3

Inventar als JSON abrufen

Strukturierte Ausgabe für Skripte, Monitoring oder zentrales Inventar.

Füge --json zu show hinzu, um das Inventar in maschinenlesbarem Format zu erhalten:

Terminal
$ imaxe info show --json

Möchtest du nur einen einzelnen Wert extrahieren? Kombiniere es mit jq, zum Beispiel die Version des Betriebssystems:

Terminal
$ imaxe info show --json | jq .os
Das JSON kommt über stdout heraus, bereit zur Weiterleitung an jq, einen Inventar-Agenten oder deine CMDB.
4

Nach einer Änderung neu erzeugen

Aktualisiert das Inventar nach dem Installieren oder Aktualisieren von Software.

Das Inventar ist eine Momentaufnahme des Systems zum Zeitpunkt der Erzeugung. Wenn du Pakete aktualisiert oder die Datenbank gewechselt hast, starte create erneut, um es mit frischen Daten neu zu schreiben:

Terminal
$ sudo imaxe info create
$ imaxe info show
Die Datei /etc/imaxe/info.yaml spiegelt wieder den tatsächlichen Zustand der Maschine wider.
Das Inventar ist eine Momentaufnahme, kein Wächter

Die Datei spiegelt das System so wider, wie es beim Ausführen von create war. Sie aktualisiert sich nicht von selbst: starte nach jeder wichtigen Änderung an der Software create erneut, damit show weiterhin der Realität entspricht.

CLI-ReferenzBefehle, Flags und Dateien

Synopsis #

Verwendung
imaxe info <subcomando> [--json]

Der Unterbefehl create erfordert root-Rechte (nutze sudo), da er nach /etc/imaxe/ schreibt. show hingegen liest nur das Inventar und kann ohne sudo ausgeführt werden. Füge --json zu show hinzu, um maschinenlesbare Ausgabe zu erhalten, geeignet für Scripting.

Unterbefehle #

UnterbefehlWas er tutRelevante Flags
createSondiert das laufende System und (über)schreibt das Inventar nach /etc/imaxe/info.yaml.—
showZeigt das in /etc/imaxe/info.yaml gespeicherte Inventar an.--json
helpZeigt die Hilfe des Moduls an.—

Argumente und Flags #

FlagTypStandardBeschreibung
--jsonboolfalseBei show gibt das Inventar als strukturiertes JSON über stdout aus, geeignet für jq und Automatisierung.

Das Modul info nimmt keine Positionsargumente: jeder Unterbefehl arbeitet mit dem Inventar des eigenen Systems.

Dateien und Pfade #

PfadInhalt
/etc/imaxe/info.yamlInventar der AMI: Betriebssystem, Software und Versionen, Datenbank und imaxe-Produkt. Rein beschreibend, ohne Geheimnisse.

Beispiel für info.yaml:

/etc/imaxe/info.yaml
os:
  name: Ubuntu
  version: 22.04
software:
  nginx: 1.18.0
  php: 8.1
database:
  engine: mysql
  version: 8.0.36
product:
  name: imaxe
  version: 1.0.0

Exit-Codes und Logs #

Jede Ausführung liefert einen Code, den du mit echo $? prüfen kannst — nützlich zum Verketten in Skripten:

0OKInventar korrekt erzeugt oder angezeigt.
1ERRNicht klassifizierter allgemeiner Fehler. Prüfe die Meldung.
2USAGEUngültiger Unterbefehl oder Flag.
3NOFILEshow ohne Inventar: führe zuerst create aus.
4PERMcreate ohne Rechte zum Schreiben in /etc/imaxe/.

Fehlerbehebung #

SymptomWahrscheinliche UrsacheLösung
show zeigt nichts an oder schlägt fehlDas Inventar wurde noch nicht erzeugt.Führe sudo imaxe info create aus und versuche show erneut.
create meldet einen RechtefehlerEs wurde ohne root gestartet und kann nicht in /etc/imaxe/ schreiben.Starte es erneut mit sudo imaxe info create.
Das Inventar passt nicht zur RealitätSoftware wurde nach dem Erzeugen installiert oder aktualisiert.Erzeuge es neu mit sudo imaxe info create: es ist eine Momentaufnahme.
Das --json kommt nicht sauber heraus--json wurde auf einen Unterbefehl angewendet, der es nicht unterstützt.--json gilt nur für show; nutze es als imaxe info show --json.

Steckst du beim Modul Inventar fest?

Schreib uns mit der Ausgabe von «imaxe <module> status --json» und wir antworten dir schnell.

Support kontaktieren