Changes for page Microservice Cmdlets

Last modified by jklein on 2025/08/15 09:48

From 2.4 to 2.3 From 3.2 to 3.1

From version 3.1

edited by jklein
on 2025/06/20 11:01

Change comment: There is no comment for this version

To version 2.4

edited by jklein
on 2025/06/20 09:25

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -180,7 +180,7 @@
  === Beispiele ===
--Beispiel 1: Starttyp eines Microservice auf "Automatisch" ändern
++Beispiel 1: Starttyp eines Microservice auf "Automatisch" änder
  {{code language="PowerShell"}}
  Edit-AESBMicroservice -InstanceName "TestMicroservice1" -StartupType Automatic
@@ -189,7 +189,7 @@
  Dieser Befehl ändert den Starttyp des Microservice mit dem Namen "TestMicroservice" auf "Automatisch". Hier wird das //NoCredentialParameterSetName// verwendet.
--Beispiel 2: Starttyp ändern und individuelle Anmeldeinformationen festlegen
++Beispiel 2: Starttyp ändern und individuelle Anmeldeinformationen festlege
  {{code language="PowerShell" layout="LINENUMBERS"}}
  $password = ConvertTo-SecureString "YourSecurePassword" -AsPlainText -Force
@@ -200,230 +200,16 @@
  == Kill-AESBMicroservices ==
--Mit diesem Cmdlet können Sie laufende Microservices gezielt beenden. Dies ist nützlich für die Wartung, Fehlerbehebung oder das Herunterfahren bestimmter Microservice-Instanzen. Das Cmdlet bietet zwei Methoden zum Ansprechen der zu beendenden Microservices: entweder direkt über deren Instanz-IDs oder indirekt über die ID ihres Supervisoren, wodurch alle zugehörigen Microservices beendet werden.
++Mit diesem Cmdlet können Sie laufende Microservices gezielt beenden.
++Dies ist nützlich für die Wartung, Fehlerbehebung oder das Herunterfahren bestimmter Microservice-Instanzen.
++Das Cmdlet bietet zwei Methoden zum Ansprechen der zu beendenden Microservices: entweder direkt über deren Instanz-IDs oder indirekt über die ID ihres Supervisoren, wodurch alle zugehörigen Microservices beendet werden.
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=Datentyp|=Optional|=Beschreibung
--|-ConnectionName| |String|✅|Der Name der Verbindung, über welche die Ausführung von Microservice-Instanzen abgebrochen werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
--|-InstanceIds|UseMicroservicesIdListParameterSet|String[]|✅❌|Gibt eine Liste von eindeutigen Instanz-IDs (GUIDs als String) der Microservices an, die beendet werden sollen.
--|-SupervisorId|UseSupervisorIdParameterSet|String|✅❌|Der **SupervisorId**-Parameter gibt die eindeutige ID (GUID als String) des Supervisors an. Alle Microservices, die von diesem spezifischen Supervisor verwaltet werden, werden beendet.
--
--=== Parameter-Sets ===
--
--Das Cmdlet verwendet Parameter-Sets, um diese beiden Betriebsmodi zu unterscheiden:
--
--* **UseMicroservicesIdListParameterSet**: Ermöglicht das Ansprechen von Microservices über eine Liste ihrer eindeutigen Instanz-IDs.
--* **UseSupervisorIdParameterSet**: Ermöglicht das Ansprechen von Microservices durch Angabe der ID ihres Supervisoren. Alle Microservices, die diesem Supervisor zugeordnet sind, werden beendet.
--
--Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
--
--=== Beispiele ===
--
--Beispiel 1: Einen spezifischen Microservice mit seiner Instanz-ID beenden
--
--{{code language="PowerShell"}}
--Kill-AESBMicroservices -InstanceIds "ffffffff-ffff-ffff-ffff-ffffffffffff"
--
--{{/code}}
--
--Dieser Befehl versucht, den Microservice mit der angegebenen Instanz-ID zu beenden. Die Beispielausgabe zeigt, dass der Microservice bereits gestoppt war. Hier wird das //UseMicroservicesIdListParameterSet// verwendet.
--
--Beispiel 2: Mehrere Microservices mit ihren Instanz-IDs beenden
--
--{{code language="PowerShell"}}
--Kill-AESBMicroservices -InstanceIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2"
--
--{{/code}}
--
--Dieser Befehl versucht, die Microservices mit den angegebenen Instanz-IDs zu beenden.
--
--Beispiel 3: Alle Microservices beenden, die einem bestimmten Supervisor zugeordnet sin
--
--{{code language="PowerShell"}}
--Kill-AESBMicroservices -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff"
--{{/code}}
--
--Dieser Befehl beendet alle Microservices, die dem Supervisor mit der angegebenen ID zugeordnet sind. Hier wird das //UseSupervisorIdParameterSet// verwendet.
--
--=== Rückgabewerte ===
--
--Das Cmdlet gibt eine Sammlung von Objekten zurück, die den Status der Beendigung für jeden angesprochenen Microservice anzeigen. Die Ausgabe im Beispiel zeigt folgende Eigenschaften:
--
--* **Status**: Der Status der Beendigungsoperation (z.B. //Unchanged// wenn bereits gestoppt, //Stopped// wenn erfolgreich beendet).
--* **InstanceId**: Die eindeutige ID der betroffenen Microservice-Instanz.
--* **InstanceState**: Der Zustand des Microservice nach der Operation (z.B. Already stopped).
--* **Error**: Eine Fehlermeldung, falls die Operation nicht erfolgreich war oder ein Problem aufgetreten ist.
--
  == Move-AESBMicroservices ==
--Mit diesem Cmdlet können Sie eine oder mehrere Microservice-Instanzen auf einen anderen Supervisor verschieben. Es unterstützt optionale Parameter für Timeout und asynchrone Ausführung.
--
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen verschoben werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
--|-InstanceIds|String[]|❌| |Die IDs der zu verschiebenden Microservice-Instanzen (Pflichtfeld, unterstützt mehrere Werte)
--|-SupervisorId|String|❌| |Die Ziel-SupervisorId, auf die die Instanzen verschoben werden sollen
--|-Timeout|String|✅| |Optionales Timeout für die Operation (Standard: "30s")
--|-NoWait|SwitchParameter|✅| |Gibt an, ob das Cmdlet auf den Abschluss der Operation warten soll (asynchron)
--
--=== Beispiele ===
--
--Beispiel 1: Einen Microservice zu einem neuen Supervisor verschieben
--
--{{code language="PowerShell"}}
--Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa"
--{{/code}}
--
--Dieser Befehl verschiebt den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-ffffffffffff" zu dem Supervisor mit der ID "ffffffff-ffff-ffff-ffff-aaaaaaaa".
--
--Das Cmdlet wartet, bis der Vorgang abgeschlossen ist (Standard-Timeout von 30 Sekunden).
--
--Beispiel 2: Mehrere Microservices zu einem neuen Supervisor verschieben und nicht auf Abschluss warten.
--
--{{code language="PowerShell"}}
--Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -NoWait
--
--{{/code}}
--
--Dieser Befehl initiiert die Verschiebung der Microservices mit den Instanz-IDs "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" und "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" zu "ffffffff-ffff-ffff-ffff-aaaaaaaa" und kehrt sofort zurück, ohne auf den Abschluss des Vorgangs zu warten.
--
--Beispiel 3: Einen Microservice verschieben mit längerem Timeout
--
--{{code language="PowerShell"}}
--Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -Timeout "5m"
--{{/code}}
--
--Dieser Befehl versucht, "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" zu "ffffffff-ffff-ffff-ffff-aaaaaaaa" zu verschieben und wartet bis zu 5 Minuten auf den Abschluss des Vorgangs.
--
--=== Rückgabewerte ===
--
--Das Cmdlet gibt für jede verschobene Instanz ein Objekt mit folgenden Eigenschaften zurück:
--
--* **InstanceId**: Die ID der verschobenen Microservice-Instanz
--* **SicsUsername**: Der zugehörige Benutzername (z. B. für die Verbindung)
--* **IsIdentified**: Gibt an, ob die Instanz eindeutig identifiziert wurde
--* **ProcessState**: Aktueller Prozessstatus der Instanz (z. B. Stopped)
--* **LastUpdate**: Zeitpunkt der letzten Statusänderung
--* **Timestamp**: Zeitstempel der letzten Änderung
--* **ProcessId**: (Optional) Prozess-ID der Instanz
--* **CpuUsage**: (Optional) CPU-Auslastung der Instanz
--* **RamUsage**: (Optional) RAM-Auslastung der Instanz
--
  == Remove-AESBMicroservices ==
--Dieses Cmdlet entfernt die angegebenen Microservice-Instanzen. Die zu entfernenden Microservices können entweder über ihre Instanz-Namen oder ihre Instanz-IDs identifiziert werden. Es muss einer der Parameter -//InstanceNames// oder -//InstanceIds// angegeben werden. Die Parameter können nicht zusammen verwendet werden.
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen entfernt werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-InstanceNames|String[]|❌|Keine|Gibt die Namen der Microservices an, die entfernt werden sollen. Es kann ein einzelner Name oder ein Array von Namen übergeben werden. Obligatorisch für den Parameter-Satz //ByInstanceName//.
--|-InstanceIds|String[]|❌|Keine|Gibt die eindeutigen Instanz-IDs (GUIDs) der Microservices an, die entfernt werden sollen. Es kann eine einzelne ID oder ein Array von IDs übergeben werden. Obligatorisch für den Parameter-Satz //ByInstanceId//.
--
--=== Beispiele ===
--
--Beispiel 1: Einen Microservice anhand seiner Instanz-ID entfernen
--
--{{code language="PowerShell"}}
--Remove-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"
--{{/code}}
--
--Dieser Befehl entfernt den Microservice mit der Instanz-ID "b6cb7044-b6b2-4a64-9997-29f0ea5283db". Die Ausgabe zeigt die Instanz und das Ergebnis "Success".
--
--Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs entfernen
--
--{{code language="PowerShell"}}
--Remove-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"
--{{/code}}
--
--Dieser Befehl entfernt zwei Microservices, die durch ihre jeweiligen Instanz-IDs identifiziert werden.
--
--Beispiel 3: Einen Microservice anhand seines Namens entfernen
--
--{{code language="PowerShell"}}
--Remove-AESBMicroservice -InstanceNames "MeinService"
--
--{{/code}}
--
--Dieser Befehl entfernt den Microservice mit dem Namen "MeinService".
--
--Beispiel 4: Mehrere Microservices anhand ihrer Namen entfernen und Bestätigung anfordern
--
--{{code language="PowerShell"}}
--Remove-AESBMicroservice -InstanceNames "Service1", "Service2" -Confirm
--{{/code}}
--
--Dieser Befehl versucht, die Microservices "Service1" und "Service2" zu entfernen. Vor dem eigentlichen Entfernen wird der Benutzer um Bestätigung gebeten.
--
--Beispiel 5: Microservices über die Pipeline anhand von Instanz-IDs entfernen
--
--{{code language="PowerShell"}}
--"aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" | Remove-AESBMicroservice -InstanceIds
--
--{{/code}}
--
--Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Remove-Microservice`, um die entsprechenden Microservices zu entfernen.
--
--=== Rückgabewerte ===
--
--Das Cmdlet gibt für jeden versuchten Entfernungsvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
--
--* **Instance**: Die ID oder der Name des Microservices.
--* **Result**: Das Ergebnis des Entfernungsvorgangs (z.B. "Success", "Failed").
--
  == Restart-AESBMicroservices ==
--Mit diesem Cmdlet können Sie die angegebenen Microservice-Instanzen neu starten. Die neu zu startenden Microservices können entweder über ihre `InstanceIds` oder über eine `SupervisorId` (die alle zugehörigen Instanzen neu startet) identifiziert werden. Es muss einer der Parameter `-InstanceIds` oder `-SupervisorId` angegeben werden.
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen neugestartet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
--|-SupervisorId|String[]|❌|Keine|Gibt die Namen der Microservices an, die entfernt werden sollen. Es kann ein einzelner Name oder ein Array von Namen übergeben werden. Obligatorisch für Parametersatz ByInstanceName.
--|-InstanceIds|String[]|❌|Keine|Gibt die eindeutigen Instanz-IDs (GUIDs) der Microservices an, die entfernt werden sollen. Es kann eine einzelne ID oder ein Array von IDs übergeben werden. Obligatorisch für Parametersatz ByInstanceId.
--|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Neustartvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
--|-NoWait|SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Neustartvorgangs, sondern kehrt sofort zurück.
--
--==== **Beispiele** ====
--
--Beispiel 1: Einen Microservice anhand seiner Instanz-ID neu starten
--
--{{code language="PowerShell"}}
--Restart-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"
--{{/code}}
--
--Dieser Befehl startet den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" neu und wartet auf das Ergebnis.
--
--Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs neu starten mit Timeout
--
--{{code language="PowerShell"}}
--Restart-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -Timeout "1m"
--
--{{/code}}
--
--Dieser Befehl startet zwei Microservices neu und setzt das Timeout für den Vorgang auf eine Minute.
--
--Beispiel 3: Alle Microservices eines Supervisors neu starten, ohne auf den Abschluss zu warten
--
--{{code language="PowerShell"}}
--Restart-AESBMicroservices -SupervisorId "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -NoWait
--{{/code}}
--
--Dieser Befehl initiiert den Neustart aller Microservices, die vom Supervisor "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" verwaltet werden, und kehrt sofort zurück.
--
--Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs neu starten
--
--{{code language="PowerShell"}}
--"aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" | Restart-AESBMicroservices
--{{/code}}
--
--Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Restart-Microservices`, um die entsprechenden Microservices neu zu starten.
--
--=== Rückgabewert ===
--
--Das Cmdlet gibt für jeden versuchten Neustartvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
--
--* **Name**: Der Name des Microservices.
--* **InstanceId**: Die Instanz-ID des Microservices.
--* **RestartRequested**: Zeitstempel, wann der Neustart angefordert wurde.
--* **RestartSucceeded**: Zeitstempel, wann der Neustart erfolgreich war (oder leer/Fehlerdatum bei Misserfolg).
--* **Status**: Das Ergebnis des Neustartvorgangs (z.B. "Success", "Failed", "InProgress").
--
  == Set-AESBMicroserviceLogging ==
  == Start-AESBMicroservices ==