5 1 0: SEP sesam CLI

From SEPsesam
This page is a translated version of the page 5 1 0:SEP sesam CLI and the translation is 100% complete.


Willkommen in der aktuellsten Version der SEP sesam Dokumentation 5.1.0 Apollon. Frühere Versionen der Dokumentation finden Sie hier: Documentation Archiv.


Übersicht


Die SEP sesam CLI Referenz enthält eine Übersicht über die SEP sesam CLI Befehle und deren Verwendung. Die Verwendung von SEP sesam CLI ist versionsabhängig. Wenn Sie eine ältere SEP sesam Version verwenden, siehe SEP sesam CLI in V. Jaglion oder 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.

Anmerkung
Für die Version ≥ Apollon wurden einige Änderungen an der CLI gegenüber der Vorgängerversion vorgenommen. Siehe unten SEP sesam CLI Verwendung für 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 [BASE PARAMETERS] <command> <object> [OPTIONS]

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.
sm_cmd-Basisparameter
BASE PARAMETERS:
       -F [param]     Set output status messages (including error) in JSON format
       -P [param]     Password to connect with (old: -password)
       -S [param]     Server to connect to (old: -s -server)
       -U [param]     User to connect with (old: -user)
       -a [0|1]       Show all hidden parameters (old: -showall)
       -drymode [0|1] dryMode (old: -drymode)
       -f [param]     Read commands from file in this path (old: -path)
       -h [0|1]       Print help (old: -help)
       -p [param]     Port to use (old: -port)
       -t [param]     Connection timeout in seconds (Defaults to 0 [== off]). (old: -timeout)
       -v [param]     The verbose level
       -z [param]     Certificate file used for user authentication (X.509, PEM) (old: -certificate)

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|start|remove> taskevent [OPTIONS...]

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

  sm_cmd start taskevent ID [OPTIONS...]
    Immediately start the given backup task or task group.
    Task (-j) or task group (-G) must be set

       -@ [param]     follow up (command to be run after the event completes)
       -B [date]      start date and time, supported date format is <yyyy-MM-dd hh:mm:ss>
       -G [param]     task group
       -K [0|1]       blocking date
       -M [param]     subsequent migration task
       -R [0|1]       restart flag
       -S [param]     name of the interface
       -Z [param]     time frame after which the scheduled event will be canceled in days and/or hours <hh:mm> (stop task if it runs longer than, e.g. 48:00)
       -d [number]    drive number
       -e [0|1]       enforce full backup if last full backup has failed (if -l is not equal to Full or Copy)
       -j [param]     backup task
       -l [param]     backup level: <C = Copy|F = Full|D = Differential|I = Incremental>
       -m [param]     media pool
       -p [number]    event priority (lowest: 1 (default), highest: 99)
       -s [0|1]       source-side deduplication
       -x [param]     schedule that triggered the task event
       -z [param]     duration of start time frame (e.g. 06:00) which specifies the amount of time in hours for which an event can be in the queue

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 start 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.
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 <remove|start>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 Erstellen und Verwalten von Kalendern.
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|rename|start|remove> command Erstellen und Verwalten von Befehlen.
sm_cmd <get|list|add|modify|start|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|modify|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|upload|show|list> log Überwachen und Herunterladen von Protokolldateien vom Server oder direktes Hochladen der Protokolle auf den SEP Customer Experience 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 list mediaresult Auflistung aller Medienergebnisse, gefiltert nach Listenoptionen.
sm_cmd migrate Sofortstarten einer Migration.
sm_cmd <get|list|add|modify|remove|start> migration Erstellen und Verwalten von Migrationstermine.
sm_cmd <list|restart|cancel> migrationresult Überprüfen, Neustarten oder Abbrechen von Migrationsterminen.
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 <get|list|add|modify|remove|start|cancel> replication Erstellen und Verwalten von Replikationsterminen.
sm_cmd replicate Start einer Replikation, kann als Abkürzung für sm_cmd start replication verwendet werden.
sm_cmd <list|cancel> replicationresult Auflisten und Abbrechen von Replikationsterminen.
sm_cmd <get|list|add|modify|remove> replicationtask Erstellen und Verwalten von Replikationsaufträgen.
sm_cmd <list|restart> Überprüfen und Nachstarten von Sicherungen/Migrationen.
sm_cmd <get|list|add|modify|restore|start|remove|cancel> restore Erstellen und Verwalten von Rücksicherungstermine.
sm_cmd <list|cancel> restoreresult Überprüfen und Abbrechen von Rücksicherungsterminen.
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 remove savesets Löschen der angegebenen Sicherungssätze.
sm_cmd <get|list|add|modify|rename|remove|start> schedule Konfigurieren und Verwalten von Zeitplänen.
sm_cmd stop server Stoppen des SEP sesam Servers. Beachten Sie, dass dieser Befehl nur von der SEP sesam Serverkonsole aus ausgeführt werden kann.
sm_cmd <download|show> services Überwachen und Herunterladen verschiedener Dateien oder Protokolle.
sm_cmd list session Auflisten aller aktiven Sessions.
sm_cmd sql Ausführen einer SQL-Abfrage und definieren des Ausgabeformats.
sm_cmd start <task|restore|migration|command> Starten eines Termins.
sm_cmd start report Erstellen eines benutzerdefinierten Berichts.
sm_cmd <get|list|add|modify|start|remove> task Erstellen und Verwalten von Sicherungsaufträgen.
sm_cmd <get|list|add|modify|backup|remove|restart> taskevent Erstellen und Verwalten von Sicherungsterminen.
sm_cmd add taskgen Erstellen von Aufträgen für einen bestimmten Auftragstypen.
sm_cmd <get|list|add|modify|start|remove> taskgroup Erstellen und Verwalten von Auftragsgruppen.
sm_cmd modify taskgroup {task_group} -j {task}[,{task}] Ändern Sie die Relationen zwischen Auftragsgruppen. Beispiel: sm_cmd modify taskgroup taskgroup1 -j task1,task2
sm_cmd <download|list> update Überwachen und Herunterladen von JAR(.jar)-Aktualisierungen.
sm_cmd <get|list|add|modify|remove|reset> user Erstellen und Verwalten von Benutzern.
sm_cmd show version Anzeige der SEP sesam Server und Client Paketversion.
sm_cmd <resetcbt|check|generate|list> vsphere CBT zurücksetzen, vSphere-Umgebung überwachen und vSphere-Auftragsgruppe erzeugen.


SEP sesam CLI für Apollon: Änderungen

Für die Versionen Apollon und Apollon V2 wurden einige Änderungen an der CLI vorgenommen.

Neue Befehle
  • Eine Sicherung kann gelöscht werden mit remove backup
  • Ein Sicherungssatz kann gelöscht werden mit remove savesets
  • Ein Befehlstermin kann gestartet werden mit start commandevent
  • Ein Befehl kann umbenannt werden mit sm_cmd rename command <alter Name> <Neuer Name>
  • Ein Zeitplan kann umbenannt werden mit sm_cmd rename schedule <alter Name> <Neuer Name>
  • Eine Replikation kann gestartet werden mit replicate, die Abkürzung wurde als Alternative zu start replication hinzugefügt (z.B.: sm_cmd replicate REP_Si3_month_to_SI3_RDS).
  • Protokolle können direkt auf den SEP Customer Experience Server hochgeladen werden mit upload log.
Sicherung
  • Beim Neustart einer Sicherung mit sm_cmd restart -s <Sicherungssatz-ID>, gibt die CLI nun die neue Sicherungssatz-ID anstelle der Sicherungstermin-ID aus.
  • Zusätzlicher Referenztyp -R continue um abgebrochene Sicherungen fortzusetzen.
Client-Administration
  • Clients mit vollständigen Zugriffsdaten können exportiert werden, beim Import werden die Zugriffsdaten wieder erstellt.
  • Zugriffsdaten können exportiert und importiert werden.
Befehle/Befehlstermine
  • Ein Befehlstermin kann nun entweder nach Name oder nach ID gelöscht werden.
  • Neuer Parameter -A (Befehl abbrechen) für add commandevent verfügbar.
Datenspeicher
  • Bei der Konfiguration eines neuen Datenspeichers werden die laufenden Operationen der vorhandenen Datenspeicher nicht mehr beendet. Ein neuer Datenspeicher kann hinzugefügt werden, ohne dass alle Laufwerkswarteschlangen neu initialisiert werden müssen.
  • Bei der Erstellung eines neuen Datenspeichers wird nun zusätzlich zum Datenspeichernamen die Laufwerksnummer des ersten Laufwerks des Datenspeichers ausgegeben.
  • Beim Hinzufügen oder Ändern eines Datenspeichers können die Datenspeicheroptionen nun mit -A "<options>" gesetzt werden.
  • Beim Hinzufügen eines neuen Datenspeichers werden standardmäßig zwei Laufwerke mit dem Datenspeicher erstellt. Der Parameter -D 0 verhindert die Erstellung des zweiten Laufwerks.
  • Beim Löschen (remove) eines Datenspeichers ist eine neue Option -F <n> verfügbar, mit der nur die Metadaten des Datenspeichers (-F 0) oder die Metadaten und Sicherungsdateien des Datenspeichers (-F 1) gelöscht werden können. Beachten Sie, dass -F 1 die Standardeinstellung ist und der Datenspeicher ohne Angabe des Parameters mit allen Metadaten und Sicherungsdateien gelöscht wird.
  • Bei Datenspeichern wurde die Option -o (für den Befehl sm_config_drive) von Boolean in einen numerischen Wert geändert:
   -o 0: do not start sm_config_drives at all
   -o 1: start sm_config_drives <dn> CREATE-DS
   -o 2: start sm_config_drives <dn>
   -o 3: start sm_config_drives
Schnittstellen
  • Neuer Parameter -c (Client) für den Befehl list interface
  • Neuer Parameter -i (Reihenfolge der Schnittstellen) für den Befehl add interface
  • Neuer Befehl modify interface mit Parameter -i (Reihenfolge der Schnittstellen) und -n (neuer Name bei einer Umbenennung der Schnittstelle)
Medienpools
  • Neuer Parameter -v für die Befehle add mediapool und modify mediapool, der den Ersatzmedienpool festlegt.
Migrationen
  • Entfernung des Parameters -e (Sicherungsstatus) aus den Befehlen add migration und modify migration, da er im Migrationsauftrag gesetzt werden sollte.
Replikation
  • Neuer Parameter -s um einen einzelnen Sicherungssatz zu replizieren (start replication/replicate), zum Beispiel: sm_cmd replicate -s SC20220728132336417@xnlwBh7mGUh -M MP_Si3_RDS
  • Neuer Parameter -m um den Quellmedienpool anzugeben, zum Beispiel: m_cmd replicate -m MP_Si3_month -M MP_Si3_RDS
Rücksicherung
  • Beim Start einer Rücksicherung kann die gewünschte Sicherungsmethode (-y) im Rücksicherungsbefehl angegeben werden, zum Beispiel: sm_cmd restore -j <task name> -y C.
  • Die Sicherungssatz-ID einer migrierten Sicherung kann angegeben werden mit sm_cmd restore -s <Sicherungssatz-ID der migrierten Sicherung>.
  • Geänderte Parameter für start restore/restore:
    • Parameter B (relatives Startdatum) wurde umbenannt in I
    • Parameter E (relatives Enddatum) wurde umbenannt in J
    • Parameter K wurde entfernt, da er nicht mehr verwendet wird
Zeitpläne
  • Alle Parameter aus dem Befehl start schedule entfernt, außer -p (Priorität) and -s (Startzeit), da sie für den Start aller Termine eines Zeitplans nicht benötigt werden.
  • Parameter start date (Startdatum), end date (Enddatum) und start time (Startzeit) müssen im gültigen Datums-/Zeitformat angegeben werden, andernfalls wird ein Fehler ausgegeben.
Sicherungstermin
  • Neuer Parameter -v für die Befehle add task event und modify task event um einen Ersatzsicherungstermin zu setzen.
  • Parameter -Z (lifetime) entfernt für add task event und modify task event.
Allgemein
  • Wenn der SEP sesam REST Server HTTPS mit einem echten Zertifikat (nicht selbstsigniert) ausführt, kann die CLI das SSL-Zertifikat während des SSL-Verbindungs-Handshake verifizieren. Ein Parameter -Z <absoluter Pfad zum CA-Schlüssel> wurde hinzugefügt, um den CA-Verifizierungsschlüssel zu übergeben. Alternativ kann der CA-Verifizierungsschlüssel auch zum Java Global Key Store hinzugefügt werden.
  • MODIFY erzeugt einen neuen Standard, wenn noch kein Standard mit dem angegebenen Schlüssel existiert.


Siehe auch

SBC CLIHilfreiche SEP sesam BefehleSEP sesam GUI

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.