ServiceManager - Kommandozeilenprogramm (CLI)

Das Kommandozeilenprogramm (UCYBSMCL) ermöglicht es Ihnen, Ihre Dienste über die Stapelverarbeitung zu verwalten. Diese Option ist nur für Windows und UNIX verfügbar.

Übersicht

Sie können Dienste starten und beenden sowie eine Liste an Diensten eines Computers in einer ServiceManager-Umgebung aufrufen.

Hinweis: Das CLI-Programm unterscheidet zwischen Groß- und Kleinschreibung.

Alle Dienste, die zur ServiceManager-Umgebung gehören, können mit einem Passwort geschützt werden, wodurch Dienste vor dem Starten, Beendeten oder Ändern ohne Autorisierung geschützt werden.

Es gibt drei verschiedene Berechtigungsebenen:

1. Lesen

   Ermöglicht es Ihnen, den Status der Dienste zu überwachen.

2. Lesen und Ausführen

   Ermöglicht es Ihnen, Befehle auszuführen, wie z. B. das Starten und Anhalten von Diensten und das Überwachen des Status der Dienste.

3. Lesen, Ausführen und Verwalten

   Ermöglicht es Ihnen, die Konfiguration des ServiceManagers zu bearbeiten, Befehle auszuführen und den Status der Dienste zu überwachen.

Wichtig! Sie benötigen die Zugriffsebene Lesen, Ausführen und Verwalten, um Passwörter festzulegen oder zu ändern. Weitere Informationen finden Sie unter Komponenten verwalten.

Sie können mit dem ServiceManager eine sichere Verbindung (TLS 1.2) herstellen, aber dennoch nicht sichere Verbindungen zu älteren ServiceManagern unterstützen. Für sichere Verbindungen müssen Sie CAPKI auf demselben Computer installiert haben, auf dem Sie den ServiceManager CLI installiert haben. Wenn Sie eine unsichere Verbindung verwenden, führt der CLI den Befehl zum ServiceManager aus, erstellt aber auch eine Warnmeldung.

Wenn die Mandanten-Zertifizierung im ServiceManager aktiviert ist, benötigt der Mandant ein Zertifikat für die Authentifizierung. Die Zertifikat- und Schlüsseldateien für das CLI des ServiceManagers müssen als zusätzliche Kommandozeilenparameter angegeben werden.

Weitere Informationen finden Sie unter CAPKI - Sicherung des ServiceManagers.

Beispiel

In diesem Beispiel befinden sich die Zertifikat- und Schlüsseldateien im Verzeichnis .\bin des ServiceManagers – CLI.

ucybsmcl -c GET_PROCESS_LIST -h unixw2k01:8871 -n uc4p -certificate C:\Automic\Automation.Platform\ ServiceManagerDialog\bin\<Zertifikatdateinam>.pem -key C:\Automic\Automation.Platform\ ServiceManagerDialog\bin\<Schlüsseldateiname>.pem

Einige Zertifikate benötigen möglicherweise ein vorläufiges Zertifikat für die Validierung, wenn die Signaturzertifizierungsstelle nicht direkt vertrauenswürdig ist. Verwenden Sie den Kommandozeilenparameter -chain <chain file name>, um auf den Speicherort des vorläufigen Zertifikats zu verweisen.

Wenn die Mandantenzertifizierung aktiviert ist und der Mandant kein Zertifikat besitzt oder die Zertifikatsvalidierung fehlschlägt, wird die Verbindung beendet. In diesem Fall schreibt der ServiceManager einen entsprechenden Log-Eintrag und gibt eine Fehlermeldung an den Mandanten zurück.

Syntax

Windows:

UCYBSMCL [.EXE] -c GET_PROCESS_LIST -h Computername -n Phrase

UCYBSMCL [.EXE] -c START_PROCESS -h Computername -n Phrase-s Name des Dienstes [-pPasswort]

UCYBSMCL [.EXE] -c STOP_PROCESS -h Computername -n Phrase-s Name des Dienstes [-mStopmodus] [-pPasswort]

UCYBSMCL [.EXE] -c SET_DATA -h Computername -n Phrase-s Name des Dienstes-dEigenschaftswert [-pPasswort]

Unix:

ucybsmcl  -c GET_PROCESS_LIST -h Computername:Portnummer -n Phrase

ucybsmcl  -c START_PROCESS -h Computername:Portnummer-n Phrase -s Name des Dienstes [-p Passwort]

ucybsmcl  -c STOP_PROCESS -h Computername:Portnummer -n Phrase -s Name des Dienstes [-mStoppmodus] [-p Passwort]

ucybsmcl  -c SET_DATA -h Computername:Portnummer -n Phrase-s Name des Dienstes -dEigenschaftswert [-p Passwort]

Parameter

• -c-Kommando, der verarbeitet werden soll

  Dieser Parameter muss immer angegeben werden.

  Zuordnung:

  • GET_PROCESS_LIST: Fordert eine Liste aller zu einer ServiceManager-Umgebung gehörenden Dienste auf einem Computer zusammen mit den verfügbaren Informationen an

  • START_PROCESS: Startet einen Dienst

  •  STOP_PROCESS: Stoppt einen Dienst

  • SET_DATA: Legt die Eigenschaften eines Dienstes fest.

• -h-Computer

  Dieser Parameter muss immer angegeben werden.

  Zuordnung:

  • Computername: Name des Computers, auf dem der ServiceManager verwendet wird.

    Es kann auch ein Remote-Computer verwendet werden. Dieser Computer muss von dem Computer, der ihn aufruft, aus verfügbar sein. Der Benutzer muss berechtigt sein, auf Dienste auf diesem Remote-Computer zuzugreifen.

  • Portnummer: Bei UNIX muss zusätzlich die Portnummer des ServiceManagers angegeben werden.

• -n ServiceManager-Umgebung

  Dieser Parameter muss immer angegeben werden.

  Zuordnung:

  • Phrase: Name der ServiceManager-Umgebung, die die verschiedenen AE-Dienste auf einem Computer zusammenfasst/schreibt. Im Dialogprogramm des ServiceManagers wird dies als Phrase bezeichnet.

• -s Dienst

  Dieser Parameter muss immer angegeben werden, mit der einzigen Ausnahme von GET_PROCESS_LIST.

  Zuordnung:

  • Name des Dienstes: Angabe des Namens eines Dienstes:

    • wird in der Spalte Service des Dialogprogramms angezeigt

    • wird in der Definitionsdatei Phrase.SMD aufgelistet, siehe SMD-Datei einrichten

    • ist in der Ausgabe des Befehls GET_PROCESS_LIST verfügbar

    Da ein Dienstname auch Leerzeichen enthalten kann, sollte er immer in Anführungszeichen eingegeben werden.

• -d Eigenschaftswert

  Dieser Parameter ist nur für SET_DATA erforderlich.

  Zuordnung:

  • Eigenschaftsstring: Der String hängt von der angegebenen Eigenschaft ab.

    Erlaubte Eigenschaftsstrings:

    • Kommando
    • Startpfad
    • Benutzername
    • Passwort
    • Domäne
    • Autostart
    • Verzögerung

    Beispiele

    ucybsmcl -c SET_DATA -h PC000666 -n Automic -s "RAFTP Agent” -d Command "java -jar -Xrs -Xmx256M ucxjcitx.jar”

    ucybsmcl -c SET_DATA -h PC000666 -n Automic -s "RAFTP Agent” -d Autostart 1

• -m Endmodus

  Dieser Parameter ist optional für STOP_PROCESS.

  Zuordnung:

  • Stoppmodus: Art und Weise, wie ein Dienst beendet werden soll.

    Zulässige Werte: C, S und A

    C = Schließen

    Der Dienst wird normal beendet.

    S = Shutdown

    Der Dienst wird sofort gestoppt, unabhängig von laufenden Aufgaben.

    A = Abnormal

    Der Service wird vom ServiceManager durch einen Systemaufruf (Kill) sofort gestoppt. Verwenden Sie diesen Befehl nur, wenn Versuche des Dienstes, sich selbst zu stoppen, nicht erfolgreich waren.

    Standardwert: C

• -p Passwort

  Dieser Parameter ist optional, abhängig davon, ob ein Passwort der entsprechenden Autorisierungsebene zugewiesen wurde. Wenn zum Beispiel ein Passwort für die Autorisierungsebene 1 festgelegt ist, ist sogar ein Passwort erforderlich, um GET_PROCESS_LIST auszuführen.

  Mehr Informationen:

  • Komponenten verwalten
  • Passwörter verschlüsseln

  Zuordnung:

  • Passwort: Passwort für eine Autorisierungsebene, die das Recht zum Ausführen des mit dem Parameter -c bereitgestellten Befehls abdeckt.

• -sm Startmodus von Server-Arbeitsprozessen (WPs)

  Welche Werte für den Parameter -sm zulässig sind, hängt von der Dienstdefinition in der SMD-Konfigurationsdatei des ServiceManagers ab. Weitere Informationen finden Sie unter SMD-Datei einrichten.

  Um sicherzustellen, dass dem WP beim Start ein bestimmter Startmodus zugewiesen werden kann, müssen Sie START1=, START2=, START3= .... in der SMD-Datei für jeden DEFINE eines WP-Dienstes einstellen. Die mitgelieferte SMD-Datei UC4.SMD enthält einige Beispieldefinitionen.

  Zuordnung:

  • Startmodus: z. B. die Definition eines WP-Dienstes in einer SMD-Datei (einschließlich Variablen):

    VAR SRV_STARTPATH;*OWN\..\..\Server\bin
    VAR WP_STARTCMD;*SRV_STARTPATH\UCsrvwp.exe *SRV_STARTPATH\ucsrv.ini -svc%port%
    VAR WP_STARTCMD_COLD;*WP_STARTCMD -parm"StartMode=Cold"
    VAR WP_STARTCMD_STOP;*WP_STARTCMD -parm"SystemStop=Yes"
    VAR WP_STARTCMD_COLDSTOP;*WP_STARTCMD -parm"StartMode=Cold;SystemStop=Yes"

    DEFINE UC4 WP2;*WP_STARTCMD;*SRV_STARTPATH;START1=(Coldstart,*WP_STARTCMD_COLD);START2=(Systemstop,*WP_STARTCMD_STOP);START3=(Coldstart with Systemstop,*WP_STARTCMD_COLDSTOP)

    Zulässige Werte:

    • Coldstart: Kaltstartmodus

    • Systemstop: Normaler Start

      Zu diesem Zweck wird das System gestoppt.

    • Coldstart with Systemstop: Kaltstart mit einem Systemstopp.

Wenn Sie das Kommandozeilenprogramm mit falschen oder fehlenden Parametern aufrufen, wird ein kurzer Hilfetext angezeigt, der die korrekten Parameter und Rückgabewerte anzeigt.

Ausgabe

Wenn Sie das Kommandozeilenprogramm mit dem Befehl GET_PROCESS_LIST aufrufen, werden die angeforderten Informationen Zeile für Zeile angezeigt. Dies entspricht der Ansicht des ServiceManager-Dialogprogramms.

Ausgabeformat

"Service" "Status" ["ProcID" "Start time" "Runtime" "CPU Time"]

• Dienst: Name des Dienstes

• Status: Status des Dienstes

  • R: Laufend

  • S: Gestoppt

• ProcID: Prozessnummer des Dienstes.

  Es werden nur Informationen zu aktiven Diensten (Status = R) angezeigt.

• Startzeit: Startdatum und -zeit des Dienstes.

  Format: YYYY-MM-DD HH:MM

  Es werden nur Informationen zu aktiven Diensten (Status = R) angezeigt.

• Laufzeit: Laufzeit des Dienstes.

  Format: TT/HH:MM

  Es werden nur Informationen zu aktiven Diensten (Status = R) angezeigt.

• CPU-Zeit: CPU-Zeit, die für einen Dienst erforderlich ist.

  Format: TT/HH:MM:SS:HS (HS=Hundertstelsekunden).

  Es werden nur Informationen zu aktiven Diensten (Status = R) angezeigt.

Rückgabewerte

• 0 Ein Kommando wurde fehlerfrei verarbeitet.

• 1 Es wurde ein falsches Kommando eingegeben.

• 2 Es wurde kein aktiver ServiceManager auf dem angegebenen Computer gefunden.

  Möglich Ursache: Entweder wurde der Name des Computers nicht eingegeben oder auf diesem Computer ist kein ServiceManager aktiv.

• 3 Der ServiceManager reagiert unerwartet auf einen Befehl.

  Möglich Ursache: Die ServiceManager-Version ist nicht aktuell.

• 4 Bei der Verbindung zum ServiceManager sind Fehler aufgetreten.

• 5 Die angegebene ServiceManager-Umgebung ist auf dem entsprechenden Computer nicht vorhanden.

  Mögliche Ursache: Der ServiceManager für die angegebene ServiceManager-Umgebung ist entweder nicht installiert oder wurde nicht gestartet.

Beispiele

Das erste Beispiel ruft alle Dienste ab, die zum Computer WINW2K01 und zur ServiceManager-Umgebung UC4P gehören.

UCYBSMCL.EXE -c GET_PROCESS_LIST -h WINW2K01 -n UC4P

Ausgabe:

"UC4 CP1" "R" "1588" "2004-04-05 21:39" "0/01:11" "0/00:00:22.69"
"UC4 WP1" "R" "3388" "2004-04-05 21:39" "0/01:11" "0/00:00:22.69"
"UC4 WP2" "R" "1576" "2004-04-05 21:39" "0/01:11" "0/00:00:22.69"
"Win32-Agent WIN01" "R" "2708" "2004-04-05 21:40" "0/01:11" "0/00:00:01.31"
"Win32-Agent WIN21" "R" "2392" "2004-04-05 21:40" "0/01:10" "0/00:00:01.30"
"Win32-Agent UC4MAIL" "R" "2932" "2004-04-05 21:40" "0/01:10" "0/00:00:01.31"
"SAP Agent C46" "S"
"PeopleSoft-Agent PS01" "S"

Das zweite Beispiel beendet normalerweise einen UNIX-Agenten.

./ucybsmcl -c STOP_PROCESS -h unixw2k01:8871 -n uc4p -s unix01 -m Close

Siehe auch:

• ServiceManager - Service
• ServiceManager - Dialogprogramm
• Starten und Beenden von Serverprozessen
• Start-Parameter - Automation Engine
• Startparameter - Dienstprogramme
• Passwörter verschlüsseln