Changes for page Microservice Cmdlets

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

From version 2.1
edited by jklein
on 2025/06/16 13:18
Change comment: There is no comment for this version
To version 4.1
edited by jklein
on 2025/06/23 10:40
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,24 +4,589 @@
4 4  
5 5  == Add-AESBMicroservice ==
6 6  
7 -== Get-AESBMicroservice ==
7 +Mit diesem Cmdlet wird eine neue Microservice-Instanz nach der Vorlage eines Templates hinzugefügt.
8 8  
9 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
10 +|-ConnectionName|Keine|String|✅|C|Der Name der Verbindung, über die die Microservice-Instanz hinzugefügt werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
11 +|-InstanceName|Keine|String|❌|Keine|Der Name der Instanz.
12 +|-TemplateName|UseTemplateName|String|❌|Keine|Der Name des Templates für die Vorlage der Instanz.
13 +|-TemplateId|UseTemplateId|String|❌|Keine|Die Id des Templates für die Vorlage der Instanz.
14 +|-SupervisorId|Keine|String|✅|Keine|Die Id des Supervisors zu der die Instanz hinzugefügt werden soll.
15 +|-StartupType|Keine|InstanceStartType|✅|Keine|Setzt die Art der Zeitplanung der Instanz.
16 +|-StoppedAfterCreation|Keine|Bool|✅|Keine|Setzt den Wert um die Instanz direkt nach der Erstellung zu starten.
17 +
18 +=== **Beispiele** ===
19 +
20 +Beispiel 1: Microservice über Template-Name hinzufügen
21 +
22 +{{code language="PowerShell"}}
23 +Add-AESBMicroservice -InstanceName "Test" -TemplateName "Tester"
24 +{{/code}}
25 +
26 +Dieses Beispiel fügt eine neue Instanz mithilfe des Template-Namen hinzu. Die Standardverbindung wird verwendet.
27 +
28 +Beispiel 2: Microservice über Template-Id hinzufügen
29 +
30 +{{code language="PowerShell"}}
31 +Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff"
32 +
33 +{{/code}}
34 +
35 +(% class="wikigeneratedid" %)
36 +Dieses Beispiel fügt eine neue Instanz mithilfe der Template-Id hinzu. Die Standardverbindung wird verwendet.
37 +
38 +Beispiel 3: Microservice StartUpType beim Hinzufügen setze
39 +
40 +{{code language="PowerShell"}}
41 +Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StartupType Manual
42 +{{/code}}
43 +
44 +Dieses Beispiel fügt eine neue Instanz mithilfe der Template-Id hinzu und setzt den //StartupType// auf //Manuell//. Die Standardverbindung wird verwendet.
45 +
46 +Beispiel 4: Microservice mit SupervisorId setzen
47 +
48 +{{code language="PowerShell"}}
49 +Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff"
50 +
51 +{{/code}}
52 +
53 +Dieses Beispiel fügt eine neue Instanz einen bestimmten Supervisor hinzu, der über die Supervisor-Id angegeben wird. Die Standardverbindung wird verwendet.
54 +
55 +Beispiel 5: Microservice mit StoppedAfterCreation setze
56 +
57 +{{code language="PowerShell"}}
58 +Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StoppedAfterCreation false
59 +
60 +{{/code}}
61 +
62 +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.
63 +
64 +Beispiel 6: Microservice mit vielen Parametern
65 +
66 +{{code language="PowerShell"}}
67 +Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StartupType Manual -StoppedAfterCreation false
68 +{{/code}}
69 +
70 +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
71 +
72 +(% style="color:inherit; font-family:inherit; font-size:25px; font-weight:bold" %)**Get-AESBMicroservice**
73 +
74 +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.
75 +Diese Informationen sind nützlich für die Überwachung, Fehlerbehebung und Verwaltung der Microservice-Infrastruktur.
76 +
77 +Mit den optionalen Parametern können Sie die Ausgabe filtern und spezifische Microservices oder Instanzen abrufen.
78 +
79 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
80 +|-ConnectionName|String|✅|C|Der Name der Verbindung, Informationen zu Microservice-Instanzen abgerufen werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
81 +|-InstanceNames|String[]|✅❌| |Gibt die Namen der Microservice-Instanzen an, die abgerufen werden sollen. Du kannst einen oder mehrere Instanznamen als String-Array übergeben.
82 +|-SupervisorIds|String[]|✅❌| |Filtert Microservices basierend auf den IDs ihrer übergeordneten Supervisoren. Du musst eine oder mehrere Supervisor-IDs als String-Array übergeben.
83 +|-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.
84 +
85 +=== Parameter-Sets ===
86 +
87 +Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:
88 +
89 +* **InstanceNamesParameterSetName**: Ermöglicht das Abrufen von Microservices, basierend auf ihren Instanznamen.
90 +* **SupervisorsParameterSetName**: Ermöglicht das Abrufen von Microservices, die bestimmten Supervisor-IDs zugeordnet sind.
91 +* **NotRequiredParameterSetName**: Dient hauptsächlich dazu, die ShowAllInstances-Option zu ermöglichen.
92 +
93 +Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
94 +
95 +=== **Beispiele** ===
96 +
97 +Beispiel 1: Alle Microservices auflisten
98 +
99 +{{code language="PowerShell"}}
100 +Get-AESBMicroservices
101 +{{/code}}
102 +
103 +Dieser Befehl ruft alle registrierten AESB Microservices ab und zeigt deren detaillierte Informationen an. Ohne explizite Parameterauswahl fällt dies in das //NotRequiredParameterSetName//.
104 +
105 +Beispiel 2: Einen spezifischen Microservice nach Namen abrufen
106 +
107 +{{code language="PowerShell"}}
108 +Get-AESBMicroservices -InstanceNames "TestMicroservice"
109 +
110 +{{/code}}
111 +
112 +Dieser Befehl ruft Informationen nur für die Microservice-Instanz mit dem Namen "TestMicroservice" ab. Hier wird das //InstanceNamesParameterSetName// verwendet.
113 +
114 +Beispiel 3: Mehrere Microservices nach Namen abrufen
115 +
116 +{{code language="PowerShell"}}
117 +Get-AESBMicroservices -InstanceNames "TestMicroservice1", "TestMicroservice2"
118 +
119 +{{/code}}
120 +
121 +Dieser Befehl ruft Informationen für die Microservice-Instanzen "TestMicroservice1" und "TestMicroservice2" ab, ebenfalls unter Verwendung des //InstanceNamesParameterSetName.//
122 +
123 +Beispiel 4: Alle Microservices inklusive inaktiver Instanzen anzeigen
124 +
125 +{{code language="PowerShell"}}
126 +Get-AESBMicroservices -ShowAllInstances
127 +{{/code}}
128 +
129 +Dieser Befehl zeigt alle Microservice-Instanzen an, auch diejenigen, die normalerweise ausgeblendet würden. Dies nutzt das //NotRequiredParameterSetName//.
130 +
131 +Beispiel 5: Microservices nach Supervisor-ID Filtern (GUID
132 +
133 +{{code language="PowerShell"}}
134 +Get-AESBMicroservices -SupervisorIds "ffffffff-ffff-ffff-ffff-ffffffffffff"
135 +
136 +{{/code}}
137 +
138 +=== **Rückgabewerte** ===
139 +
140 +Das Cmdlet gibt eine Sammlung von Objekten zurück, die jeweils die folgenden Eigenschaften für einen Microservice enthalten:
141 +
142 +* **Name**: Der eindeutige Name der Microservice-Instanz.
143 +* **Package**: Der Name des Pakets, zu dem der Microservice gehört.
144 +* **PackageVersion**: Die Version des zugehörigen Pakets.
145 +* **TemplateName**: Der Name der Vorlage, die zum Erstellen dieser Microservice-Instanz verwendet wurde.
146 +* **InstanceId**: Eine eindeutige ID der Microservice-Instanz (GUID).
147 +* **Routing**: Informationen zum Routing des Microservices (in der Regel ein leeres Array, wenn keine spezifischen Routing-Regeln konfiguriert sind).
148 +* **IndividualSicsCredentials**: Zeigt an, ob der Microservice individuelle SICS-Anmeldeinformationen verwendet (True/False).
149 +* **LoggingEnabled**: Zeigt an, ob die Protokollierung für den Microservice aktiviert ist (True/False).
150 +* **StartupType**: Der Starttyp des Microservices (z.B. Manuell oder Automatisch).
151 +* **Scheduling**: Informationen zur Zeitplanung des Microservices (z.B. NotAvailable, wenn keine Zeitplanung konfiguriert ist).
152 +* **ServiceState**: Der aktuelle Zustand des Microservices (z.B. Stopped, Running).
153 +* **ProcessId**: Die Prozess-ID des Microservices, wenn er ausgeführt wird.
154 +* **SicsUsername**: Der SICS-Benutzername, der vom Microservice verwendet wird.
155 +* **CpuUsage**: Die aktuelle CPU-Auslastung des Microservices in Prozent.
156 +* **MemoryUsage**: Die aktuelle Speicherauslastung des Microservices in Bytes.
157 +
9 9  == Edit-AESBMicroservices ==
10 10  
160 +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.
161 +
162 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=Datentyp|=Optional|=Beschreibung
163 +|-ConnectionName| |String|✅|Der Name der Verbindung, über die Microservice-Instanzen bearbeitet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
164 +|-InstanceName|NoCredentialParameterSetName,
165 +CredentialParameterSetName|String|❌|Gibt den eindeutigen Namen der Microservice-Instanz an, deren Konfiguration geändert werden soll. Dieser Parameter ist in beiden Parametersets obligatorisch.
166 +|-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.
167 +|-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.
168 +|-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.
169 +|-StartupType|NoCredentialParameterSetName,
170 +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).
171 +
172 +=== Parameter-Sets ===
173 +
174 +Das Cmdlet verwendet Parameter-Sets, um zwei Hauptszenarien zu unterstützen:
175 +
176 +* **NoCredentialParameterSetName**: Ermöglicht die Bearbeitung des Starttyps ohne die Angabe von Anmeldeinformationen.
177 +* **CredentialParameterSetName**: Ermöglicht die Bearbeitung des Starttyps //und// die Konfiguration von Anmeldeinformationen für den Microservice.
178 +
179 +Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
180 +
181 +=== Beispiele ===
182 +
183 +Beispiel 1: Starttyp eines Microservice auf "Automatisch" ändern
184 +
185 +{{code language="PowerShell"}}
186 +Edit-AESBMicroservice -InstanceName "TestMicroservice1" -StartupType Automatic
187 +
188 +{{/code}}
189 +
190 +Dieser Befehl ändert den Starttyp des Microservice mit dem Namen "TestMicroservice" auf "Automatisch". Hier wird das //NoCredentialParameterSetName// verwendet.
191 +
192 +Beispiel 2: Starttyp ändern und individuelle Anmeldeinformationen festlegen
193 +
194 +{{code language="PowerShell" layout="LINENUMBERS"}}
195 +$password = ConvertTo-SecureString "YourSecurePassword" -AsPlainText -Force
196 +Edit-AESBMicroservice -InstanceName "TestMicroservice" -UseCredentials -Username "MySicsUser" -Password $password -StartupType Automatic
197 +{{/code}}
198 +
199 +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.
200 +
11 11  == Kill-AESBMicroservices ==
12 12  
203 +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.
204 +
205 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=Datentyp|=Optional|=Beschreibung
206 +|-ConnectionName| |String|✅|Der Name der Verbindung, über welche die Ausführung von Microservice-Instanzen abgebrochen werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
207 +|-InstanceIds|UseMicroservicesIdListParameterSet|String[]|✅❌|Gibt eine Liste von eindeutigen Instanz-IDs (GUIDs als String) der Microservices an, die beendet werden sollen.
208 +|-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.
209 +
210 +=== Parameter-Sets ===
211 +
212 +Das Cmdlet verwendet Parameter-Sets, um diese beiden Betriebsmodi zu unterscheiden:
213 +
214 +* **UseMicroservicesIdListParameterSet**: Ermöglicht das Ansprechen von Microservices über eine Liste ihrer eindeutigen Instanz-IDs.
215 +* **UseSupervisorIdParameterSet**: Ermöglicht das Ansprechen von Microservices durch Angabe der ID ihres Supervisoren. Alle Microservices, die diesem Supervisor zugeordnet sind, werden beendet.
216 +
217 +Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
218 +
219 +=== Beispiele ===
220 +
221 +Beispiel 1: Einen spezifischen Microservice mit seiner Instanz-ID beenden
222 +
223 +{{code language="PowerShell"}}
224 +Kill-AESBMicroservices -InstanceIds "ffffffff-ffff-ffff-ffff-ffffffffffff"
225 +
226 +{{/code}}
227 +
228 +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.
229 +
230 +Beispiel 2: Mehrere Microservices mit ihren Instanz-IDs beenden
231 +
232 +{{code language="PowerShell"}}
233 +Kill-AESBMicroservices -InstanceIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2"
234 +
235 +{{/code}}
236 +
237 +Dieser Befehl versucht, die Microservices mit den angegebenen Instanz-IDs zu beenden.
238 +
239 +Beispiel 3: Alle Microservices beenden, die einem bestimmten Supervisor zugeordnet sin
240 +
241 +{{code language="PowerShell"}}
242 +Kill-AESBMicroservices -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff"
243 +{{/code}}
244 +
245 +Dieser Befehl beendet alle Microservices, die dem Supervisor mit der angegebenen ID zugeordnet sind. Hier wird das //UseSupervisorIdParameterSet// verwendet.
246 +
247 +=== Rückgabewerte ===
248 +
249 +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:
250 +
251 +* **Status**: Der Status der Beendigungsoperation (z.B. //Unchanged// wenn bereits gestoppt, //Stopped// wenn erfolgreich beendet).
252 +* **InstanceId**: Die eindeutige ID der betroffenen Microservice-Instanz.
253 +* **InstanceState**: Der Zustand des Microservice nach der Operation (z.B. Already stopped).
254 +* **Error**: Eine Fehlermeldung, falls die Operation nicht erfolgreich war oder ein Problem aufgetreten ist.
255 +
13 13  == Move-AESBMicroservices ==
14 14  
258 +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.
259 +
260 +
261 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
262 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen verschoben werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
263 +|-InstanceIds|String[]|❌| |Die IDs der zu verschiebenden Microservice-Instanzen (Pflichtfeld, unterstützt mehrere Werte)
264 +|-SupervisorId|String|❌| |Die Ziel-SupervisorId, auf die die Instanzen verschoben werden sollen
265 +|-Timeout|String|✅| |Optionales Timeout für die Operation (Standard: "30s")
266 +|-NoWait|SwitchParameter|✅| |Gibt an, ob das Cmdlet auf den Abschluss der Operation warten soll (asynchron)
267 +
268 +=== Beispiele ===
269 +
270 +Beispiel 1: Einen Microservice zu einem neuen Supervisor verschieben
271 +
272 +{{code language="PowerShell"}}
273 +Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa"
274 +{{/code}}
275 +
276 +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".
277 +
278 +Das Cmdlet wartet, bis der Vorgang abgeschlossen ist (Standard-Timeout von 30 Sekunden).
279 +
280 +Beispiel 2: Mehrere Microservices zu einem neuen Supervisor verschieben und nicht auf Abschluss warten.
281 +
282 +{{code language="PowerShell"}}
283 +Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -NoWait
284 +
285 +{{/code}}
286 +
287 +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.
288 +
289 +Beispiel 3: Einen Microservice verschieben mit längerem Timeout
290 +
291 +{{code language="PowerShell"}}
292 +Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -Timeout "5m"
293 +{{/code}}
294 +
295 +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.
296 +
297 +=== Rückgabewerte ===
298 +
299 +Das Cmdlet gibt für jede verschobene Instanz ein Objekt mit folgenden Eigenschaften zurück:
300 +
301 +* **InstanceId**: Die ID der verschobenen Microservice-Instanz
302 +* **SicsUsername**: Der zugehörige Benutzername (z. B. für die Verbindung)
303 +* **IsIdentified**: Gibt an, ob die Instanz eindeutig identifiziert wurde
304 +* **ProcessState**: Aktueller Prozessstatus der Instanz (z. B. Stopped)
305 +* **LastUpdate**: Zeitpunkt der letzten Statusänderung
306 +* **Timestamp**: Zeitstempel der letzten Änderung
307 +* **ProcessId**: (Optional) Prozess-ID der Instanz
308 +* **CpuUsage**: (Optional) CPU-Auslastung der Instanz
309 +* **RamUsage**: (Optional) RAM-Auslastung der Instanz
310 +
15 15  == Remove-AESBMicroservices ==
16 16  
313 +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.
314 +
315 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
316 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen entfernt werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
317 +|-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//.
318 +|-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//.
319 +
320 +=== Beispiele ===
321 +
322 +Beispiel 1: Einen Microservice anhand seiner Instanz-ID entfernen
323 +
324 +{{code language="PowerShell"}}
325 +Remove-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"
326 +{{/code}}
327 +
328 +Dieser Befehl entfernt den Microservice mit der Instanz-ID "b6cb7044-b6b2-4a64-9997-29f0ea5283db". Die Ausgabe zeigt die Instanz und das Ergebnis "Success".
329 +
330 +Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs entfernen
331 +
332 +{{code language="PowerShell"}}
333 +Remove-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"
334 +{{/code}}
335 +
336 +Dieser Befehl entfernt zwei Microservices, die durch ihre jeweiligen Instanz-IDs identifiziert werden.
337 +
338 +Beispiel 3: Einen Microservice anhand seines Namens entfernen
339 +
340 +{{code language="PowerShell"}}
341 +Remove-AESBMicroservice -InstanceNames "MeinService"
342 +
343 +{{/code}}
344 +
345 +Dieser Befehl entfernt den Microservice mit dem Namen "MeinService".
346 +
347 +Beispiel 4: Mehrere Microservices anhand ihrer Namen entfernen und Bestätigung anfordern
348 +
349 +{{code language="PowerShell"}}
350 +Remove-AESBMicroservice -InstanceNames "Service1", "Service2" -Confirm
351 +{{/code}}
352 +
353 +Dieser Befehl versucht, die Microservices "Service1" und "Service2" zu entfernen. Vor dem eigentlichen Entfernen wird der Benutzer um Bestätigung gebeten.
354 +
355 +Beispiel 5: Microservices über die Pipeline anhand von Instanz-IDs entfernen
356 +
357 +{{code language="PowerShell"}}
358 +"aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" | Remove-AESBMicroservice -InstanceIds
359 +
360 +{{/code}}
361 +
362 +Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Remove-Microservice`, um die entsprechenden Microservices zu entfernen.
363 +
364 +=== Rückgabewerte ===
365 +
366 +Das Cmdlet gibt für jeden versuchten Entfernungsvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
367 +
368 +* **Instance**: Die ID oder der Name des Microservices.
369 +* **Result**: Das Ergebnis des Entfernungsvorgangs (z.B. "Success", "Failed").
370 +
17 17  == Restart-AESBMicroservices ==
18 18  
373 +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.
374 +
375 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
376 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen neugestartet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
377 +|-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.
378 +|-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.
379 +|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Neustartvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
380 +|-NoWait|SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Neustartvorgangs, sondern kehrt sofort zurück.
381 +
382 +==== **Beispiele** ====
383 +
384 +Beispiel 1: Einen Microservice anhand seiner Instanz-ID neu starten
385 +
386 +{{code language="PowerShell"}}
387 +Restart-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"
388 +{{/code}}
389 +
390 +Dieser Befehl startet den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" neu und wartet auf das Ergebnis.
391 +
392 +Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs neu starten mit Timeout
393 +
394 +{{code language="PowerShell"}}
395 +Restart-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -Timeout "1m"
396 +
397 +{{/code}}
398 +
399 +Dieser Befehl startet zwei Microservices neu und setzt das Timeout für den Vorgang auf eine Minute.
400 +
401 +Beispiel 3: Alle Microservices eines Supervisors neu starten, ohne auf den Abschluss zu warten
402 +
403 +{{code language="PowerShell"}}
404 +Restart-AESBMicroservices -SupervisorId "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -NoWait
405 +{{/code}}
406 +
407 +Dieser Befehl initiiert den Neustart aller Microservices, die vom Supervisor "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" verwaltet werden, und kehrt sofort zurück.
408 +
409 +Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs neu starten
410 +
411 +{{code language="PowerShell"}}
412 +"aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" | Restart-AESBMicroservices
413 +{{/code}}
414 +
415 +Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Restart-Microservices`, um die entsprechenden Microservices neu zu starten.
416 +
417 +=== Rückgabewert ===
418 +
419 +Das Cmdlet gibt für jeden versuchten Neustartvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
420 +
421 +* **Name**: Der Name des Microservices.
422 +* **InstanceId**: Die Instanz-ID des Microservices.
423 +* **RestartRequested**: Zeitstempel, wann der Neustart angefordert wurde.
424 +* **RestartSucceeded**: Zeitstempel, wann der Neustart erfolgreich war (oder leer/Fehlerdatum bei Misserfolg).
425 +* **Status**: Das Ergebnis des Neustartvorgangs (z.B. "Success", "Failed", "InProgress").
426 +
19 19  == Set-AESBMicroserviceLogging ==
20 20  
429 +Mit diesem Cmdlet können Sie die Logging-Einstellungen für die angegebenen Microservice-Instanzen konfigurieren. Es kann verwendet werden, um das Logging entweder zu aktivieren (mit `-Enable`) oder zu deaktivieren (mit `-Disable`). Dabei muss einer der Parameter `-Enable` oder `-Disable` zusammen mit `-InstanceIds` angegeben werden.
430 +
431 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
432 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die das Logging von Microservice-Instanzen aktiviert / deaktiviert werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
433 +|-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.
434 +|-Enable|SwitchParameter|✅❌|Keine|Aktiviert das Logging für die angegebenen Microservices. Obligatorisch für Parametersatz `SwitchEnable`. Kann nicht zusammen mit `-Disable` verwendet werden.
435 +|-Disable|SwitchParameter|✅❌|Keine|Deaktiviert das Logging für die angegebenen Microservices. Obligatorisch für Parametersatz `SwitchDisable`. Kann nicht zusammen mit `-Enable` verwendet werden.
436 +
437 +=== **Beispiele** ===
438 +
439 +Beispiel 1: Logging für einen Microservice aktivieren
440 +
441 +{{code language="PowerShell"}}
442 +Set-AESBMicroserviceLogging -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -Enable
443 +{{/code}}
444 +
445 +Dieser Befehl aktiviert das Logging für den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffffffff1".
446 +
447 +Beispiel 2: Logging für mehrere Microservices deaktivieren
448 +
449 +{{code language="PowerShell"}}
450 +Set-AESBMicroserviceLogging -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -Disable
451 +
452 +{{/code}}
453 +
454 +Dieser Befehl deaktiviert das Logging für die Microservices mit den angegebenen Instanz-IDs.
455 +
456 +Beispiel 3: Logging für einen Microservice über die Pipeline aktivieren
457 +
458 +{{code language="PowerShell"}}
459 +"aaaaaaaa-ffff-ffff-ffff-fffffffffff1" | Set-AESBMicroserviceLogging -Enable
460 +
461 +{{/code}}
462 +
463 +Dieser Befehl übergibt eine Instanz-ID über die Pipeline an `Set-MicroserviceLogging`, um das Logging für den entsprechenden Microservice zu aktivieren.
464 +
465 +=== Rückgabewerte ===
466 +
467 +Das Cmdlet gibt für jede Instanz, deren Logging-Status geändert wurde, ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
468 +
469 +* **Status**: Der Status der Operation (z.B. "Changed", "Unchanged", "Failed").
470 +* **MicroserviceId**: Die Instanz-ID des Microservices.
471 +* **MicroserviceName**: Der Name des Microservices.
472 +* **Logging**: Der neue Logging-Status (True oder False).
473 +
21 21  == Start-AESBMicroservices ==
22 22  
476 +Mit diesem Cmdlet starten Sie die angegebenen, zuvor gestoppten Microservice-Instanzen. Die zu startenden Microservices können entweder über ihre `InstanceIds` oder über eine `SupervisorId` (die alle zugehörigen Instanzen startet) identifiziert werden. Es muss einer der Parameter `-InstanceIds` oder `-SupervisorId` angegeben werden.
477 +
478 +
479 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
480 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestartet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
481 +|-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestartet werden sollen. Obligatorisch für Parametersatz `SupervisorParametersetName`.
482 +|-InstanceIds|String[]|❌|Keine|Gibt die eindeutigen Instanz-IDs (GUIDs) der Microservices an, die gestartet werden sollen. Es kann eine einzelne ID oder ein Array von IDs übergeben werden. Obligatorisch für Parametersatz `InstanceIdsParametersetName`.
483 +|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Startvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
484 +|-NoWait      |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Startvorgangs, sondern kehrt sofort zurück.
485 +
486 +=== **Beispiele** ===
487 +
488 +Beispiel 1: Einen Microservice anhand seiner Instanz-ID starten
489 +
490 +{{code language="PowerShell"}}
491 +Start-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffff1"
492 +
493 +{{/code}}
494 +
495 +Dieser Befehl startet den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffff1" und wartet auf das Ergebnis.
496 +
497 +Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs starten mit Timeout
498 +
499 +{{code language="PowerShell"}}
500 +Start-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffff2" -Timeout "1m"
501 +
502 +{{/code}}
503 +
504 +Dieser Befehl startet zwei Microservices und setzt das Timeout für den Vorgang auf eine Minute.
505 +
506 +Beispiel 3: Alle Microservices eines Supervisors starten, ohne auf den Abschluss zu warten
507 +
508 +{{code language="PowerShell"}}
509 +Start-AESBMicroservices -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -NoWait
510 +
511 +{{/code}}
512 +
513 +Dieser Befehl initiiert den Start aller Microservices, die vom Supervisor "ffffffff-ffff-ffff-ffff-aaaaaaaa" verwaltet werden, und kehrt sofort zurück.
514 +
515 +Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs starten
516 +
517 +{{code language="PowerShell"}}
518 +"aaaaaaaa-ffff-ffff-ffff-fffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffff2" | Start-AESBMicroservices
519 +
520 +{{/code}}
521 +
522 +Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Start-Microservices`, um die entsprechenden Microservices zu starten.
523 +
524 +=== **Rückgabewert** ===
525 +
526 +Das Cmdlet gibt für jeden versuchten Startvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
527 +
528 +* **InstanceName**: Der Name des Microservices.
529 +* **InstanceId:** Die Instanz-ID des Microservices.
530 +* **Status**: Das Ergebnis des Startvorgangs (z.B. "Started", "Failed", "AlreadyRunning").
531 +
23 23  == Stop-AESBMicroservices ==
24 24  
534 +Mit diesem Cmdlet werden die angegebenen, laufenden Microservice-Instanzen gestoppt. Die zu stoppenden Microservices können entweder über ihre `InstanceIds` oder über eine `SupervisorId` (die alle zugehörigen Instanzen stoppt) identifiziert werden. Es muss einer der Parameter `-InstanceIds` oder `-SupervisorId` angegeben werden.
535 +
536 +
537 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
538 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestoppt werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
539 +|-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestoppt werden sollen. Obligatorisch für Parametersatz `UseSupervisorIdParameterSet`.
540 +|-InstanceIds|String[]|❌|Keine|Gibt die eindeutigen Instanz-IDs (GUIDs) der Microservices an, die gestoppt werden sollen. Es kann eine einzelne ID oder ein Array von IDs übergeben werden. Obligatorisch für Parametersatz `UseMicroservicesIdListParameterSet`.
541 +|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Stoppvorgang an (z.B. "5s", "1m"). Standardwert: "5s".
542 +|-NoWait      |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Stoppvorgangs, sondern kehrt sofort zurück.
543 +
544 +=== **Beispiele** ===
545 +
546 +Beispiel 1: Einen Microservice anhand seiner Instanz-ID stoppen
547 +
548 +{{code language="PowerShell"}}
549 +Stop-AESBMicroservices -InstanceIds "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1"
550 +{{/code}}
551 +
552 +Dieser Befehl stoppt den Microservice mit der Instanz-ID "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1" und wartet auf das Ergebnis.
553 +
554 +Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs stoppen mit Timeout
555 +
556 +{{code language="PowerShell"}}
557 +Stop-AESBMicroservices -InstanceIds "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" -Timeout "10s"
558 +
559 +{{/code}}
560 +
561 +Dieser Befehl stoppt zwei Microservices und setzt das Timeout für den Vorgang auf zehn Sekunden.
562 +
563 +Beispiel 3: Alle Microservices eines Supervisors stoppen, ohne auf den Abschluss zu warten
564 +
565 +{{code language="PowerShell"}}
566 +Stop-AESBMicroservices -SupervisorId "FinanceSupervisor" -NoWait
567 +
568 +{{/code}}
569 +
570 +Dieser Befehl initiiert den Stoppvorgang aller Microservices, die vom Supervisor "FinanceSupervisor" verwaltet werden, und kehrt sofort zurück.
571 +
572 +Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs stoppen
573 +
574 +{{code language="PowerShell"}}
575 +"c7e323e9-abc1-4150-a4a3-afb4e57e9cb1", "another-guid-for-stop" | Stop-AESBMicroservices
576 +
577 +{{/code}}
578 +
579 +Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Stop-AESBMicroservices`, um die entsprechenden Microservices zu stoppen.
580 +
581 +=== **Rückgabewert** ===
582 +
583 +Das Cmdlet gibt für jeden versuchten Stoppvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
584 +
585 +* **Status**: Der Status der Operation (z.B. "Changed", "Unchanged", "Failed")
586 +* **InstanceId**: Die Instanz-ID des Microservices.
587 +* **InstanceState**: Der Zustand des Microservices nach dem versuchten Stoppvorgang (z.B. "Stopped", "Running").
588 +* **Error**: Fehlermeldungen, falls der Stoppvorgang nicht erfolgreich war.
589 +
25 25  = Packages =
26 26  
27 27  == Get-AESBMicroservicePackages ==
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community