MODIFY_SYSTEM

Script-Funktion: Verarbeitet ServiceManager-Aktionen, Queue-Änderungen, steuert Schritte in einem Zero Downtime Upgrade-Szenario und für das Centralized Agent Upgrade (CAU).

Dieses Script-Element kann verwendet werden, um vier verschiedene Arten von Aufgaben zu bearbeiten:

  1. Ausführen der Aktionen eines ServiceManagers, der mit dem AE-System verbunden ist
  2. Ändern der Werte oder Zustände von Queue-Objekten (GO/STOP)
  3. Wechseln der Verarbeitungsrichtung während eines Zero Downtime Upgrade-Szenarios oder Abschluss der Zero Downtime Upgrade-Phase.
  4. Ausführen von Aktionen für die Verarbeitung eines Centralized Agent Upgrade (CAU).

Die durchzuführende Aktion der Script-Funktion richtet sich nach den angegebenen Parametern. Siehe dazu die folgenden Syntaxbeschreibungen.

Achtung! Mit diesem Script-Element können Sie Serverprozesse und Agenten nur dann starten, wenn ein ServiceManager zur Verfügung steht, der korrekt konfiguriert und mit dem AE-System verbunden ist. Weitere Informationen finden Sie in den Einstellungen auf der Seite Attribute von Agenten- oder Server-Objekten. Weitere Informationen finden Sie auf der Seite Seite "Attribute".

Queue

Syntax

MODIFY_SYSTEM (Aktion, Queue, Wert)

Syntax

Beschreibung/Format

Aktion:

Definiert die Änderungen, die in Queue-Objekten durchgeführt werden sollen
Format: Script-Literal oder Script-Variable

Zulässige Werte:

  • MODE = Queue-Status, Start/Stopp der Ausführung von Queue-Aufgaben
  • MAX_SLOTS = Max. Anzahl von Aufgaben, die gleichzeitig ausgeführt werden können (max. Slots)
  • PRIORITY = Aufgabenpriorität

Queue

Name des Queue-Objekts, das geändert werden soll.
Format: Script-Literal oder Script-Variable

Wert

Wert für die Einstellung oder den Status, der geändert werden soll (Aktion).
Format: Script-Literal oder Script-Variable

Zulässige Werte in Abhängigkeit der gewählten Aktion:

MODE: GO oder STOP
MAX_SLOTS: Zahl zwischen 0 und 99999 oder UNLIMITED
PRIORITY: Zahl zwischen 0 und 255

Das Ändern des Status von Queue-Objekten (Start/Stopp) unter Verwendung dieses Script- Elements (Aktion: MODE) hat zur Folge, dass der neue Status gültig ist, bis eine neue Änderung vorgenommen wird. Änderungen an prioritären oder maximalen Queue-Slots bleiben so lange gültig, bis diese Werte aufgrund einer Ausnahme geändert werden oder wenn ein Benutzer sie manuell ändert, siehe Berücksichtigen der ERT in Queue-Objekten.

Hinweis: Werden die maximalen Slots von Queue-Objekten auf UNLIMITED geändert, gibt es keine Begrenzung für die parallel laufenden Aufgaben.

Beispiel

Das folgende Beispiel setzt den Status des Queue-Objekts QUEUE.JOBS auf GO:

: SET &RET# = MODIFY_SYSTEM("MODE", "QUEUE.JOBS", "GO")
:IF &RET# = "0"
: PRINT " Verarbeitung des Queue-Objekts QUEUE.JOBS wurde erfolgreich aktiviert."
:ELSE
: PRINT "QUEUE.JOBS: Fehler bei der Änderung des Status auf GO."
:ENDIF

Liste der möglichen Rückgabewerte bei der Änderung von Queue-Objekten:

Rückgabewerte

0 - Die für diese Script-Funktion definierte Aktion wurde erfolgreich verarbeitet.
11901 - Das angegebene Queue-Objekt wurde nicht im Mandanten gefunden.
20836 - Es wurde ein ungültiger Wert für die Priorität oder die Slots des Queue-Objekts angegeben.
20837 - Für den Parameter MOD wurde ein ungültiger Wert angegeben.

ServiceManager

Syntax

MODIFY_SYSTEM (Action, Name [,Servermodus])

Syntax

Beschreibung/Format

Aktion:

Definiert die Maßnahmen, die für Agenten, Serverprozesse oder das AE-System ergriffen werden sollen.
Format: Script-Literal oder Script-Variable

Zulässige Werte:

STARTUP = Startet einen Agenten oder einen Serverprozess.
TERMINATE = Beendet einen Agenten oder einen Serverprozess.
SHUTDOWN = Schaltet das gesamte AE-System aus.
CHANGE_MODE = Ändert den Modus eines Server-Arbeitsprozesses (WP).
DISCONNECT = Schließt die Agentenverbindung und stellt sie wieder her.

Name

Name des Agenten oder Serverprozesses, der gestartet oder beendet werden soll oder dessen Modus geändert werden soll.
Format: Script-Literal oder Script-Variable

Server mode

Modus, in den der angegebene WP geändert werden soll.
Format: Script-Literal oder Script-Variable

Dieser Parameter ist nur erforderlich, wenn der Modus eines WPs geändert werden soll (Aktion = CHANGE_MODE).


Zulässige Werte: D: Dialogprozess
W: Arbeitsprozess

Eine weitere Funktionalität des Script-Elements MODIFY_SYSTEM ist die Möglichkeit, Serverprozesse und Agenten zu starten oder zu beenden bzw. den Modus von Server-Arbeitsprozessen zu ändern.

Die Aktion STARTUP kann nur verwendet werden, wenn ein ServiceManager verfügbar ist und wenn der zu startende Agent oder Serverprozess korrekt konfiguriert wurde. Weitere Informationen finden Sie in den Einstellungen auf der Seite Attribute von Agenten- oder Server-Objekten. Weitere Informationen finden Sie auf der Seite Seite "Attribute".

Um das AE-System mit SHUTDOWN zu beenden, wird für den Parameter Name der Wert UC4 benötigt. Weitere Informationen finden Sie unter :SHUTDOWN.

Der Parameter Server-Modus ist erforderlich, um den Modus des Server-Arbeitsprozesses zu ändern (Aktion: CHANGE_MODE). Der Parameter Servermodus darf nicht in Kombination mit den Aktionen STARTUP, TERMINATE, DISCONNECT und SHUTDOWN verwendet werden.

Beispiel

Herunterfahren des Agenten WIN01:

Liste der möglichen Rückgabewerte bei der Änderung des ServiceManagers:

Rückgabewerte

11677 - Der ServiceManager-Aufruf konnte nicht verarbeitet werden: Es wurde kein CP gestartet.
11678 - Server oder Agent wurde nicht gestartet.
11679 - Erfolgreiche ServiceManager-Abfrage.
11680 - Die Verbindung zum ServiceManager konnte nicht hergestellt werden oder der angegebene Prozess wurde nicht im ServiceManager gefunden.
11681 - Ein ServiceManager-Aufruf ist nicht möglich, da der angegebene Hosttyp nicht unterstützt wird.
11682 - Ein ServiceManager-Aufruf ist nicht möglich, da der angegebene Agent-/Serverprozess nicht gefunden wurde.
11683 - Der ServiceManager-Aufruf wird nicht verarbeitet, da der Server nicht mit dem angegebenen ServiceManager verknüpft ist oder die gleiche Abfrage bereits verarbeitet wurde.

Zero Downtime Upgrade

Syntax

MODIFY_SYSTEM (Aktion, Wert)

Syntax

Beschreibung/Format

Aktion:

Zulässiger Wert ZERO_DOWNTIME_UPGRADE = Zero Downtime Upgrade-Kontrolle.

Wert

Dieser Parameter wird für Routing-Meldungen verwendet, die von neuen oder alten WPs / CPs verarbeitet werden sollen.

Zulässige Werte:

BEGIN = setzt UC_SYSTEM_SETTINGS / ZERO_DOWNTIME_UPGRADE auf "Y"

END = setzt UC_SYSTEM_SETTINGS / ZERO_DOWNTIME_UPGRADE auf "N" - nur möglich, bevor Schritte im Aktualisierungsprozess ausgeführt werden

UPGRADE = Upgrade-Modus.
Der zu den neuen CPs und WPs gehörende Meldungsqueue-Satz wird aktiviert. Die PWP-Rolle wechselt zu einem neuen WP. Die Meldungen werden an die neue Verarbeitung weitergeleitet, während die alte Verarbeitung ausläuft.

ROLLBACK = Rollback-Modus.
Der zu den alten CPs und WPs gehörende Meldungsqueue-Satz wird aktiviert. Die Meldungen werden zurück zur alten Verarbeitung geleitet, während die neue Verarbeitung ausläuft.

FINALIZE = Schließt die Zero Downtime Upgrade-Phase ab, indem die aktuell aktive Meldungs-Queue als Basis festgelegt und UC_SYSTEM_SETTINGS / ZERO_DOWNTIME_UPGRADE auf N zurückgesetzt wird

Achtung! Für eine Aktualisierung ohne Ausfallzeit nur verwendbar, wenn UC_SYSTEM_SETTINGS/ZERO_DOWNTIME_UPGRADE = Y

Achtung! Das Datenbank-Upgrade muss zuvor erfolgreich durchgeführt werden. Mindestens ein CP und ein WP der neuen Version müssen in Betrieb sein.

Weitere Informationen über Zero Downtime Upgrades finden Sie unter Aktualisierungsprozess.

Beispiel

Dieses Beispiel zeigt die Einstellungen, die für den Start des Rollbacks notwendig sind:

:SET &RET # = MODIFY_SYSTEM("ZERO_DOWNTIME_UPGRADE", "ROLLBACK")

Liste der möglichen Rückgabewerte für das Zero Downtime Upgrade:

Rückgabewerte

0 - Die für diese Script-Funktion definierte Aktion wurde erfolgreich verarbeitet.
11895 - Warnung für Zero_Downtime_Upgrade: Kein aktiver CP oder WP für aktive Version gefunden. [Angegeben]-Modus wurde aktiviert.
20833 - Laufzeitfehler in Objekt [angegeben]: Fehler MODIFY_SYSTEM mit OpCode ZERO_DOWNTIME_UPGRADE gültig. ZERO_DOWNTIME_UPGRADE nicht in der UC_SYSTEM_SETTINGS gesetzt.
20846 - Laufzeitfehler in Objekt [angegeben]: MODIFY_SYSTEM(ZERO_DOWNTIME_UPGRADE) nicht gültig mit OpCode [angegeben]. Upgrade-Version nicht in der DB gefunden. Laden Sie zuerst die Version mit DB-Load.
20890 - Laufzeitfehler in Objekt [angegeben]: Fehler in MODIFY_SYSTEM. Funktion [angegebene Aktion] für OpCode 'ZERO_DOWNTIME_UPGRADE' nicht zulässig.
20891 - Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - ROLLBACK nicht möglich. Es gibt immer noch [angegebene] Agenten, die mit Version > [angegeben] verbunden sind
20892 - Laufzeitfehler im Objekt [angegeben] verbunden sind: ZERO_DOWNTIME_UPGRADE - ROLLBACK nicht möglich. Es sind noch [angegebene] aktive Aufgaben mit Version > [angegeben] verfügbar.
20893 - Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - UPGRADE nicht möglich. Kein Arbeitsprozess mit aktiver Upgrade-Version aktiv.
20894 - Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - ROLLBACK nicht möglich. Rollback-Modus ist bereits aktiv.
20895 - Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - UPGRADE nicht möglich. Rollback-Modus ist bereits aktiv.
20896 - Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - FINALIZE nicht möglich. Upgrade-Modus nicht aktiv.
20897 - Laufzeitfehler in Objekt [angegeben]: MODIFY_SYSTEM (ZERO_DOWNTIME_UPGRADE) nicht gültig mit OpCode [angegeben]. Aktuelle (Basis-) Version in DB nicht gefunden
20898 - Laufzeitfehler in Objekt [angegeben]: MODIFY_SYSTEM (ZERO_DOWNTIME_UPGRADE) nicht gültig mit OpCode [angegeben]. ZERO_DOWNTIME_UPGRADE ist bereits auf "Y" gesetzt.
20899 - Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - FINALIZE_ROLLBACK nicht möglich. Rollback-Modus nicht aktiv.
20900 - Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - END nicht möglich. Der Upgrade-Modus ist weiterhin aktiv. Zuerst FINALIZE ausführen.
20901 - Laufzeitfehler im Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - [angegebene Aktion] nicht möglich. CPs der alten Version haben noch offene Verbindungen.
20902 - Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - [angegebene Aktion] nicht möglich. Es sind noch Einträge in MQWP enthalten.
20903 - Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - [angegebene Aktion] nicht möglich. Es sind noch Einträge in MQJWP enthalten.
29177 - UCUDB: ZERO_DOWNTIME_UPGRADE - Zwischenspeichern der Tabellenstruktur wird nicht mehr verwendet.
29178 - UCUDB: ZERO_DOWNTIME_UPGRADE - Caching der Tabellenstruktur ist aktiviert.
38276 - ZERO_DOWNTIME_UPGRADE = 'Y' ist nur zulässig, wenn ein System ausgeführt wird.

Centralized Agent Upgrade (CAU)

Achtung Administratoren: Sie müssen den Import von Upgrade-PaketenCAU für die im Systemmandanten 0000 durchführen.

Achtung Administratoren:CAU Die kann von jedem Mandanten Ihres Systems aus ausgeführt werden, wenn die zu aktualisierenden Agenten und die Benutzer die entsprechenden Berechtigungen dafür haben.

Syntax

MODIFY_SYSTEM (Aktion, Subfunktion, Agent(en), Version[,FORCED][,Benutzerdefinierter Text])

Syntax

Beschreibung/Format

Aktion:

Zulässiger Wert: AGENT_UPGRADE = Centralized Agent Upgrade (CAU).

Unterfunktion

Zulässige Werte:

DEPLOY = Deployment eines Agenten, der durch den Parameter Version angegeben ist.

SKIP_WAITING = Ein registriertes Deployment für aktuell inaktive oder besetzte Agenten überspringen.

Agent(en)

Verweis auf eine Datensequenz oder einen Filter des Agentennamens, auf den die Aktion angewendet werden soll.

Format: Script-Literal oder Script-Variable

Version

Vollsemantische Version, auf die der Agent aktualisiert werden soll, oder Speicherobjektname oder Literal ‚LATEST'.

Beispiel:

"12.0.0+BUILD.2112"
oder
'LATEST' für die neueste verfügbare Version des Agenten, die durch ein APM-Paket im Mandanten 0000 des aktuellen Systems repräsentiert wird.

Format: Script-Literal oder Script-Variable

Achtung! Verwenden Sie diesen Parameter nur zusammen mit dem Wert DEPLOY des Parameters Sub function.

FORCED

Fixwert:

FORCED (optional)

Hinweis: Wenn dieser Parameter gesetzt ist, wird die Prüfung, ob ein Agent eine aktive ServiceManager-Verbindung hat, übersprungen (nur bei Verwendung von DEPLOY).

Custom text

Freier Text (optional)

Maximale Länge = 20

Zulässige Zeichen: Wie auf der Seite Allgemein von Workflows. Weitere Informationen finden Sie auf der Registerkarte Registerkarte "Allgemein".

Hinweis: Wenn dieser Parameter gesetzt ist, wird der Text anstelle von CAU als Namenspräfix für den obersten Statistikdatensatz verwendet (nur bei DEPLOY).

Hinweis: Weitere Informationen finden Sie unter CAU - Aktualisierungsprozess

Achtung Administratoren: Der Benutzer, der diese Scripts ausführt, benötigt die Berechtigung System-Upgrades ausführen.

Beispiele

Beispiel-Script, das neue Agenten bereitstellt:

: SET &HND# = PREP_PROCESS_AGENTGROUP("AGENTGROUP_WINDOWS")
:SET &RUNID# = MODIFY_SYSTEM (AGENT_UPGRADE, DEPLOY, &HND#, "LATEST", FORCED, "MYHOTFIXUPGRADE" )
!OR
!:SET &RUNID# = MODIFY_SYSTEM (AGENT_UPGRADE, DEPLOY, &HND#, "12.0.0+BUILD.2112", FORCED, "MYHOTFIXUPGRADE" )
:IF &RUNID# = 0
:SET &MSGNR# = SYS_LAST_ERR_NR()
:SET &MSGINSERT# = SYS_LAST_ERR_INS()
:SET &MSG# = GET_MSG_TXT(&MSGNR#, &MSGINSERT#)
:SEND_MSG &$USER#, &$DEPARTMENT#, &MSG#
:ENDIF

Beispiel-Script, das definiert, dass das Aktualisieren von wartenden Agenten übersprungen wird:

: SET &SKIPCOUNT# = MODIFY_SYSTEM (AGENT_UPGRADE, SKIP_WAITING, "AGENTNAMEORFILTER")
:SET &MSGNR# = SYS_LAST_ERR_NR()
:IF &MSGNR# > 0
: SET &MSGINSERT# = SYS_LAST_ERR_INS()
: SET &MSG# = GET_MSG_TXT(&MSGNR#, &MSGINSERT#)
: SEND_MSG &$USER#, &$DEPARTMENT#, &MSG#
:ENDIF

Liste der möglichen Rückgabewerte für das Centralized Agent Upgrade (CAU):

Achtung! Verwenden Sie bei Rückgabewert 0 SYS_LAST_ERR_NR() und SYS_LAST_ERR_INS(), um nach möglichen Fehlern zu suchen.

Rückgabewerte

Hinweis: Mögliche Rückgabewerte für die AGENT_UPGRADE-Aktion DEPLOY

0 - Der Upgrade-Prozess konnte nicht gestartet werden. Prüfen Sie auf den Grund bzw. die Gründe, indem Sie SYS_LAST_ERR_NR() und SYS_LAST_ERR_INS() verwenden.
>0: RunID für den gesamten Upgrade-Prozess, der eine Reportzeile für jeden verarbeiteten Agenten hat.

Hinweis: Rückgabewert für die AGENT_UPGRADE-Aktion SKIP_WAITING

>= 0 - AGENT_UPGRADE - Anzahl der erfolgreich übersprungenen Aktualisierungen.

Siehe auch: