Source: SEP sesam CLI

From SEPsesam
Revision as of 11:49, 12 August 2022 by Sta (talk | contribs) (Created page with "Starten eines Termins.")
Other languages:
Draft.png WORK IN PROGRESS
This article is in the initial stage and may be updated, replaced or deleted at any time. It is inappropriate to use this document as reference material as it is a work in progress and should be treated as such.

Copyright © SEP AG 1999-2024. Alle Rechte vorbehalten.

Jede Form der Reproduktion der Inhalte dieses Benutzerhandbuches, ganz oder in Teilen, ist nur mit der ausdrücklichen schriftlichen Erlaubnis der SEP AG gestattet. Bei der Erstellung dieses Benutzerhandbuches wurde mit größtmöglicher Sorgfalt gearbeitet, um korrekte und fehlerfreie Informationen bereit stellen zu können. Trotzdem kann die SEP AG keine Gewähr für die Richtigkeit der Inhalte dieses Benutzerhandbuches übernehmen.

Docs latest icon.png Willkommen in der aktuellsten Version der SEP sesam Dokumentation 5.0.0 Jaglion. Frühere Versionen der Dokumentation finden Sie hier: SEP sesam CLI V. Beefalo.


Übersicht

The SEP sesam CLI reference contains an overview of the SEP sesam CLI commands and their usage. The use of SEP sesam CLI is version dependent. If you are using an older SEP sesam version, see SEP sesam CLI in v. Beefalo.

Das SEP sesam Command Line Interface (CLI) ist ein Dienstprogramm, das einen alternativen Weg zur Ausführung von SEP sesam Befehlen in UNIX und Windows Umgebungen bietet. Die SEP sesam Kommandozeilen-Schnittstelle bietet zwei CLI-Komponenten: das Administrationsprogramm SEP sesam CLI und das Client-Programm SBC CLI. Letzteres wird zum Sichern und Rücksichern von Daten lokal auf dem Host verwendet.

Das SEP sesam CLI Administrationsprogramm bietet alle Funktionen, die über die grafische SEP sesam Managementoberfläche verfügbar sind, sowie zusätzliche CLI-Befehle, die in der GUI nicht verfügbar sind. Beachten Sie, dass je nach SEP sesam Lizenz unterschiedliche Befehle verfügbar sein können.

SEP sesam CLI-Befehle können verwendet werden, um eine SEP sesam Umgebung automatisch ohne GUI zu installieren und zu konfigurieren. Sie ermöglicht es Administratoren, auf die SEP sesam Datenbank zuzugreifen und die gesamte SEP sesam Umgebung zu verwalten, z.B. um SEP sesam Server und Clients zentral ohne GUI zu installieren, konfigurieren und zu verwalten. Jeder CLI-Befehl (außer einer native SQL-Anweisung) prüft und befolgt die interne Struktur und Abhängigkeiten der SEP sesam Datenbank.

Information sign.png Anmerkung
Some changes have been made to CLI for version ≥ Jaglion compared to the previous version. See below SEP sesam CLI usage for details.

Funktionen

  • Automatische Konfiguration von SEP sesam Umgebungen nach der Installation (z.B. bei der Implementierung)
  • Ändern der SEP sesam Konfiguration ohne Verwendung der SEP sesam GUI
  • Skriptbasierte Mehrfachinstallation und Konfiguration (z. B. Provider-Umgebung)
  • Durchführung von Tests zur Installation und Konfiguration in SEP sesam Umgebungen
  • SEP sesam Status, Log- und Versionsinformationen abrufen
  • Ermitteln von SEP sesam Objektinformationen zur weiteren Verwendung in anderen Programmen

Ausführen von CLI-Befehlen

Sie müssen SEP sesam Administratorrechte haben, um SEP sesam CLI-Befehle ausführen und die Eingabeaufforderung als Administrator verwenden zu können. Alle Befehle werden aus dem Verzeichnis <SESAM_ROOT>/bin/sesam/ ausgeführt. Wenn Sie SEP sesam Befehle global (und nicht aus dem eigentlichen run-Verzeichnis) ausführen möchten, setzen Sie das SEP sesam Profil wie in Wie setze ich ein Profil? beschrieben.

Verstehen der Befehlsstruktur

Die allgemeine SEP sesam Syntax für einen CLI-Befehl ist:

sm_cmd <command> [–option] [<object>] [[–<parameter>] <value>]

wobei für jeden Befehl folgende Informationen angegeben werden

  • sm_cmd: Aufruf der CLI-Schnittstelle.
  • Usage: Die Verwendung bzw. die eigentliche Syntax des Befehls, einschließlich der Argumente.
  • Beschreibung: Eine kurze Zusammenfassung, was der Befehl bewirkt.
  • Options: Die Definition der im Befehl verwendeten Optionen.
  • Example: Beispiel für die Befehlsverwendung des angegebenen Befehls und seiner Optionen.

Befehlskonventionen

Die Parameter für einen Befehl sind von der Reihenfolge abhängig und können erforderliche und optionale Werte oder Schlüsselwortauswahl enthalten, je nachdem, wie die Informationen eingeklammert sind. Erforderliche Parameter sind mit einem Sternchen (*) gekennzeichnet. Im Folgenden finden Sie ein Beispiel.

| vertikaler Balken
Trennt die Auswahl zwischen zwei oder mehr Optionen oder Argumenten.
[ ] eckige Klammern
Geben optionale Werte an.
< > spitze Klammern
Zeigen an, dass das eingeschlossene Element obligatorisch ist.
Beispiel:
sm_cmd <get|list|add|modify|backup|remove|restart> taskevent [OPTIONS...]

Eine der mit < >-Symbolen eingeklammerten Aktionen muss angegeben werden, in diesem Fall <get|list|add|modify|backup|remove|restart>, während mit [ ]-Symbolen umschlossene [OPTIONEN...] optional angegeben werden können. Die folgenden Optionen sind für unseren Beispielbefehl taskevent verfügbar.

OPTIONS:
    -@ [param]     follow up (command to be run after the event completes)
    -G [ID]        task group
    -S [ID]        name of the interface
    -Z [number]    stop task if it runs longer than (e.g. 8:00 means that the task is automatically stopped after 8 hours)
    -d [ID]        drive number
    -j [ID]        backup task
    -l [param]     backup level (C = Copy, F = Full, D = Differential, I = Incremental)
    -m [ID]        media pool
    -s [0|1]       source-side deduplication

Angenommen, wir möchten ein Sicherungstermin für einen Sicherungsauftrag mit dem Namen win-cli_c_drive ausführen und den Zielmedienpool (auf den die Daten gesichert werden) MP_disk_week verwenden. Der Befehl würde wie folgt aussehen:

sm_cmd backup taskevent -j win-cli_c_drive -m MP_disk_week

Hilfe anfordern

Um alle verfügbaren Optionen aufzulisten, verwenden Sie die Haupthilfe sm_cmd help. Um Hilfe für ein bestimmtes Objekt anzuzeigen, verwenden Sie sm_cmd help <object>, zum Beispiel sm_cmd help client. Die Hilfe ist nur in Englisch verfügbar.

Häufige Aktionsbefehle

Der Aktionsbefehl wird verwendet, um eine Aktion auszuführen oder Informationen/Status über die Ressource abzurufen. Die meisten SEP sesam CLI-Ressourcen haben die folgenden Aktionsbefehle:

get
Der Befehl get ruft Informationen über die Ressource oder den Vorgang ab, die/der aktuell definiert ist.
list
Der Befehl list gibt eine Liste von Objekten für die angegebene Ressource zurück. Wenn das optionale <Objektname oder ID> ebenfalls angegeben wird, werden die Ergebnisse nach diesem Wert gefiltert.
add
Der Befehl add erzeugt ein neues Objekt oder Termin. Wird zusätzlich der optionale <Objektname oder ID> angegeben, dann werden die Objekte entsprechend dem angegebenen Wert angelegt.
modify
Der Befehl modify ändert eine vorhandene Ressource auf Basis der angegebenen Objektoptionen.
remove
Der Befehl remove löscht das angegebene Objekt.

Bevor Sie beginnen

SEP sesam CLI ist ein sehr mächtiges Kommandozeilenwerkzeug. Sie sollten sich seiner Auswirkungen auf Ihre gesamte Umgebung bewusst sein, bevor Sie es einsetzen.

Empfehlungen zur Verwendung der SEP sesam CLI

  • Die optionalen Kommandozeilenbefehle von SEP sesam verändern direkt die SEP sesam Datenbank. Daher sollten alle Kommandozeileneinträge überprüft und verifiziert werden!
  • SEP sesam führt die Befehle sofort nach dem Drücken der <Enter>/<Return>-Taste aus, d.h. Eingaben können nicht korrigiert werden, wie es bei der SEP sesam GUI der Fall ist. Es ist äußerst wichtig, dass Sie mit der CLI vertraut sind und diese mit Bedacht einsetzen, um keinen Systemausfall der Sicherungsumgebung zu verursachen. Beachten Sie, dass eine fehlerhafte Eingabe zu vollständigem Datenverlust oder anderen Schäden an der Datenbank führen kann. Solche Fehler können zum Erlöschen der Garantie Ihres SEP sesam-Lizenzvertrages führen.
Information sign.png Anmerkung
Bevor Sie mit dem Skripting für die SEP sesam CLI beginnen, sollten Sie sich mit der SEP sesam Umgebung vertraut machen. Lesen Sie die SEP sesam Dokumentation sorgfältig durch und arbeiten Sie an der SEP sesam Installation und Konfiguration, um zu verstehen, wie die SEP sesam Objekte zusammenarbeiten.

===SEP sesam CLI Verwendung===

Befehl Beschreibung
sm_cmd <get|list|add|modify|remove|send> account Erstellen und Verwalten von E-Mail-Konten.
sm_cmd <get|list|remove|check> acl Zugriffskontrolllisten (ACL) anzeigen oder löschen.
sm_cmd list allevent Alle SEP sesam Termine auflisten.
sm_cmd list allresult Alle Ergebnisse innerhalb des angegebenen Zeitraums auflisten.
sm_cmd backup Starten eines Sicherungsauftrags oder der Sicherungen einer Auftragsgruppe.
sm_cmd clear cache Löschen des gesamten Server-Cache.
sm_cmd <get|list|add|modify|remove> calendar Create and administer calendars.
sm_cmd <get|list|add|modify|remove> calendarevent Erstellen und Verwalten Sie Kalendertermine.
sm_cmd <download|show> calendarsheet Anzeigen oder Herunterladen von Kalenderinformationen.
sm_cmd <get|list|add|modify|remove|dir> client Erstellen und Verwalten von Clients.
sm_cmd <get|list|add|modify|start|remove> command Erstellen und Verwalten von Befehlen.
sm_cmd <get|list|add|modify|remove> commandevent Erstellen und Verwalten von Kalendertermine.
sm_cmd <get|list|add|modify|enable|disable|link|unlink|remove> credential Konfigurieren und Verwalten von Berechtigungsdaten.
sm_cmd <download|show> current Anzeigen und Herunterladen der aktuellen Laufwerksinformationen.
sm_cmd <get|list|add|modify|remove> datastore Erstellen und Verwalten von Datenspeichern.
sm_cmd <get|list|add|modify|remove> default Konfigurieren und Verwalten von Vorbelegungen.
sm_cmd dir <argument> Auflistung aller angegebenen Clients, Elemente, VMs, etc.
sm_cmd <get|list|add|modify|remove|start|mount|dismount|unload> drive Erstellen und Verwalten von Laufwerken.
sm_cmd <get|list|add|modify|remove> drivegroup Erstellen und Verwalten von Laufwerksgruppen.
sm_cmd <get|list|add|modify|remove> group Erstellen und Verwalten von Benutzergruppen.
sm_cmd <get|list|add|remove> interface Erstellen und Verwalten von Schnittstellen.
sm_cmd start inventory Starten des Archivabgleichs.
sm_cmd <show|update|report> license Prüfen der SEP sesam Lizenzinformationen und Aktualisieren der Lizenz.
sm_cmd <get|list|add|modify|remove|load|unload|import|export> loader Erstellen und Verwalten der Lader.
sm_cmd <get|list|add|modify|remove> loaderdevice Erstellen und Verwalten Sie Ladergeräten.
sm_cmd <get|list|add|modify|remove> location Erstellen und Verwalten von Standorten.
sm_cmd <download|show|list> log Überwachen und Herunterladen von Protokolldateien vom Server.
sm_cmd <get|list|add|modify|remove> media Erstellen und Verwalten der Speicher-Medien.
sm_cmd <get|list|add|modify|remove> mediapool Erstellen und Verwalten von Medienpools.
sm_cmd <get|list|add|modify|start|init|remove> mediapoolevent Erstellen und Verwalten von Medienterminen.
sm_cmd migrate Sofortstarten einer Migration.
sm_cmd <get|list|add|modify|remove|start> migration Erstellen und Verwalten von Migrationstermine.
sm_cmd <get|list|add|modify|remove> migrationtask Erstellen und Verwalten von Migrationsaufträgen.
sm_cmd <get|list|add|modify|start|remove> newdayevent Erstellen und Verwalten von Tageswechselterminen.
sm_cmd <get|list|add|modify> notification Erstellen und Ändern von Meldungen.
sm_cmd <get|list> opersystem Auflisten eines bestimmten Betriebssystems oder aller Betriebssysteme.
sm_cmd render Rendern der angegebenen Vorlage.
sm_cmd <list|restart> Überprüfen und Nachstarten von Sicherungen/Migrationen.
sm_cmd <get|list|add|modify|restore|start|remove> restoreevent Erstellen und Verwalten von Rücksicherungstermine.
sm_cmd <get|list|add|modify|start|remove> restoretask Erstellen und Verwalten von Rücksicherungsaufträgen.
sm_cmd <get|list> result Überwachen Sie die Ergebnisse nach eingestellten Filtern (z.B. Clients, Aufträge).
sm_cmd <dir> saveset Durchsuchen eines Sicherungssatzes.
sm_cmd <get|list|add|modify|rename|remove|start> schedule Konfigurieren und Verwalten von Zeitplänen.
sm_cmd <download|show> services Überwachen und Herunterladen verschiedener Dateien oder Protokolle.
sm_cmd list session Auflisten aller aktiven Sessions.
sm_cmd start <task|restore|migration|command> Starten eines Termins.
sm_cmd start report Create a customized report.
sm_cmd <get|list|add|modify|start|remove> task Create and administer tasks.
sm_cmd <get|list|add|modify|backup|remove|restart> taskevent Create and administer task events.
sm_cmd add taskgen Generate tasks according to the specified task type.
sm_cmd <get|list|add|modify|start|remove> taskgroup Create and administer task groups.
Removed object, use modify taskgroup instead! sm_cmd <get|list|add|modify|remove> taskgrouprelation Create and administer task group relations.
sm_cmd modify taskgroup {task_group} -j {task}[,{task}] Modify task group relations. Example: sm_cmd modify taskgroup taskgroup1 -j task1,task2
sm_cmd <download|list> update Monitor and download JAR (.jar) updates.
sm_cmd <get|list|add|modify|remove|reset> user Create and administer users.
sm_cmd show version Display the SEP sesam Server and Client package version.
sm_cmd <resetcbt|check|generate|list> vsphere Reset CBT, monitor vSphere environment and generate vSphere task group.

SEP sesam CLI for Jaglion: changes

Some changes were made in the CLI for the Jaglion version.

Obsolete
The object taskgrouprelation has been removed. Use sm_cmd modify taskgroup {task_group} -j {task}[,{task}] instead. Example: sm_cmd modify taskgroup taskgroup1 -j task1,task2
New objects
Migrationresults, Replication, Replicationresult, Replicationtask, Restoreresult, SQL.

See also

SBC CLIUseful SEP sesam CommandsSEP sesam GUI