Changes for page Microservice Cmdlets

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

From version 4.5
edited by jklein
on 2025/06/24 10:56
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

Summary

Details

Page properties
Content
... ... @@ -180,7 +180,7 @@
180 180  
181 181  === Beispiele ===
182 182  
183 -Beispiel 1: Starttyp eines Microservice auf "Automatisch" ändern
183 +Beispiel 1: Starttyp eines Microservice auf "Automatisch" änder
184 184  
185 185  {{code language="PowerShell"}}
186 186  Edit-AESBMicroservice -InstanceName "TestMicroservice1" -StartupType Automatic
... ... @@ -189,7 +189,7 @@
189 189  
190 190  Dieser Befehl ändert den Starttyp des Microservice mit dem Namen "TestMicroservice" auf "Automatisch". Hier wird das //NoCredentialParameterSetName// verwendet.
191 191  
192 -Beispiel 2: Starttyp ändern und individuelle Anmeldeinformationen festlegen
192 +Beispiel 2: Starttyp ändern und individuelle Anmeldeinformationen festlege
193 193  
194 194  {{code language="PowerShell" layout="LINENUMBERS"}}
195 195  $password = ConvertTo-SecureString "YourSecurePassword" -AsPlainText -Force
... ... @@ -200,572 +200,30 @@
200 200  
201 201  == Kill-AESBMicroservices ==
202 202  
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.
203 +Mit diesem Cmdlet können Sie laufende Microservices gezielt beenden.
204 +Dies ist nützlich für die Wartung, Fehlerbehebung oder das Herunterfahren bestimmter Microservice-Instanzen.
205 +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 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 -
256 256  == Move-AESBMicroservices ==
257 257  
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 -
311 311  == Remove-AESBMicroservices ==
312 312  
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 -
371 371  == Restart-AESBMicroservices ==
372 372  
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 -
427 427  == Set-AESBMicroserviceLogging ==
428 428  
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 -
474 474  == Start-AESBMicroservices ==
475 475  
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 -
532 532  == Stop-AESBMicroservices ==
533 533  
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 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
537 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestoppt werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
538 -|-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestoppt werden sollen. Obligatorisch für Parametersatz `UseSupervisorIdParameterSet`.
539 -|-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`.
540 -|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Stoppvorgang an (z.B. "5s", "1m"). Standardwert: "5s".
541 -|-NoWait      |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Stoppvorgangs, sondern kehrt sofort zurück.
542 -
543 -=== **Beispiele** ===
544 -
545 -Beispiel 1: Einen Microservice anhand seiner Instanz-ID stoppen
546 -
547 -{{code language="PowerShell"}}
548 -Stop-AESBMicroservices -InstanceIds "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1"
549 -{{/code}}
550 -
551 -Dieser Befehl stoppt den Microservice mit der Instanz-ID "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1" und wartet auf das Ergebnis.
552 -
553 -Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs stoppen mit Timeout
554 -
555 -{{code language="PowerShell"}}
556 -Stop-AESBMicroservices -InstanceIds "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" -Timeout "10s"
557 -
558 -{{/code}}
559 -
560 -Dieser Befehl stoppt zwei Microservices und setzt das Timeout für den Vorgang auf zehn Sekunden.
561 -
562 -Beispiel 3: Alle Microservices eines Supervisors stoppen, ohne auf den Abschluss zu warten
563 -
564 -{{code language="PowerShell"}}
565 -Stop-AESBMicroservices -SupervisorId "FinanceSupervisor" -NoWait
566 -
567 -{{/code}}
568 -
569 -Dieser Befehl initiiert den Stoppvorgang aller Microservices, die vom Supervisor "FinanceSupervisor" verwaltet werden, und kehrt sofort zurück.
570 -
571 -Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs stoppen
572 -
573 -{{code language="PowerShell"}}
574 -"c7e323e9-abc1-4150-a4a3-afb4e57e9cb1", "another-guid-for-stop" | Stop-AESBMicroservices
575 -
576 -{{/code}}
577 -
578 -Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Stop-AESBMicroservices`, um die entsprechenden Microservices zu stoppen.
579 -
580 -=== **Rückgabewert** ===
581 -
582 -Das Cmdlet gibt für jeden versuchten Stoppvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
583 -
584 -* **Status**: Der Status der Operation (z.B. "Changed", "Unchanged", "Failed")
585 -* **InstanceId**: Die Instanz-ID des Microservices.
586 -* **InstanceState**: Der Zustand des Microservices nach dem versuchten Stoppvorgang (z.B. "Stopped", "Running").
587 -* **Error**: Fehlermeldungen, falls der Stoppvorgang nicht erfolgreich war.
588 -
589 589  = Packages =
590 590  
591 591  == Get-AESBMicroservicePackages ==
592 592  
593 -Dieses Cmdlet ruft eine Liste aller verfügbaren Microservice-Pakete und deren Versionen ab. Es sind keine spezifischen Parameter erforderlich.
594 -
595 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
596 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Informationen zu Microservice-Paketen abgerufen werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
597 -
598 -=== **Beispiele** ===
599 -
600 -Beispiel 1: Alle verfügbaren Microservice-Pakete auflisten
601 -
602 -{{code language="PowerShell"}}
603 -Get-AESBMicroservicePackages
604 -
605 -{{/code}}
606 -
607 -Dieser Befehl ruft alle verfügbaren Microservice-Pakete und die zugehörigen Versionen ab.
608 -
609 -=== **Rückgabewert** ===
610 -
611 -Das Cmdlet gibt für jedes gefundene Microservice-Paket ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
612 -
613 -* **PackageName**: Der Name des Microservice-Pakets.
614 -* **PackageVersions**: Eine Liste der verfügbaren Versionen für dieses Paket.
615 -
616 616  = Templates =
617 617  
618 618  == Add-AESBMicroserviceTemplate ==
619 619  
620 -Dieses Cmdlet fügt eine Microservice-Vorlage auf Basis der beigefügten Vorlagen-Konfiguration hinzu.
621 -
622 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
623 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die eine Vorlage hinzugefügt werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
624 -|-TemplateName|String|❌|Keine|Der Name für die Vorlage
625 -|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration der Vorlage
626 -
627 -=== **Beispiele** ===
628 -
629 -Beispiel 1: Fügt ein neues Microservice-Template hinzu
630 -
631 -{{code language="PowerShell"}}
632 -Add-AESBMicroserviceTemplate -TemplateName "Test" -TemplateConfig $templateConfig
633 -{{/code}}
634 -
635 -Dieses Beispiel fügt eine neue Templatekonfiguration mit dem Namen "Test" auf Basis des $templateConfig-Objekts hinzu. Die Standardverbindung wird verwendet.
636 -
637 -{{apimacro title="Beispiel der Funktion in PowerShell"}}
638 -{{code language="PowerShell" layout="LINENUMBERS"}}
639 -function Add-MicroserviceTemplate {
640 - param (
641 - [string]$Name
642 - )
643 -
644 - $packages = Get-AESBMicroservicePackages
645 -
646 - $microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packages[0].PackageName -PackageVersion $packages[0].PackageVersions[0]
647 -
648 - $addMicroserviceResult = Add-AESBMicroserviceTemplate -TemplateName $Name -TemplateConfig $microserviceTemplateConfig
649 -
650 - return $addMicroserviceResult
651 -}
652 -{{/code}}
653 -{{/apimacro}}
654 -
655 -{{apimacro title="Beispiel der Template-Konfiguration"}}
656 -{{code language="PowerShell" layout="LINENUMBERS"}}
657 -$templateConfig = "<MicroserviceConfiguration Version=`"1.11.0.895`" Type=`"SnmpConnector`" SessionKey=`"bcafdb4e94f2572eed78525430ad0e0275229f98`">
658 - <SnmpConnectorConfiguration>
659 - <SnmpReader>
660 - <ParallelRequests>10</ParallelRequests>
661 - <SchedulingConfig>
662 - <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
663 - <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
664 - <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
665 - </SchedulingConfig>
666 - <Groups />
667 - <GlobalCredentialLists>
668 - <GlobalCredentials />
669 - <GlobalCredentialsNoPriv />
670 - <GlobalCredentialsNoAuthNoPriv />
671 - </GlobalCredentialLists>
672 - </SnmpReader>
673 - <SnmpWriters>
674 - <DescriptionWriteMode>Keep</DescriptionWriteMode>
675 - <LocationWriteMode>Ignore</LocationWriteMode>
676 - <ContactWriteMode>Ignore</ContactWriteMode>
677 - <ProcessorWriter />
678 - <DispatcherStarter />
679 - <FileDumper />
680 - </SnmpWriters>
681 - </SnmpConnectorConfiguration>
682 -</MicroserviceConfiguration>"
683 -{{/code}}
684 -{{/apimacro}}
685 -
686 -=== **Rückgabewerte** ===
687 -
688 -Bei erfolgreicher Anwendung bekommt man zwei Objekte zurück.
689 -
690 -* String
691 -** Erfolgreiche Statusmeldung
692 -* TemplateInfo
693 -** TemplateId
694 -*** ID des Templates
695 -** Configuration
696 -*** Aktuelle Konfiguration des Templates
697 -** Name
698 -*** Name des Templates
699 -** Type
700 -*** Der Typ des Templates
701 -** Version
702 -*** Die Versionierung des Templates
703 -
704 -{{apimacro title="Rückgabewerte der Template-Konfiguration"}}
705 -
706 -{{/apimacro}}
707 -
708 -**Beispiel Template Konfiguration**
709 -
710 -|(((
711 -1
712 -
713 -2
714 -
715 -3
716 -
717 -4
718 -
719 -5
720 -
721 -6
722 -
723 -7
724 -
725 -8
726 -
727 -9
728 -
729 -10
730 -
731 -11
732 -
733 -12
734 -
735 -13
736 -
737 -14
738 -)))|(((
739 -Successfully added template 'Test'.
740 -
741 -
742 -TemplateId    : 119398aa-8108-43bd-811b-bd3e703e7f5c
743 -
744 -Configuration : <SnmpConnectorConfiguration><SnmpReader><ParallelRequests>10</ParallelRequests><SchedulingConfig><Sched
745 -
746 - ulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling><SchedulingConfig_Interval>P1D</Scheduling
747 -
748 - Config_Interval><SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTi
749 -
750 - me></SchedulingConfig><Groups /><GlobalCredentialLists><GlobalCredentials /><GlobalCredentialsNoPriv
751 -
752 - /><GlobalCredentialsNoAuthNoPriv /></GlobalCredentialLists></SnmpReader><SnmpWriters><DescriptionWriteM
753 -
754 - ode>Keep</DescriptionWriteMode><LocationWriteMode>Ignore</LocationWriteMode><ContactWriteMode>Ignore</C
755 -
756 - ontactWriteMode><ProcessorWriter /><DispatcherStarter /><FileDumper
757 -
758 - /></SnmpWriters></SnmpConnectorConfiguration>
759 -
760 -Name          : Test
761 -
762 -Type          : SnmpConnector
763 -
764 -Version       : 1.11.0.895
765 -)))
766 -
767 -
768 -
769 769  == Export-MicroserviceTemplateConfig ==
770 770  
771 771  == Get-AESBMicroserviceTemplateConfig ==
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community