Hilfe und Befehle (CLI)

Weitere Informationen zu Sub-Befehlen, Optionen und Syntax finden Sie in der integrierten Hilfe.

Befehlsstruktur

Die APM CLI verwendet eine mehrteilige Struktur. Jeder Befehl besteht aus:

  • Eine Basis (APM)
  • Eine Aktion, die den auszuführenden Vorgang angibt (z. B.: installieren).

  • Argumente und Optionen, die in beliebiger Reihenfolge angegeben werden können.

    Optionen können in Kurzform (beginnend mit einem einzelnen Strich "-") oder in Langform (beginnend mit einem doppelten Strich "--") angegeben werden. Zum Beispiel: -h, --help oder -c, --client.

    Einige Optionen haben ihre eigenen Argumente, die direkt nach der Option angegeben werden müssen. Zum Beispiel: -c 20 -u UC/UC. Andere Optionen haben kein Argument und funktionieren als Flag. Zum Beispiel: -v, --verbose oder -h, --help.

    Das CLI-Tool kann keine, ein oder mehrere nicht optionale Argumente, die als "Hauptargumente" bezeichnet werden, verarbeiten. Hauptargumente und optionale Argumente (falls vorhanden) können mit doppelten Anführungszeichen (" ") oder einfachen Anführungszeichen (' ') einheitlich eingegeben werden.

Alle APM-Befehle haben folgende Syntax:

apm <Befehl> [Option] [<Argumente>]

Passwörter

Passwörter können mit den folgenden Befehlen angegeben werden: -pw oder --password.

Wichtig! Die Werte werden während der Eingabe nicht in der Kommandozeile angezeigt.

Allgemeine Optionen

Die folgenden Optionen sind für alle APM Befehle verfügbar:

  • -v, --verbose

    Umfangreiche Ausgabe anzeigen

    Standard: false

  • -vv, --very-verbose

    Umfangreiche Ausgabe anzeigen

    Standard: false

  • -y, --yes

    Beantworten Sie alle Fragen mit ja.

    Standard: false

Allgemeine Optionen für Automation Engine Verbindungsbefehle

  • -C <Datei>, <Datei>

    Pfad zu uc4config.xml. Standard: $PM_HOME/conf

  • -L <Datei>, --login-dat <Datei>

    Pfad zu login_dat.xml. Standard: $PM_HOME/conf

  • -T <Vorlage>, --user-template <Vorlage>

    Benutzervorlage, die verwendet wird, um eine Verbindung zur AE einzurichten

  • -S <System>, --system <System>

    AE Systemname. Dieser Befehl überschreibt den Standardwert der Konfigurationsdatei.

  • -H <Host>, --host <Host>

    AE Hostname oder IP-Adresse. Dieser Befehl überschreibt den Standardwert der Konfigurationsdatei.

  • -c <Mandant>, --client <Mandant>

    AE Mandantennummer. Dieser Befehl überschreibt den Standardwert der Konfigurationsdatei.

  • -p <Port>, --port <Port>

    AE Port. Dieser Befehl überschreibt den Standardwert der Konfigurationsdatei.

  • -u <Benutzer/Abteilung>, --user <Benutzer/Abteilung>

    AE Benutzer/Abteilung Dieser Befehl überschreibt den Standardwert der Konfigurationsdatei.

  • -pw [Passwort], --password [Passwort]

    AE-Passwort. Das Passwort ist möglicherweise nicht zwingend in der Kommandozeile erforderlich, das Tool fragt später danach.

  • -l <Sprache>, --language <Sprache>

    AE language. Dieser Befehl überschreibt den Standardwert der Konfigurationsdatei.

  • -f <Ordner>, --folder <Ordner>

    AE -Ordner, der alle installierten Packages enthält. Standard: \PACKAGES

Hilfe zu einem Befehl abrufen

Weitere Informationen zu Befehlen erhalten Sie durch den Aufruf von apm <Befehl> -h oder apm <Befehl> --help.

Weitere Befehle finden

Um eine Liste der verfügbaren Befehle zu erhalten, rufen Sie apm -h oder apm --help auf.

Analyse und Anzeige aktueller Umgebungsprobleme

apm doctor check

Beheben Sie aktuelle Umgebungsprobleme, die vom Doctor Check Command erkannt wurden

apm doctor fix

Hinweis: Erweiterte Packs: Führen Sie diesen Befehl aus, wenn Sie nach fehlenden Hooks und VARA-Objekten von Basis-Packs suchen und diese aktualisieren möchten.

Inhalt des Packs anzeigen

apm show [option] <pack_name>

Dabei kann [Option] eine der folgenden sein:

  • --from-file

    Pack aus lokaler Datei oder Verzeichnis lesen

  • --installed

    Nur installiertes Pack anzeigen.

    Standard: false

  • --local

    Nur Packs im lokalen Cache anzeigen.

    Standard: false