Changes for page Microservice Cmdlets

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

From 2.3 to 2.2 From 2.7 to 2.6

From version 2.6

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

Change comment: There is no comment for this version

To version 2.3

edited by jklein
on 2025/06/20 08:14

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -157,106 +157,10 @@
  == Edit-AESBMicroservices ==
--Dieses Cmdlet ermöglicht die Bearbeitung der Konfiguration eines spezifischen Microservice. Derzeit unterstützt es die Änderung des Starttyps (StartupType) und optional die Konfiguration von Anmeldeinformationen (Credentials) für den Microservice. Dies ist besonders nützlich, um das Startverhalten von Microservices zu steuern oder SICS-Anmeldeinformationen zu aktualisieren.
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=Datentyp|=Optional|=Beschreibung
--|-ConnectionName| |String|✅|Der Name der Verbindung, über die Microservice-Instanzen bearbeitet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
--|-InstanceName|NoCredentialParameterSetName,
--CredentialParameterSetName|String|❌|Gibt den eindeutigen Namen der Microservice-Instanz an, deren Konfiguration geändert werden soll. Dieser Parameter ist in beiden Parametersets obligatorisch.
--|-UseCredentials|CredentialParameterSetName|SwitchParameter|✅❌|Gibt an, dass Anmeldeinformationen für den Microservice konfiguriert werden sollen. Dieser Parameter gehört zum CredentialParameterSetName und ist obligatorisch, wenn dieses Set verwendet wird.
--|-UserName|CredentialParameterSetName|String|✅❌|Gibt den Benutzernamen an, der verwendet werden soll, wenn UseCredentials aktiviert ist. Dieser Parameter gehört zum CredentialParameterSetName und ist obligatorisch, wenn dieses Set verwendet wird.
--|-Password|CredentialParameterSetName|SecureString|✅❌|Gibt das Passwort für den angegebenen Benutzernamen an. Das Passwort muss als SecureString-Objekt übergeben werden. Dieser Parameter gehört zum CredentialParameterSetName und ist obligatorisch, wenn dieses Set verwendet wird.
--|-StartupType|NoCredentialParameterSetName,
--CredentialParameterSetName|Enum|❌|Legt fest, wie der Microservice beim Systemstart verhalten soll. Dies ist ein Enum-Wert vom Typ InstanceStartType. Gängige Werte sind Automatic (startet automatisch mit dem System) und Manual (muss manuell gestartet werden).
--
--=== Parameter-Sets ===
--
--Das Cmdlet verwendet Parameter-Sets, um zwei Hauptszenarien zu unterstützen:
--
--* **NoCredentialParameterSetName**: Ermöglicht die Bearbeitung des Starttyps ohne die Angabe von Anmeldeinformationen.
--* **CredentialParameterSetName**: Ermöglicht die Bearbeitung des Starttyps //und// die Konfiguration von Anmeldeinformationen für den Microservice.
--
--Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
--
--=== Beispiele ===
--
--Beispiel 1: Starttyp eines Microservice auf "Automatisch" ändern
--
--{{code language="PowerShell"}}
--Edit-AESBMicroservice -InstanceName "TestMicroservice1" -StartupType Automatic
--
--{{/code}}
--
--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
--
--{{code language="PowerShell" layout="LINENUMBERS"}}
--$password = ConvertTo-SecureString "YourSecurePassword" -AsPlainText -Force
--Edit-AESBMicroservice -InstanceName "TestMicroservice" -UseCredentials -Username "MySicsUser" -Password $password -StartupType Automatic
--{{/code}}
--
--Dieser Befehl ändert den Starttyp des Microservice "TestMicroservice" auf "Automatisch" und konfiguriert individuelle SICS-Anmeldeinformationen mit dem angegebenen Benutzernamen und Passwort. Hier wird das //CredentialParameterSetName// verwendet.
--
  == 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.
--
--|=(% 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 ==
--
--
  == Remove-AESBMicroservices ==
  == Restart-AESBMicroservices ==