Changes for page Microservice Cmdlets

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

From 2.6 to 2.7

From version 1.1

edited by jklein
on 2025/06/16 13:16

Change comment: There is no comment for this version

To version 2.6

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -1,1 +1,290 @@
  {{aagon.floatingbox/}}
++
++= Instances =
++
++== Add-AESBMicroservice ==
++
++Mit diesem Cmdlet wird eine neue Microservice-Instanz nach der Vorlage eines Templates hinzugefügt.
++
++|=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
++|-ConnectionName|Keine|String|✅|C|Der Name der Verbindung, über die die Microservice-Instanz hinzugefügt werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
++|-InstanceName|Keine|String|❌|Keine|Der Name der Instanz.
++|-TemplateName|UseTemplateName|String|❌|Keine|Der Name des Templates für die Vorlage der Instanz.
++|-TemplateId|UseTemplateId|String|❌|Keine|Die Id des Templates für die Vorlage der Instanz.
++|-SupervisorId|Keine|String|✅|Keine|Die Id des Supervisors zu der die Instanz hinzugefügt werden soll.
++|-StartupType|Keine|InstanceStartType|✅|Keine|Setzt die Art der Zeitplanung der Instanz.
++|-StoppedAfterCreation|Keine|Bool|✅|Keine|Setzt den Wert um die Instanz direkt nach der Erstellung zu starten.
++
++=== **Beispiele** ===
++
++Beispiel 1: Microservice über Template-Name hinzufügen
++
++{{code language="PowerShell"}}
++Add-AESBMicroservice -InstanceName "Test" -TemplateName "Tester"
++{{/code}}
++
++Dieses Beispiel fügt eine neue Instanz mithilfe des Template-Namen hinzu. Die Standardverbindung wird verwendet.
++
++Beispiel 2: Microservice über Template-Id hinzufügen
++
++{{code language="PowerShell"}}
++Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff"
++
++{{/code}}
++
++(% class="wikigeneratedid" %)
++Dieses Beispiel fügt eine neue Instanz mithilfe der Template-Id hinzu. Die Standardverbindung wird verwendet.
++
++Beispiel 3: Microservice StartUpType beim Hinzufügen setze
++
++{{code language="PowerShell"}}
++Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StartupType Manual
++{{/code}}
++
++Dieses Beispiel fügt eine neue Instanz mithilfe der Template-Id hinzu und setzt den //StartupType// auf //Manuell//. Die Standardverbindung wird verwendet.
++
++Beispiel 4: Microservice mit SupervisorId setzen
++
++{{code language="PowerShell"}}
++Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff"
++
++{{/code}}
++
++Dieses Beispiel fügt eine neue Instanz einen bestimmten Supervisor hinzu, der über die Supervisor-Id angegeben wird. Die Standardverbindung wird verwendet.
++
++Beispiel 5: Microservice mit StoppedAfterCreation setze
++
++{{code language="PowerShell"}}
++Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StoppedAfterCreation false
++
++{{/code}}
++
++Dieses Beispiel fügt eine neue Instanz hinzu und setzt den Wert von //StoppedAfterCreation// auf //false,// womit der Start nach dem Hinzufügen des Microservices verhindert wird. Die Standardverbindung wird verwendet.
++
++Beispiel 6: Microservice mit vielen Parametern
++
++{{code language="PowerShell"}}
++Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StartupType Manual -StoppedAfterCreation false
++{{/code}}
++
++Dieses Beispiel fügt eine neue Instanz zu einem angegebenen Supervisor hinzu, setzt den //StartupType// auf //Manuell und //den Wert von //StoppedAfterCreation// auf //false//. Die Standardverbindung wird verwendet
++
++(% style="color:inherit; font-family:inherit; font-size:25px; font-weight:bold" %)**Get-AESBMicroservice**
++
++Mit diesem Cmdlet erhalten Sie eine Liste mit allen installierten und registrierten Microservices des AESB. In dieser Liste finden Sie detaillierte Informationen zu jedem Microservice, einschließlich seines Namens, des zugehörigen Pakets, der Version, des aktuellen Zustands und der Ressourcennutzung.
++Diese Informationen sind nützlich für die Überwachung, Fehlerbehebung und Verwaltung der Microservice-Infrastruktur.
++
++Mit den optionalen Parametern können Sie die Ausgabe filtern und spezifische Microservices oder Instanzen abrufen.
++
++|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
++|-ConnectionName|String|✅|C|Der Name der Verbindung, Informationen zu Microservice-Instanzen abgerufen werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
++|-InstanceNames|String[]|✅❌| |Gibt die Namen der Microservice-Instanzen an, die abgerufen werden sollen. Du kannst einen oder mehrere Instanznamen als String-Array übergeben.
++|-SupervisorIds|String[]|✅❌| |Filtert Microservices basierend auf den IDs ihrer übergeordneten Supervisoren. Du musst eine oder mehrere Supervisor-IDs als String-Array übergeben.
++|-ShowAllInstances|SwitchParameter|✅| |Wenn dieser Parameter angegeben wird, zeigt das Cmdlet alle Instanzen von Microservices an, einschließlich derer, die normalerweise ausgeblendet oder als inaktiv betrachtet werden könnten.
++
++=== Parameter-Sets ===
++
++Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:
++
++* **InstanceNamesParameterSetName**: Ermöglicht das Abrufen von Microservices, basierend auf ihren Instanznamen.
++* **SupervisorsParameterSetName**: Ermöglicht das Abrufen von Microservices, die bestimmten Supervisor-IDs zugeordnet sind.
++* **NotRequiredParameterSetName**: Dient hauptsächlich dazu, die ShowAllInstances-Option zu ermöglichen.
++
++Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
++
++=== **Beispiele** ===
++
++Beispiel 1: Alle Microservices auflisten
++
++{{code language="PowerShell"}}
++Get-AESBMicroservices
++{{/code}}
++
++Dieser Befehl ruft alle registrierten AESB Microservices ab und zeigt deren detaillierte Informationen an. Ohne explizite Parameterauswahl fällt dies in das //NotRequiredParameterSetName//.
++
++Beispiel 2: Einen spezifischen Microservice nach Namen abrufen
++
++{{code language="PowerShell"}}
++Get-AESBMicroservices -InstanceNames "TestMicroservice"
++
++{{/code}}
++
++Dieser Befehl ruft Informationen nur für die Microservice-Instanz mit dem Namen "TestMicroservice" ab. Hier wird das //InstanceNamesParameterSetName// verwendet.
++
++Beispiel 3: Mehrere Microservices nach Namen abrufen
++
++{{code language="PowerShell"}}
++Get-AESBMicroservices -InstanceNames "TestMicroservice1", "TestMicroservice2"
++
++{{/code}}
++
++Dieser Befehl ruft Informationen für die Microservice-Instanzen "TestMicroservice1" und "TestMicroservice2" ab, ebenfalls unter Verwendung des //InstanceNamesParameterSetName.//
++
++Beispiel 4: Alle Microservices inklusive inaktiver Instanzen anzeigen
++
++{{code language="PowerShell"}}
++Get-AESBMicroservices -ShowAllInstances
++{{/code}}
++
++Dieser Befehl zeigt alle Microservice-Instanzen an, auch diejenigen, die normalerweise ausgeblendet würden. Dies nutzt das //NotRequiredParameterSetName//.
++
++Beispiel 5: Microservices nach Supervisor-ID Filtern (GUID
++
++{{code language="PowerShell"}}
++Get-AESBMicroservices -SupervisorIds "ffffffff-ffff-ffff-ffff-ffffffffffff"
++
++{{/code}}
++
++=== **Rückgabewerte** ===
++
++Das Cmdlet gibt eine Sammlung von Objekten zurück, die jeweils die folgenden Eigenschaften für einen Microservice enthalten:
++
++* **Name**: Der eindeutige Name der Microservice-Instanz.
++* **Package**: Der Name des Pakets, zu dem der Microservice gehört.
++* **PackageVersion**: Die Version des zugehörigen Pakets.
++* **TemplateName**: Der Name der Vorlage, die zum Erstellen dieser Microservice-Instanz verwendet wurde.
++* **InstanceId**: Eine eindeutige ID der Microservice-Instanz (GUID).
++* **Routing**: Informationen zum Routing des Microservices (in der Regel ein leeres Array, wenn keine spezifischen Routing-Regeln konfiguriert sind).
++* **IndividualSicsCredentials**: Zeigt an, ob der Microservice individuelle SICS-Anmeldeinformationen verwendet (True/False).
++* **LoggingEnabled**: Zeigt an, ob die Protokollierung für den Microservice aktiviert ist (True/False).
++* **StartupType**: Der Starttyp des Microservices (z.B. Manuell oder Automatisch).
++* **Scheduling**: Informationen zur Zeitplanung des Microservices (z.B. NotAvailable, wenn keine Zeitplanung konfiguriert ist).
++* **ServiceState**: Der aktuelle Zustand des Microservices (z.B. Stopped, Running).
++* **ProcessId**: Die Prozess-ID des Microservices, wenn er ausgeführt wird.
++* **SicsUsername**: Der SICS-Benutzername, der vom Microservice verwendet wird.
++* **CpuUsage**: Die aktuelle CPU-Auslastung des Microservices in Prozent.
++* **MemoryUsage**: Die aktuelle Speicherauslastung des Microservices in Bytes.
++
++== 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 ==
++
++== Set-AESBMicroserviceLogging ==
++
++== Start-AESBMicroservices ==
++
++== Stop-AESBMicroservices ==
++
++= Packages =
++
++== Get-AESBMicroservicePackages ==
++
++= Templates =
++
++== Add-AESBMicroserviceTemplate ==
++
++== Export-MicroserviceTemplateConfig ==
++
++== Get-AESBMicroserviceTemplateConfig ==
++
++== Import-AESBMicroserviceTemplateConfig ==
++
++== Migrate-AESBMicroserviceTemplate ==
++
++== New-AESBMicroserviceTemplateConfig ==
++
++== Remove-AESBMicroserviceTemplate ==
++
++== Update-AESBMicroserviceTemplate ==