Changes for page Microservice Cmdlets

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

From version 19.1
edited by jklein
on 2025/08/04 12:32
Change comment: There is no comment for this version
To version 3.2
edited by jklein
on 2025/06/23 09:57
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,37 +4,28 @@
4 4  
5 5  == Add-AESBMicroservice ==
6 6  
7 -Mit diesem Cmdlet wird eine neue Microservice-Instanz auf Grundlage einer bestimmten Vorlage hinzugefügt.
7 +Mit diesem Cmdlet wird eine neue Microservice-Instanz nach der Vorlage eines Templates hinzugefügt.
8 8  
9 -(% style="width:902px" %)
10 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 154px;" %)ParameterSetName|=(% style="width: 156px;" %)Datentyp|=(% style="width: 55px;" %)Optional|=(% style="width: 76px;" %)Alias|=(% style="width: 206px;" %)Beschreibung
11 -|-ConnectionName|(% style="width:154px" %)Keine|(% style="width:156px" %)String|(% style="width:55px" %)✅|(% style="width:76px" %)C|(% style="width:206px" %)Der Name der Verbindung, über die die Microservice-Instanz hinzugefügt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
12 -|-InstanceName|(% style="width:154px" %)Keine|(% style="width:156px" %)String|(% style="width:55px" %)❌|(% style="width:76px" %)Keine|(% style="width:206px" %)Der Name der Instanz.
13 -|-TemplateName|(% style="width:154px" %)UseTemplateName|(% style="width:156px" %)String|(% style="width:55px" %)❌|(% style="width:76px" %)Keine|(% style="width:206px" %)Der Name für die Vorlage der Instanz.
14 -|-TemplateId|(% style="width:154px" %)UseTemplateId|(% style="width:156px" %)String|(% style="width:55px" %)❌|(% style="width:76px" %)Keine|(% style="width:206px" %)Die Id für die Vorlage der Instanz.
15 -|-SupervisorId|(% style="width:154px" %)Keine|(% style="width:156px" %)String|(% style="width:55px" %)✅|(% style="width:76px" %)Keine|(% style="width:206px" %)Die Id des Supervisors zu der die Instanz hinzugefügt werden soll.
16 -|-StartupType|(% style="width:154px" %)Keine|(% style="width:156px" %)InstanceStartType|(% style="width:55px" %)✅|(% style="width:76px" %)Keine|(% style="width:206px" %)Setzt die Art der Zeitplanung der Instanz.
17 -|-StoppedAfterCreation|(% style="width:154px" %)Keine|(% style="width:156px" %)Bool|(% style="width:55px" %)✅|(% style="width:76px" %)Keine|(% style="width:206px" %)Setzt den Wert um die Instanz direkt nach der Erstellung zu starten.
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.
18 18  
19 -=== Parameter-Sets ===
20 -
21 -Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zum Hinzufügen von Microservices zu ermöglichen:
22 -
23 -**TemplateNameParameterSet**: Ermöglicht das Hinzufügen von Microservice-Instanzen über den Vorlagen-Namen
24 -
25 -**TemplateIdParameterSet**: Ermöglicht das Hinzufügen von Microservice-Instanzen über die Vorlagen-Id
26 -
27 27  === **Beispiele** ===
28 28  
29 -Beispiel 1: Microservice über Vorlagen-Name hinzufügen
20 +Beispiel 1: Microservice über Template-Name hinzufügen
30 30  
31 31  {{code language="PowerShell"}}
32 32  Add-AESBMicroservice -InstanceName "Test" -TemplateName "Tester"
33 33  {{/code}}
34 34  
35 -Dieses Beispiel fügt eine neue Instanz mithilfe des Vorlagen-Namen hinzu. Die Standardverbindung wird verwendet.
26 +Dieses Beispiel fügt eine neue Instanz mithilfe des Template-Namen hinzu. Die Standardverbindung wird verwendet.
36 36  
37 -Beispiel 2: Microservice über Vorlagen-Id hinzufügen
28 +Beispiel 2: Microservice über Template-Id hinzufügen
38 38  
39 39  {{code language="PowerShell"}}
40 40  Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff"
... ... @@ -42,15 +42,15 @@
42 42  {{/code}}
43 43  
44 44  (% class="wikigeneratedid" %)
45 -Dieses Beispiel fügt eine neue Instanz mithilfe der Vorlagen-Id hinzu. Die Standardverbindung wird verwendet.
36 +Dieses Beispiel fügt eine neue Instanz mithilfe der Template-Id hinzu. Die Standardverbindung wird verwendet.
46 46  
47 -Beispiel 3: Microservice-StartUpType beim Hinzufügen setzen
38 +Beispiel 3: Microservice StartUpType beim Hinzufügen setze
48 48  
49 49  {{code language="PowerShell"}}
50 50  Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StartupType Manual
51 51  {{/code}}
52 52  
53 -Dieses Beispiel fügt eine neue Instanz mithilfe der Vorlagen-Id hinzu und setzt den //StartupType// auf //Manuell//. Die Standardverbindung wird verwendet.
44 +Dieses Beispiel fügt eine neue Instanz mithilfe der Template-Id hinzu und setzt den //StartupType// auf //Manuell//. Die Standardverbindung wird verwendet.
54 54  
55 55  Beispiel 4: Microservice mit SupervisorId setzen
56 56  
... ... @@ -59,7 +59,7 @@
59 59  
60 60  {{/code}}
61 61  
62 -Dieses Beispiel fügt eine neue Instanz einem bestimmten Supervisor hinzu, der über die Supervisor-Id angegeben wird. Die Standardverbindung wird verwendet.
53 +Dieses Beispiel fügt eine neue Instanz einen bestimmten Supervisor hinzu, der über die Supervisor-Id angegeben wird. Die Standardverbindung wird verwendet.
63 63  
64 64  Beispiel 5: Microservice mit StoppedAfterCreation setze
65 65  
... ... @@ -78,7 +78,7 @@
78 78  
79 79  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
80 80  
81 -== (% style="color:inherit; font-family:inherit; font-size:25px; font-weight:bold" %)**Get-AESBMicroservices**(%%) ==
72 +(% style="color:inherit; font-family:inherit; font-size:25px; font-weight:bold" %)**Get-AESBMicroservice**
82 82  
83 83  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.
84 84  Diese Informationen sind nützlich für die Überwachung, Fehlerbehebung und Verwaltung der Microservice-Infrastruktur.
... ... @@ -86,7 +86,7 @@
86 86  Mit den optionalen Parametern können Sie die Ausgabe filtern und spezifische Microservices oder Instanzen abrufen.
87 87  
88 88  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
89 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über welche die Informationen zu Microservice-Instanzen abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
80 +|-ConnectionName|String|✅|C|Der Name der Verbindung, Informationen zu Microservice-Instanzen abgerufen werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
90 90  |-InstanceNames|String[]|✅❌| |Gibt die Namen der Microservice-Instanzen an, die abgerufen werden sollen. Du kannst einen oder mehrere Instanznamen als String-Array übergeben.
91 91  |-SupervisorIds|String[]|✅❌| |Filtert Microservices basierend auf den IDs ihrer übergeordneten Supervisoren. Du musst eine oder mehrere Supervisor-IDs als String-Array übergeben.
92 92  |-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.
... ... @@ -95,9 +95,9 @@
95 95  
96 96  Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:
97 97  
98 -* **InstanceNamesParameterSet**: Ermöglicht das Abrufen von Microservices, basierend auf ihren Instanz-Namen.
99 -* **SupervisorsParameterSet**: Ermöglicht das Abrufen von Microservices, die bestimmten Supervisor-IDs zugeordnet sind.
100 -* **NotRequiredParameterSet**: Dient hauptsächlich dazu, die ShowAllInstances-Option zu ermöglichen.
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.
101 101  
102 102  Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
103 103  
... ... @@ -164,26 +164,26 @@
164 164  * **CpuUsage**: Die aktuelle CPU-Auslastung des Microservices in Prozent.
165 165  * **MemoryUsage**: Die aktuelle Speicherauslastung des Microservices in Bytes.
166 166  
167 -== Edit-AESBMicroservice ==
158 +== Edit-AESBMicroservices ==
168 168  
169 169  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.
170 170  
171 171  |=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=Datentyp|=Optional|=Beschreibung
172 -|-ConnectionName| |String|✅|Der Name der Verbindung, über die Microservice-Instanzen bearbeitet werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
173 -|-InstanceName|NoCredentialParameterSet,
174 -CredentialParameterSet|String|❌|Gibt den eindeutigen Namen der Microservice-Instanz an, deren Konfiguration geändert werden soll. Dieser Parameter ist in beiden Parametersets obligatorisch.
175 -|-UseCredentials|CredentialParameterSet|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.
176 -|-UserName|CredentialParameterSet|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.
177 -|-Password|CredentialParameterSet|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.
178 -|-StartupType|NoCredentialParameterSet,
179 -CredentialParameterSet|Enum|❌|Legt fest, wie sich 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).
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).
180 180  
181 181  === Parameter-Sets ===
182 182  
183 183  Das Cmdlet verwendet Parameter-Sets, um zwei Hauptszenarien zu unterstützen:
184 184  
185 -* **NoCredentialParameterSet**: Ermöglicht die Bearbeitung des Starttyps ohne die Angabe von Anmeldeinformationen.
186 -* **CredentialParameterSet**: Ermöglicht die Bearbeitung des Starttyps //und// die Konfiguration von Anmeldeinformationen für den Microservice.
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.
187 187  
188 188  Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
189 189  
... ... @@ -212,7 +212,7 @@
212 212  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.
213 213  
214 214  |=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=Datentyp|=Optional|=Beschreibung
215 -|-ConnectionName| |String|✅|Der Name der Verbindung, über welche die Ausführung von Microservice-Instanzen abgebrochen werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
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.
216 216  |-InstanceIds|UseMicroservicesIdListParameterSet|String[]|✅❌|Gibt eine Liste von eindeutigen Instanz-IDs (GUIDs als String) der Microservices an, die beendet werden sollen.
217 217  |-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.
218 218  
... ... @@ -257,21 +257,22 @@
257 257  
258 258  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:
259 259  
260 -* **Status**: Der Status der Beendigungsoperation (z.B. //Unchanged/Changed//).
251 +* **Status**: Der Status der Beendigungsoperation (z.B. //Unchanged// wenn bereits gestoppt, //Stopped// wenn erfolgreich beendet).
261 261  * **InstanceId**: Die eindeutige ID der betroffenen Microservice-Instanz.
262 -* **InstanceState**: Der Zustand des Microservice nach der Operation (z.B. //Stopped/Already stopped//).
253 +* **InstanceState**: Der Zustand des Microservice nach der Operation (z.B. Already stopped).
263 263  * **Error**: Eine Fehlermeldung, falls die Operation nicht erfolgreich war oder ein Problem aufgetreten ist.
264 264  
265 -== Move-AESBMicroservice ==
256 +== Move-AESBMicroservices ==
266 266  
267 267  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.
268 268  
260 +
269 269  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
270 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen verschoben werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
271 -|-InstanceIds|String[]|❌| |Die IDs der zu verschiebenden Microservice-Instanzen (Pflichtfeld, unterstützt mehrere Werte).
272 -|-SupervisorId|String|❌| |Die Id des Ziel-Supervisors, auf den die Instanzen verschoben werden sollen.
273 -|-Timeout|String|✅| |Optionales Timeout für die Operation (Standard: "30s").
274 -|-NoWait|SwitchParameter|✅| |Gibt an, ob das Cmdlet auf den Abschluss der Operation warten soll (asynchron).
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)
275 275  
276 276  === Beispiele ===
277 277  
... ... @@ -325,19 +325,12 @@
325 325  |-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//.
326 326  |-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//.
327 327  
328 -=== Parameter-Sets ===
329 -
330 -Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:
331 -
332 -* **InstanceNamesParameterSet**: Ermöglicht das Abrufen von Microservices, basierend auf ihren Instanz-Namen.
333 -* **InstanceIdsParameterSet**: Ermöglicht das Abrufen von Microservices, basierend auf ihren eindeutigen Instanz-IDs.
334 -
335 335  === Beispiele ===
336 336  
337 337  Beispiel 1: Einen Microservice anhand seiner Instanz-ID entfernen
338 338  
339 339  {{code language="PowerShell"}}
340 -Remove-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"
325 +Remove-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"
341 341  {{/code}}
342 342  
343 343  Dieser Befehl entfernt den Microservice mit der Instanz-ID "b6cb7044-b6b2-4a64-9997-29f0ea5283db". Die Ausgabe zeigt die Instanz und das Ergebnis "Success".
... ... @@ -345,7 +345,7 @@
345 345  Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs entfernen
346 346  
347 347  {{code language="PowerShell"}}
348 -Remove-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"
333 +Remove-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"
349 349  {{/code}}
350 350  
351 351  Dieser Befehl entfernt zwei Microservices, die durch ihre jeweiligen Instanz-IDs identifiziert werden.
... ... @@ -353,7 +353,7 @@
353 353  Beispiel 3: Einen Microservice anhand seines Namens entfernen
354 354  
355 355  {{code language="PowerShell"}}
356 -Remove-AESBMicroservices -InstanceNames "MeinService"
341 +Remove-AESBMicroservice -InstanceNames "MeinService"
357 357  
358 358  {{/code}}
359 359  
... ... @@ -362,7 +362,7 @@
362 362  Beispiel 4: Mehrere Microservices anhand ihrer Namen entfernen und Bestätigung anfordern
363 363  
364 364  {{code language="PowerShell"}}
365 -Remove-AESBMicroservices -InstanceNames "Service1", "Service2" -Confirm
350 +Remove-AESBMicroservice -InstanceNames "Service1", "Service2" -Confirm
366 366  {{/code}}
367 367  
368 368  Dieser Befehl versucht, die Microservices "Service1" und "Service2" zu entfernen. Vor dem eigentlichen Entfernen wird der Benutzer um Bestätigung gebeten.
... ... @@ -370,11 +370,11 @@
370 370  Beispiel 5: Microservices über die Pipeline anhand von Instanz-IDs entfernen
371 371  
372 372  {{code language="PowerShell"}}
373 -"aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" | Remove-AESBMicroservices -InstanceIds
358 +"aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" | Remove-AESBMicroservice -InstanceIds
374 374  
375 375  {{/code}}
376 376  
377 -Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Remove-Microservices`, um die entsprechenden Microservices zu entfernen.
362 +Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Remove-Microservice`, um die entsprechenden Microservices zu entfernen.
378 378  
379 379  === Rückgabewerte ===
380 380  
... ... @@ -388,19 +388,12 @@
388 388  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.
389 389  
390 390  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
391 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen neugestartet werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
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.
392 392  |-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.
393 -|-SupervisorId|String[]|❌|Keine|Der SupervisorId-Parameter gibt die eindeutige ID (GUID als String) des Supervisors an. Alle Microservices, die von diesem spezifischen Supervisor verwaltet werden, werden neugestartet.
394 394  |-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Neustartvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
395 395  |-NoWait|SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Neustartvorgangs, sondern kehrt sofort zurück.
396 396  
397 -=== Parameter-Sets ===
398 -
399 -Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:
400 -
401 -* **InstanceIdsParameterSet**: Ermöglicht das Abrufen von Microservices, basierend auf ihren eindeutigen Instanz-IDs.
402 -* **SupervisorsParameterSet**: Ermöglicht das Abrufen von Microservices, die bestimmten Supervisor-IDs zugeordnet sind.
403 -
404 404  ==== **Beispiele** ====
405 405  
406 406  Beispiel 1: Einen Microservice anhand seiner Instanz-ID neu starten
... ... @@ -451,17 +451,11 @@
451 451  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.
452 452  
453 453  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
454 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die das Logging von Microservice-Instanzen aktiviert / deaktiviert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
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.
455 455  |-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.
456 456  |-Enable|SwitchParameter|✅❌|Keine|Aktiviert das Logging für die angegebenen Microservices. Obligatorisch für Parametersatz `SwitchEnable`. Kann nicht zusammen mit `-Disable` verwendet werden.
457 457  |-Disable|SwitchParameter|✅❌|Keine|Deaktiviert das Logging für die angegebenen Microservices. Obligatorisch für Parametersatz `SwitchDisable`. Kann nicht zusammen mit `-Enable` verwendet werden.
458 458  
459 -=== Parameter-Sets ===
460 -
461 -Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:
462 -
463 -* **InstanceIdsParameterSet**: Ermöglicht das Abrufen von Microservices, basierend auf ihren eindeutigen Instanz-IDs.
464 -
465 465  === **Beispiele** ===
466 466  
467 467  Beispiel 1: Logging für einen Microservice aktivieren
... ... @@ -503,20 +503,14 @@
503 503  
504 504  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.
505 505  
478 +
506 506  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
507 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestartet werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
508 -|-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 `InstanceIdsParameterset`.
509 -|-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugerige Microservices gestartet werden sollen. Obligatorisch für Parametersatz `SupervisorParameterset`.
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 zugerige 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`.
510 510  |-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Startvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
511 511  |-NoWait      |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Startvorgangs, sondern kehrt sofort zurück.
512 512  
513 -=== Parameter-Sets ===
514 -
515 -Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:
516 -
517 -* **InstanceIdsParameterSet**: Ermöglicht das Abrufen von Microservices, basierend auf ihren eindeutigen Instanz-IDs.
518 -* **SupervisorsParameterSet**: Ermöglicht das Abrufen von Microservices, die bestimmten Supervisor-IDs zugeordnet sind.
519 -
520 520  === **Beispiele** ===
521 521  
522 522  Beispiel 1: Einen Microservice anhand seiner Instanz-ID starten
... ... @@ -565,623 +565,24 @@
565 565  
566 566  == Stop-AESBMicroservices ==
567 567  
568 -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.
569 -
570 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
571 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestoppt werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
572 -|-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`.
573 -|-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestoppt werden sollen. Obligatorisch für Parametersatz `SupervisorsParameterSet`.
574 -|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Stoppvorgang an (z.B. "5s", "1m"). Standardwert: "5s".
575 -|-NoWait      |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Stoppvorgangs, sondern kehrt sofort zurück.
576 -
577 -=== Parameter-Sets ===
578 -
579 -Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:
580 -
581 -* **InstanceIdsParameterSet**: Ermöglicht das Abrufen von Microservices, basierend auf ihren eindeutigen Instanz-IDs.
582 -* **SupervisorsParameterSet**: Ermöglicht das Abrufen von Microservices, die bestimmten Supervisor-IDs zugeordnet sind.
583 -
584 -=== **Beispiele** ===
585 -
586 -Beispiel 1: Einen Microservice anhand seiner Instanz-ID stoppen
587 -
588 -{{code language="PowerShell"}}
589 -Stop-AESBMicroservices -InstanceIds "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1"
590 -{{/code}}
591 -
592 -Dieser Befehl stoppt den Microservice mit der Instanz-ID "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1" und wartet auf das Ergebnis.
593 -
594 -Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs stoppen mit Timeout
595 -
596 -{{code language="PowerShell"}}
597 -Stop-AESBMicroservices -InstanceIds "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" -Timeout "10s"
598 -
599 -{{/code}}
600 -
601 -Dieser Befehl stoppt zwei Microservices und setzt das Timeout für den Vorgang auf zehn Sekunden.
602 -
603 -Beispiel 3: Alle Microservices eines Supervisors stoppen, ohne auf den Abschluss zu warten
604 -
605 -{{code language="PowerShell"}}
606 -Stop-AESBMicroservices -SupervisorId "FinanceSupervisor" -NoWait
607 -
608 -{{/code}}
609 -
610 -Dieser Befehl initiiert den Stoppvorgang aller Microservices, die vom Supervisor "FinanceSupervisor" verwaltet werden, und kehrt sofort zurück.
611 -
612 -Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs stoppen
613 -
614 -{{code language="PowerShell"}}
615 -"c7e323e9-abc1-4150-a4a3-afb4e57e9cb1", "another-guid-for-stop" | Stop-AESBMicroservices
616 -
617 -{{/code}}
618 -
619 -Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Stop-AESBMicroservices`, um die entsprechenden Microservices zu stoppen.
620 -
621 -=== **Rückgabewert** ===
622 -
623 -Das Cmdlet gibt für jeden versuchten Stoppvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
624 -
625 -* **Status**: Der Status der Operation (z.B. "Changed", "Unchanged", "Failed")
626 -* **InstanceId**: Die Instanz-ID des Microservices.
627 -* **InstanceState**: Der Zustand des Microservices nach dem versuchten Stoppvorgang (z.B. "Stopped", "Running").
628 -* **Error**: Fehlermeldungen, falls der Stoppvorgang nicht erfolgreich war.
629 -
630 630  = Packages =
631 631  
632 632  == Get-AESBMicroservicePackages ==
633 633  
634 -Dieses Cmdlet ruft eine Liste aller verfügbaren Microservice-Pakete und deren Versionen ab. Es sind keine spezifischen Parameter erforderlich.
635 -
636 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
637 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Informationen zu Microservice-Paketen abgerufen werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
638 -
639 -=== **Beispiele** ===
640 -
641 -Beispiel 1: Alle verfügbaren Microservice-Pakete auflisten
642 -
643 -{{code language="PowerShell"}}
644 -Get-AESBMicroservicePackages
645 -
646 -{{/code}}
647 -
648 -Dieser Befehl ruft alle verfügbaren Microservice-Pakete und die zugehörigen Versionen ab.
649 -
650 -=== **Rückgabewert** ===
651 -
652 -Das Cmdlet gibt für jedes gefundene Microservice-Paket ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
653 -
654 -* **PackageName**: Der Name des Microservice-Pakets.
655 -* **PackageVersions**: Eine Liste der verfügbaren Versionen für dieses Paket.
656 -
657 657  = Templates =
658 658  
659 659  == Add-AESBMicroserviceTemplate ==
660 660  
661 -Dieses Cmdlet fügt eine Microservice-Vorlage auf Basis der beigefügten Vorlagen-Konfiguration hinzu.
662 -
663 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
664 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die eine Vorlage hinzugefügt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
665 -|-TemplateName|String|❌|Keine|Der Name für die Vorlage.
666 -|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration der Vorlage.
667 -
668 -=== **Beispiele** ===
669 -
670 -Beispiel 1: Fügt ein neue Microservice-Vorlage hinzu
671 -
672 -{{code language="PowerShell"}}
673 -Add-AESBMicroserviceTemplate -TemplateName "Test" -TemplateConfig $templateConfig
674 -{{/code}}
675 -
676 -Dieses Beispiel fügt eine neue Vorlagen-konfiguration mit dem Namen "Test" auf Basis des $templateConfig-Objekts hinzu. Die Standardverbindung wird verwendet.
677 -
678 -{{apimacro title="Beispiel der Funktion in PowerShell"}}
679 -{{code language="PowerShell" layout="LINENUMBERS"}}
680 -function Add-MicroserviceTemplate {
681 - param (
682 - [string]$Name
683 - )
684 -
685 - $packages = Get-AESBMicroservicePackages
686 -
687 - $microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packages[0].PackageName -PackageVersion $packages[0].PackageVersions[0]
688 -
689 - $addMicroserviceResult = Add-AESBMicroserviceTemplate -TemplateName $Name -TemplateConfig $microserviceTemplateConfig
690 -
691 - return $addMicroserviceResult
692 -}
693 -{{/code}}
694 -{{/apimacro}}
695 -
696 -{{apimacro title="Beispiel der Vorlagen-Konfiguration"}}
697 -{{code language="PowerShell" layout="LINENUMBERS"}}
698 -$templateConfig = "<MicroserviceConfiguration Version=`"1.11.0.895`" Type=`"SnmpConnector`" SessionKey=`"bcafdb4e94f2572eed78525430ad0e0275229f98`">
699 - <SnmpConnectorConfiguration>
700 - <SnmpReader>
701 - <ParallelRequests>10</ParallelRequests>
702 - <SchedulingConfig>
703 - <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
704 - <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
705 - <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
706 - </SchedulingConfig>
707 - <Groups />
708 - <GlobalCredentialLists>
709 - <GlobalCredentials />
710 - <GlobalCredentialsNoPriv />
711 - <GlobalCredentialsNoAuthNoPriv />
712 - </GlobalCredentialLists>
713 - </SnmpReader>
714 - <SnmpWriters>
715 - <DescriptionWriteMode>Keep</DescriptionWriteMode>
716 - <LocationWriteMode>Ignore</LocationWriteMode>
717 - <ContactWriteMode>Ignore</ContactWriteMode>
718 - <ProcessorWriter />
719 - <DispatcherStarter />
720 - <FileDumper />
721 - </SnmpWriters>
722 - </SnmpConnectorConfiguration>
723 -</MicroserviceConfiguration>"
724 -{{/code}}
725 -{{/apimacro}}
726 -
727 -=== **Rückgabewerte** ===
728 -
729 -Bei erfolgreicher Anwendung erhalten Sie zwei Objekte zurück.
730 -
731 -* String
732 -** Erfolgreiche Statusmeldung
733 -* TemplateInfo
734 -** TemplateId
735 -*** ID der Vorlage
736 -** Configuration
737 -*** Aktuelle Konfiguration der Vorlage
738 -** Name
739 -*** Name der Vorlage
740 -** Type
741 -*** Der Typ der Vorlage
742 -** Version
743 -*** Die Versionierung der Vorlage
744 -
745 -{{apimacro title="Rückgabewerte der Vorlagen-Konfiguration"}}
746 -{{code language="PowerShell" layout="LINENUMBERS"}}
747 -Successfully added template 'Test'.
748 -
749 -TemplateId : 119398aa-8108-43bd-811b-bd3e703e7f5c
750 -Configuration : <SnmpConnectorConfiguration><SnmpReader><ParallelRequests>10</ParallelRequests><SchedulingConfig><Sched
751 - ulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling><SchedulingConfig_Interval>P1D</Scheduling
752 - Config_Interval><SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTi
753 - me></SchedulingConfig><Groups /><GlobalCredentialLists><GlobalCredentials /><GlobalCredentialsNoPriv
754 - /><GlobalCredentialsNoAuthNoPriv /></GlobalCredentialLists></SnmpReader><SnmpWriters><DescriptionWriteM
755 - ode>Keep</DescriptionWriteMode><LocationWriteMode>Ignore</LocationWriteMode><ContactWriteMode>Ignore</C
756 - ontactWriteMode><ProcessorWriter /><DispatcherStarter /><FileDumper
757 - /></SnmpWriters></SnmpConnectorConfiguration>
758 -Name : Test
759 -Type : SnmpConnector
760 -Version : 1.11.0.895
761 -{{/code}}
762 -{{/apimacro}}
763 -
764 764  == Export-MicroserviceTemplateConfig ==
765 765  
766 -Dieses Cmdlet ermöglicht es, die Konfiguration einer Microservice-Vorlagen zu exportieren.
767 -
768 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
769 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
770 -|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration, die exportiert werden soll.
771 -|-Path|String|❌|Keine|Der Pfad, unter dem die Microservice-Vorlagen-Konfiguration gespeichert werden soll.
772 -
773 -=== **Beispiele** ===
774 -
775 -Beispiel 1: Microservice-Vorlage exportieren
776 -
777 -{{code language="PowerShell"}}
778 -Export-AESBMicroserviceTemplateConfig -TemplateConfig $templateConfig -Path $path
779 -
780 -{{/code}}
781 -
782 -In diesem Beispiel wird die //$templateConfig// am Speicherort "C:\Test.xml" exportiert.
783 -
784 -{{code language="PowerShell" layout="LINENUMBERS"}}
785 -function Export-MicroserviceTemplateConfig {
786 - param (
787 - [string]$Path
788 - )
789 -
790 - $microserviceTemplates = Get-AESBMicroserviceTemplates
791 -
792 - $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $microserviceTemplates[0].Name
793 -
794 - $exportMicroserviceTemplateConfigResult = Export-AESBMicroserviceTemplateConfig -TemplateConfig $microserviceTemplateConfig -Path $Path
795 -
796 - return $exportMicroserviceTemplateConfigResult
797 -}
798 -{{/code}}
799 -
800 -{{apimacro title="Beispielhafte XML-Datei nach dem Exportieren"}}
801 -{{code language="XML" layout="LINENUMBERS"}}
802 -<MicroserviceConfiguration Version="1.11.0.895" Type="SnmpConnector" SessionKey="bcafdb4e94f2572eed78525430ad0e0275229f98">
803 - <SnmpConnectorConfiguration>
804 - <SnmpReader>
805 - <ParallelRequests>10</ParallelRequests>
806 - <SchedulingConfig>
807 - <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
808 - <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
809 - <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
810 - </SchedulingConfig>
811 - <Groups />
812 - <GlobalCredentialLists>
813 - <GlobalCredentials />
814 - <GlobalCredentialsNoPriv />
815 - <GlobalCredentialsNoAuthNoPriv />
816 - </GlobalCredentialLists>
817 - </SnmpReader>
818 - <SnmpWriters>
819 - <DescriptionWriteMode>Keep</DescriptionWriteMode>
820 - <LocationWriteMode>Ignore</LocationWriteMode>
821 - <ContactWriteMode>Ignore</ContactWriteMode>
822 - <ProcessorWriter />
823 - <DispatcherStarter />
824 - <FileDumper />
825 - </SnmpWriters>
826 - </SnmpConnectorConfiguration>
827 -</MicroserviceConfiguration>
828 -{{/code}}
829 -{{/apimacro}}
830 -
831 -=== Rückgabewerte ===
832 -
833 -Nach erfolgreichem Exportieren erhalten Sie eine Statusmeldung zurück.
834 -
835 -{{code language="none"}}
836 -Writing the file was successful.
837 -
838 -{{/code}}
839 -
840 840  == Get-AESBMicroserviceTemplateConfig ==
841 841  
842 -Dieses Cmdlet fragt die TemplateConfig einer bestimmten Microservice-Vorlage ab.
843 -
844 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
845 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
846 -|-TemplateName|String|❌|Keine|Der Name der Vorlage für die gewünschte Konfiguration.
847 -
848 -=== Beispiele ===
849 -
850 -Beispiel 1: Konfiguration der Microservice-Vorlage von //$templateName// anfragen
851 -
852 -{{code language="PowerShell"}}
853 -Get-AESBMicroserviceTemplateConfig -TemplateName $templateName
854 -{{/code}}
855 -
856 -Dieses Beispiel fragt die Vorlagen-Konfiguration mit dem Namen //$templateName// an. Die Standardverbindung wird verwendet.
857 -
858 -{{code language="PowerShell" layout="LINENUMBERS"}}
859 -function Get-MicroserviceTemplateConfig {
860 -
861 - $aesbMicroserviceTemplates = Get-AESBMicroserviceTemplates
862 -
863 - $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $aesbMicroserviceTemplates[0].Name
864 -
865 - return $microserviceTemplateConfig
866 -}
867 -{{/code}}
868 -
869 -=== Rückgabewerte ===
870 -
871 -Bei erfolgreicher Anwendung erhalten Sie die gewünschte Microservice-Konfiguration zurück:
872 -
873 -* MicroserviceConfiguration
874 -** Version
875 -*** Die jeweilige Version des Microservices
876 -** Type
877 -*** Der Typ des Microservices
878 -** TypeConfiguration
879 -*** Die jeweilige Typ-Konfiguration des Microservices
880 -
881 -{{code language="PowerShell"}}
882 -$microserviceTemplateConfig
883 -
884 -MicroserviceConfiguration
885 --------------------------
886 -MicroserviceConfiguration
887 -
888 -$microserviceTemplateConfig.MicroserviceConfiguration
889 -
890 -Version Type SnmpConnectorConfiguration
891 -------- ---- --------------------------
892 -1.11.0.895 SnmpConnector SnmpConnectorConfiguration
893 -{{/code}}
894 -
895 -== Get-AESBMicroserviceTemplates ==
896 -
897 -Dieses Cmdlet fragt die vorhandenen Microservice-Vorlagen ab und listet sie auf.
898 -
899 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
900 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservices-Vorlagen-Konfiguration importiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
901 -|-PackageName|String|✅| |Der Name des Microservice-Pakets, dessen Vorlagen geholt werden sollen
902 -|-PackageVersion|String|✅| |Die Version des Pakets, dessen Vorlagen geholt werden sollen
903 -
904 -=== Beispiele ===
905 -
906 -Beispiel 1: Alle vorhandenen Microservice-Vorlagen anzeigen
907 -
908 -{{code language="PowerShell"}}
909 -Get-AESBMicroserviceTemplates
910 -{{/code}}
911 -
912 -Dieses Beispiel listet alle vorhandenen Microservice-Vorlagen auf. Die Standardverbindung wird verwendet. Falls keine Vorlagen vorhanden sind, wird ein Fehler angezeigt.
913 -
914 -Beispiel 2: Die Vorlagen eines bestimmten Microservice-Pakets einer bestimmten Version auflisten
915 -
916 -{{code language="PowerShell"}}
917 -Get-AESBMicroserviceTemplates -PackageName "SnmpConnector" -PackageVersion "1.11.0.895"
918 -
919 -{{/code}}
920 -
921 - Dieses Beispiel listet alle vorhandenen Microservice-Vorlagen des Pakets "SnmpConnector" in der Version "1.11.0.895" auf. Die Standardverbindung wird verwendet.
922 -
923 -=== Rückgabewerte ===
924 -
925 -Bei erfolgreicher Anwendung werden die gewünschten Microservice-Vorlagen als Objekte aufgelistet.
926 -
927 -* MicroserviceTemplate
928 -** Name
929 -*** Der Name der Vorlage
930 -** Id
931 -*** Die Id der Vorlage
932 -** PackageName
933 -*** Der Name des Microservice-Pakets
934 -** PackageVersion
935 -*** Die Version des Microservice-Pakets
936 -
937 -{{code language="PowerShell"}}
938 -Name Id PackageName PackageVersion
939 -
940 ----- -- ----------- --------------
941 -
942 -SnmpConnector a6e37f49-5a15-4213-96f5-e23cc03209a8 SnmpConnector 1.11.0.895
943 -
944 -PS_Microservice1 33618fc3-60f2-484b-b6c9-b9f19c5eb4fa PS_Microservice1 1.1.0.1
945 -{{/code}}
946 -
947 947  == Import-AESBMicroserviceTemplateConfig ==
948 948  
949 -Dieses Cmdlet importiert die Vorlagen-Konfiguration vom angegebenen Pfad.
950 -
951 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
952 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservices-Vorlagen-Konfiguration importiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
953 -|-Path|String|❌|Keine|Der Pfad, von dem die Konfiguration importiert werden soll.
954 -
955 -=== Beispiele ===
956 -
957 -Beispiel 1: Vorlagen-Konfiguration von //$path// laden
958 -
959 -{{code language="PowerShell"}}
960 -Import-AESBMicroserviceTemplateConfig -Path $path
961 -
962 -{{/code}}
963 -
964 -Dieses Beispiel importiert die Vorlagen-Konfiguration beim hinterlegten Pfad. Die Standardverbindung wird verwendet.
965 -
966 -=== Rückgabewerte ===
967 -
968 -Bei erfolgreicher Anwendung erhalten Sie die gewünschte MicroserviceConfiguration zurück:
969 -
970 -* MicroserviceConfiguration
971 -** Version
972 -*** Die jeweilige Version des Microservices
973 -** Type
974 -*** Der Typ des Microservices
975 -** TypeConfiguration
976 -*** Die jeweilige Typ-Konfiguration des Microservices
977 -
978 -{{code language="PowerShell"}}
979 -$microserviceTemplateConfig
980 -
981 -MicroserviceConfiguration
982 --------------------------
983 -MicroserviceConfiguration
984 -
985 -$microserviceTemplateConfig.MicroserviceConfiguration
986 -
987 -Version Type SnmpConnectorConfiguration
988 -------- ---- --------------------------
989 -1.11.0.895 SnmpConnector SnmpConnectorConfiguration
990 -{{/code}}
991 -
992 992  == Migrate-AESBMicroserviceTemplate ==
993 993  
994 -Mit diesem Cmdlet werden bestehende Vorlagen auf die gewünschte Zielversion übertragen.
995 -
996 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
997 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Vorlagen migriert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
998 -|-TemplateNames|String[]|❌|Keine|Hier sind die Namen der Vorlagen, die übertragen werden sollen.
999 -|-TargetVersion|String|❌|Keine|Die Zielversion, auf die die Vorlagen migriert werden sollen.
1000 -|-KeepTemplateIds|SwitchParameter|✅|Keine|Hier wird festgelegt, ob die bestehenden Template-IDs gleich bleiben oder beim Migrieren neu erstellt werden sollen.
1001 -
1002 -=== Beispiele ===
1003 -
1004 -Beispiel 1: Mehrere Vorlagen auf Version //$templateVersion// migrieren
1005 -
1006 -{{code language="PowerShell"}}
1007 -Migrate-AESBMicroserviceTemplates -TemplateNames $templateNames -TargetVersion $templateVersion
1008 -
1009 -{{/code}}
1010 -
1011 -Dieses Beispiel migriert alle Vorlagen, die in //$templateNames// stehen, auf die Version //$templateVersion//.
1012 -
1013 -=== Rückgabewerte ===
1014 -
1015 -Bei erfolgreicher Anwendung erhalten Sie eine Liste von Vorlagen-Informationen mit den neuen Daten der erfolgreich migrierten Vorlagen:
1016 -
1017 -* TemplateInfo
1018 -** TemplateId
1019 -*** Die neu erstellte / gleichbleibende Id der Vorlage
1020 -** Configuration
1021 -*** Die aktuelle Konfiguration der Vorlage
1022 -** Name
1023 -*** Der neue Name der Vorlage
1024 -** Type
1025 -*** Der Typ der Vorlage
1026 -** Version
1027 -*** Die neue Version der Vorlage
1028 -
1029 -{{code language="PowerShell"}}
1030 -TemplateId : ffffffff-ffff-ffff-ffff-ffffffffffff"
1031 -Configuration : <Configuration>
1032 - <SchedulingConfig>
1033 - <SchedulingConfig_Scheduling>Disabled</SchedulingConfig_Scheduling>
1034 - </SchedulingConfig>
1035 - </Configuration>
1036 -Name : TestTest_1_0_0_1
1037 -Type : Test
1038 -Version : 1.0.0.1
1039 -{{/code}}
1040 -
1041 1041  == New-AESBMicroserviceTemplateConfig ==
1042 1042  
1043 -Mit diesem Cmdlet wird eine neue Vorlagen-Konfiguration auf Basis des Pakets erstellt.
1044 -
1045 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
1046 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration erstellt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
1047 -|-PackageName|String|❌|Keine|Der Name des Pakets.
1048 -|-PackageVersion|String|❌|Keine|Die Version des Pakets.
1049 -
1050 -=== Beispiele ===
1051 -
1052 -Beispiel 1: MicroserviceTemplateConfig erstellen
1053 -
1054 -{{code language="PowerShell" layout="LINENUMBERS"}}
1055 -$packageVersion = "1.0.0.0"
1056 -$packageName = "Test"
1057 -
1058 -New-AESBMicroserviceTemplateConfig -PackageName $packageName -PackageVersion $packageVersion
1059 -{{/code}}
1060 -
1061 -Dieses Beispiel erstellt eine Vorlagen-Konfiguration auf Basis des angegebenen Microservice-Pakets.
1062 -
1063 -=== Rückgabewerte ===
1064 -
1065 -* MicroserviceConfiguration
1066 -** Version
1067 -*** Die neue Version der Vorlage
1068 -** Type
1069 -*** Der Typ der Vorlage
1070 -** Configuration
1071 -*** Die aktuelle Konfiguration der Vorlage
1072 -
1073 -{{code language="PowerShell" layout="LINENUMBERS"}}
1074 -$microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packageName -PackageVersion $packageVersion
1075 -
1076 -MicroserviceConfiguration
1077 --------------------------
1078 -MicroserviceConfiguration
1079 -
1080 -$microserviceTemplateConfig.MicroserviceConfiguration
1081 -
1082 -Version Type Configuration
1083 -------- ---- -------------
1084 -1.0.0.0 Test Configuration
1085 -{{/code}}
1086 -
1087 1087  == Remove-AESBMicroserviceTemplate ==
1088 1088  
1089 -Mit diesem Cmdlet können Sie Microservice-Vorlagen löschen.
1090 -
1091 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
1092 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen gelöscht werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
1093 -|-TemplateIds|String[]|❌|Keine|Die ID's der Vorlagen, die zu löschen sind.
1094 -|-RemoveReferences|SwitchParameter|✅|Keine|Gibt an ob alle erstellten Referenzen der Vorlagen mitgelöscht werden sollen.
1095 -
1096 -=== Beispiele ===
1097 -
1098 -Beispiel 1: Vorlage löschen
1099 -
1100 -{{code language="PowerShell"}}
1101 -Remove-AESBMicroserviceTemplate -TemplateIds 4b016fd1-47fb-4f24-87dd-4e365fe870d3
1102 -
1103 -{{/code}}
1104 -
1105 -Dieses Beispiel löscht eine Microservice-Vorlage auf Basis der angegebenen Id.
1106 -
1107 -Beispiel 2: Vorlagen löschen
1108 -
1109 -{{code language="PowerShell"}}
1110 -Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3", "D1936807-E1B0-4F8B-AB7F-98ECD202CF8F"
1111 -{{/code}}
1112 -
1113 -Dieses Beispiel löscht mehrere Microservice-Vorlagen auf Basis der angegebenen Ids.
1114 -
1115 -Beispiel 3: Vorlagen löschen mitsamt den Referenzen
1116 -
1117 -{{code language="PowerShell"}}
1118 -Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3" -RemoveReferences
1119 -
1120 -{{/code}}
1121 -
1122 -Dieses Beispiel löscht eine Microservice-Vorlage mitsamt den erstellten Referenzen der Vorlage .
1123 -
1124 -=== Rückgabewerte ===
1125 -
1126 -* RemoveMicroserviceTemplateStatusData
1127 -** StatusResult
1128 -*** Ergebnis des Resultats des Vorgangs
1129 -** TemplateId
1130 -*** Die erfolgreich gelöschte Id der Vorlage
1131 -** Message
1132 -*** Status Nachricht
1133 -
1134 -{{code language="PowerShell"}}
1135 -StatusResult TemplateId Message
1136 ------------- ---------- -------
1137 - Success bde8016f-8557-4438-a165-ab05a4a78db4 The template was successfully removed.
1138 -{{/code}}
1139 -
1140 1140  == Update-AESBMicroserviceTemplate ==
1141 -
1142 -Dieses Cmdlet aktualisiert die Microservice-Vorlage mittels der beigefügten Microservice-Vorlagen-Konfiguration.
1143 -
1144 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
1145 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlage aktualisiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
1146 -|-TemplateId|String|❌|Keine|Die ID der Vorlage, die aktualisiert werden soll.
1147 -|-TemplateConfig|XmlDocument|❌|Keine|Die neue Microservices-Vorlagen-Konfiguration, die die aktuelle Konfiguration überschreiben soll. 
1148 -
1149 -=== Beispiele ===
1150 -
1151 -Beispiel 1: Vorlage updaten
1152 -
1153 -{{code language="PowerShell" layout="LINENUMBERS"}}
1154 -$templateConfiguration = <MicroserviceConfiguration Version="1.0.0.0" Type="Test" SessionKey="72962557bb8bbd00b53dcb53d99cea685ed636bf">
1155 - <Configuration>
1156 - <SchedulingConfig>
1157 - <SchedulingConfig_Scheduling>Enabled</SchedulingConfig_Scheduling>
1158 - </SchedulingConfig>
1159 - </Configuration>
1160 -</MicroserviceConfiguration>
1161 -
1162 -
1163 -Update-AESBMicroserviceTemplate -TemplateId "838fb7e2-e293-4004-9602-7223aaa3854a" -TemplateConfig $templateConfiguration
1164 -{{/code}}
1165 -
1166 -Dieses Beispiel updated die Vorlage mit der beigefügten Konfiguration.
1167 -
1168 -=== Rückgabewerte ===
1169 -
1170 -* Templateinfo
1171 -** TemplateId
1172 -** Configuration
1173 -** Name
1174 -** Type
1175 -** Version
1176 -
1177 -{{code language="PowerShell"}}
1178 -TemplateId : 838fb7e2-e293-4004-9602-7223aaa3854a
1179 -Configuration : <Configuration>
1180 - <SchedulingConfig>
1181 - <SchedulingConfig_Scheduling>Enabled</SchedulingConfig_Scheduling>
1182 - </SchedulingConfig>
1183 - </Configuration>
1184 -Name : ASDASDASD
1185 -Type : ASD
1186 -Version : 1.0.0.0
1187 -{{/code}}
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community