Changes for page Microservice Cmdlets

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

From version 2.8
edited by jklein
on 2025/06/20 10:32
Change comment: There is no comment for this version
To version 15.1
edited by jklein
on 2025/07/30 13:47
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,28 +4,37 @@
4 4  
5 5  == Add-AESBMicroservice ==
6 6  
7 -Mit diesem Cmdlet wird eine neue Microservice-Instanz nach der Vorlage eines Templates hinzugefügt.
7 +Mit diesem Cmdlet wird eine neue Microservice-Instanz auf Grundlage einer bestimmten Vorlage 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.
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.
17 17  
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 +
18 18  === **Beispiele** ===
19 19  
20 -Beispiel 1: Microservice über Template-Name hinzufügen
29 +Beispiel 1: Microservice über Vorlagen-Name hinzufügen
21 21  
22 22  {{code language="PowerShell"}}
23 23  Add-AESBMicroservice -InstanceName "Test" -TemplateName "Tester"
24 24  {{/code}}
25 25  
26 -Dieses Beispiel fügt eine neue Instanz mithilfe des Template-Namen hinzu. Die Standardverbindung wird verwendet.
35 +Dieses Beispiel fügt eine neue Instanz mithilfe des Vorlagen-Namen hinzu. Die Standardverbindung wird verwendet.
27 27  
28 -Beispiel 2: Microservice über Template-Id hinzufügen
37 +Beispiel 2: Microservice über Vorlagen-Id hinzufügen
29 29  
30 30  {{code language="PowerShell"}}
31 31  Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff"
... ... @@ -33,15 +33,15 @@
33 33  {{/code}}
34 34  
35 35  (% class="wikigeneratedid" %)
36 -Dieses Beispiel fügt eine neue Instanz mithilfe der Template-Id hinzu. Die Standardverbindung wird verwendet.
45 +Dieses Beispiel fügt eine neue Instanz mithilfe der Vorlagen-Id hinzu. Die Standardverbindung wird verwendet.
37 37  
38 -Beispiel 3: Microservice StartUpType beim Hinzufügen setze
47 +Beispiel 3: Microservice-StartUpType beim Hinzufügen setzen
39 39  
40 40  {{code language="PowerShell"}}
41 41  Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StartupType Manual
42 42  {{/code}}
43 43  
44 -Dieses Beispiel fügt eine neue Instanz mithilfe der Template-Id hinzu und setzt den //StartupType// auf //Manuell//. Die Standardverbindung wird verwendet.
53 +Dieses Beispiel fügt eine neue Instanz mithilfe der Vorlagen-Id hinzu und setzt den //StartupType// auf //Manuell//. Die Standardverbindung wird verwendet.
45 45  
46 46  Beispiel 4: Microservice mit SupervisorId setzen
47 47  
... ... @@ -50,7 +50,7 @@
50 50  
51 51  {{/code}}
52 52  
53 -Dieses Beispiel fügt eine neue Instanz einen bestimmten Supervisor hinzu, der über die Supervisor-Id angegeben wird. Die Standardverbindung wird verwendet.
62 +Dieses Beispiel fügt eine neue Instanz einem bestimmten Supervisor hinzu, der über die Supervisor-Id angegeben wird. Die Standardverbindung wird verwendet.
54 54  
55 55  Beispiel 5: Microservice mit StoppedAfterCreation setze
56 56  
... ... @@ -77,7 +77,7 @@
77 77  Mit den optionalen Parametern können Sie die Ausgabe filtern und spezifische Microservices oder Instanzen abrufen.
78 78  
79 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.
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.
81 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 82  |-SupervisorIds|String[]|✅❌| |Filtert Microservices basierend auf den IDs ihrer übergeordneten Supervisoren. Du musst eine oder mehrere Supervisor-IDs als String-Array übergeben.
83 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.
... ... @@ -86,9 +86,9 @@
86 86  
87 87  Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:
88 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.
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.
92 92  
93 93  Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
94 94  
... ... @@ -155,26 +155,26 @@
155 155  * **CpuUsage**: Die aktuelle CPU-Auslastung des Microservices in Prozent.
156 156  * **MemoryUsage**: Die aktuelle Speicherauslastung des Microservices in Bytes.
157 157  
158 -== Edit-AESBMicroservices ==
167 +== Edit-AESBMicroservice ==
159 159  
160 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 161  
162 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).
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).
171 171  
172 172  === Parameter-Sets ===
173 173  
174 174  Das Cmdlet verwendet Parameter-Sets, um zwei Hauptszenarien zu unterstützen:
175 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.
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.
178 178  
179 179  Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
180 180  
... ... @@ -203,7 +203,7 @@
203 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 204  
205 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.
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.
207 207  |-InstanceIds|UseMicroservicesIdListParameterSet|String[]|✅❌|Gibt eine Liste von eindeutigen Instanz-IDs (GUIDs als String) der Microservices an, die beendet werden sollen.
208 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 209  
... ... @@ -248,9 +248,9 @@
248 248  
249 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 250  
251 -* **Status**: Der Status der Beendigungsoperation (z.B. //Unchanged// wenn bereits gestoppt, //Stopped// wenn erfolgreich beendet).
260 +* **Status**: Der Status der Beendigungsoperation (z.B. //Unchanged/Changed//).
252 252  * **InstanceId**: Die eindeutige ID der betroffenen Microservice-Instanz.
253 -* **InstanceState**: Der Zustand des Microservice nach der Operation (z.B. Already stopped).
262 +* **InstanceState**: Der Zustand des Microservice nach der Operation (z.B. //Stopped/Already stopped//).
254 254  * **Error**: Eine Fehlermeldung, falls die Operation nicht erfolgreich war oder ein Problem aufgetreten ist.
255 255  
256 256  == Move-AESBMicroservices ==
... ... @@ -257,13 +257,12 @@
257 257  
258 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 259  
260 -
261 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)
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).
267 267  
268 268  === Beispiele ===
269 269  
... ... @@ -317,6 +317,13 @@
317 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 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 319  
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 +
320 320  === Beispiele ===
321 321  
322 322  Beispiel 1: Einen Microservice anhand seiner Instanz-ID entfernen
... ... @@ -370,30 +370,789 @@
370 370  
371 371  == Restart-AESBMicroservices ==
372 372  
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 +
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.
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 +|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Neustartvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
395 +|-NoWait|SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Neustartvorgangs, sondern kehrt sofort zurück.
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 +==== **Beispiele** ====
405 +
406 +Beispiel 1: Einen Microservice anhand seiner Instanz-ID neu starten
407 +
408 +{{code language="PowerShell"}}
409 +Restart-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"
410 +{{/code}}
411 +
412 +Dieser Befehl startet den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" neu und wartet auf das Ergebnis.
413 +
414 +Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs neu starten mit Timeout
415 +
416 +{{code language="PowerShell"}}
417 +Restart-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -Timeout "1m"
418 +
419 +{{/code}}
420 +
421 +Dieser Befehl startet zwei Microservices neu und setzt das Timeout für den Vorgang auf eine Minute.
422 +
423 +Beispiel 3: Alle Microservices eines Supervisors neu starten, ohne auf den Abschluss zu warten
424 +
425 +{{code language="PowerShell"}}
426 +Restart-AESBMicroservices -SupervisorId "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -NoWait
427 +{{/code}}
428 +
429 +Dieser Befehl initiiert den Neustart aller Microservices, die vom Supervisor "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" verwaltet werden, und kehrt sofort zurück.
430 +
431 +Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs neu starten
432 +
433 +{{code language="PowerShell"}}
434 +"aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" | Restart-AESBMicroservices
435 +{{/code}}
436 +
437 +Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Restart-Microservices`, um die entsprechenden Microservices neu zu starten.
438 +
439 +=== Rückgabewert ===
440 +
441 +Das Cmdlet gibt für jeden versuchten Neustartvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
442 +
443 +* **Name**: Der Name des Microservices.
444 +* **InstanceId**: Die Instanz-ID des Microservices.
445 +* **RestartRequested**: Zeitstempel, wann der Neustart angefordert wurde.
446 +* **RestartSucceeded**: Zeitstempel, wann der Neustart erfolgreich war (oder leer/Fehlerdatum bei Misserfolg).
447 +* **Status**: Das Ergebnis des Neustartvorgangs (z.B. "Success", "Failed", "InProgress").
448 +
373 373  == Set-AESBMicroserviceLogging ==
374 374  
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 +
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.
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 +|-Enable|SwitchParameter|✅❌|Keine|Aktiviert das Logging für die angegebenen Microservices. Obligatorisch für Parametersatz `SwitchEnable`. Kann nicht zusammen mit `-Disable` verwendet werden.
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 +
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 +=== **Beispiele** ===
466 +
467 +Beispiel 1: Logging für einen Microservice aktivieren
468 +
469 +{{code language="PowerShell"}}
470 +Set-AESBMicroserviceLogging -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -Enable
471 +{{/code}}
472 +
473 +Dieser Befehl aktiviert das Logging für den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffffffff1".
474 +
475 +Beispiel 2: Logging für mehrere Microservices deaktivieren
476 +
477 +{{code language="PowerShell"}}
478 +Set-AESBMicroserviceLogging -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -Disable
479 +
480 +{{/code}}
481 +
482 +Dieser Befehl deaktiviert das Logging für die Microservices mit den angegebenen Instanz-IDs.
483 +
484 +Beispiel 3: Logging für einen Microservice über die Pipeline aktivieren
485 +
486 +{{code language="PowerShell"}}
487 +"aaaaaaaa-ffff-ffff-ffff-fffffffffff1" | Set-AESBMicroserviceLogging -Enable
488 +
489 +{{/code}}
490 +
491 +Dieser Befehl übergibt eine Instanz-ID über die Pipeline an `Set-MicroserviceLogging`, um das Logging für den entsprechenden Microservice zu aktivieren.
492 +
493 +=== Rückgabewerte ===
494 +
495 +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:
496 +
497 +* **Status**: Der Status der Operation (z.B. "Changed", "Unchanged", "Failed").
498 +* **MicroserviceId**: Die Instanz-ID des Microservices.
499 +* **MicroserviceName**: Der Name des Microservices.
500 +* **Logging**: Der neue Logging-Status (True oder False).
501 +
375 375  == Start-AESBMicroservices ==
376 376  
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 +
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 +|-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestartet werden sollen. Obligatorisch für Parametersatz `SupervisorParameterset`.
509 +|-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`.
510 +|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Startvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
511 +|-NoWait      |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Startvorgangs, sondern kehrt sofort zurück.
512 +
513 +=== **Beispiele** ===
514 +
515 +Beispiel 1: Einen Microservice anhand seiner Instanz-ID starten
516 +
517 +{{code language="PowerShell"}}
518 +Start-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffff1"
519 +
520 +{{/code}}
521 +
522 +Dieser Befehl startet den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffff1" und wartet auf das Ergebnis.
523 +
524 +Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs starten mit Timeout
525 +
526 +{{code language="PowerShell"}}
527 +Start-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffff2" -Timeout "1m"
528 +
529 +{{/code}}
530 +
531 +Dieser Befehl startet zwei Microservices und setzt das Timeout für den Vorgang auf eine Minute.
532 +
533 +Beispiel 3: Alle Microservices eines Supervisors starten, ohne auf den Abschluss zu warten
534 +
535 +{{code language="PowerShell"}}
536 +Start-AESBMicroservices -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -NoWait
537 +
538 +{{/code}}
539 +
540 +Dieser Befehl initiiert den Start aller Microservices, die vom Supervisor "ffffffff-ffff-ffff-ffff-aaaaaaaa" verwaltet werden, und kehrt sofort zurück.
541 +
542 +Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs starten
543 +
544 +{{code language="PowerShell"}}
545 +"aaaaaaaa-ffff-ffff-ffff-fffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffff2" | Start-AESBMicroservices
546 +
547 +{{/code}}
548 +
549 +Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Start-Microservices`, um die entsprechenden Microservices zu starten.
550 +
551 +=== **Rückgabewert** ===
552 +
553 +Das Cmdlet gibt für jeden versuchten Startvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
554 +
555 +* **InstanceName**: Der Name des Microservices.
556 +* **InstanceId:** Die Instanz-ID des Microservices.
557 +* **Status**: Das Ergebnis des Startvorgangs (z.B. "Started", "Failed", "AlreadyRunning").
558 +
377 377  == Stop-AESBMicroservices ==
378 378  
561 +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.
562 +
563 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
564 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestoppt werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
565 +|-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestoppt werden sollen. Obligatorisch für Parametersatz `UseSupervisorIdParameterSet`.
566 +|-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`.
567 +|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Stoppvorgang an (z.B. "5s", "1m"). Standardwert: "5s".
568 +|-NoWait      |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Stoppvorgangs, sondern kehrt sofort zurück.
569 +
570 +=== **Beispiele** ===
571 +
572 +Beispiel 1: Einen Microservice anhand seiner Instanz-ID stoppen
573 +
574 +{{code language="PowerShell"}}
575 +Stop-AESBMicroservices -InstanceIds "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1"
576 +{{/code}}
577 +
578 +Dieser Befehl stoppt den Microservice mit der Instanz-ID "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1" und wartet auf das Ergebnis.
579 +
580 +Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs stoppen mit Timeout
581 +
582 +{{code language="PowerShell"}}
583 +Stop-AESBMicroservices -InstanceIds "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" -Timeout "10s"
584 +
585 +{{/code}}
586 +
587 +Dieser Befehl stoppt zwei Microservices und setzt das Timeout für den Vorgang auf zehn Sekunden.
588 +
589 +Beispiel 3: Alle Microservices eines Supervisors stoppen, ohne auf den Abschluss zu warten
590 +
591 +{{code language="PowerShell"}}
592 +Stop-AESBMicroservices -SupervisorId "FinanceSupervisor" -NoWait
593 +
594 +{{/code}}
595 +
596 +Dieser Befehl initiiert den Stoppvorgang aller Microservices, die vom Supervisor "FinanceSupervisor" verwaltet werden, und kehrt sofort zurück.
597 +
598 +Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs stoppen
599 +
600 +{{code language="PowerShell"}}
601 +"c7e323e9-abc1-4150-a4a3-afb4e57e9cb1", "another-guid-for-stop" | Stop-AESBMicroservices
602 +
603 +{{/code}}
604 +
605 +Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Stop-AESBMicroservices`, um die entsprechenden Microservices zu stoppen.
606 +
607 +=== **Rückgabewert** ===
608 +
609 +Das Cmdlet gibt für jeden versuchten Stoppvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
610 +
611 +* **Status**: Der Status der Operation (z.B. "Changed", "Unchanged", "Failed")
612 +* **InstanceId**: Die Instanz-ID des Microservices.
613 +* **InstanceState**: Der Zustand des Microservices nach dem versuchten Stoppvorgang (z.B. "Stopped", "Running").
614 +* **Error**: Fehlermeldungen, falls der Stoppvorgang nicht erfolgreich war.
615 +
379 379  = Packages =
380 380  
381 381  == Get-AESBMicroservicePackages ==
382 382  
620 +Dieses Cmdlet ruft eine Liste aller verfügbaren Microservice-Pakete und deren Versionen ab. Es sind keine spezifischen Parameter erforderlich.
621 +
622 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
623 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Informationen zu Microservice-Paketen abgerufen werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
624 +
625 +=== **Beispiele** ===
626 +
627 +Beispiel 1: Alle verfügbaren Microservice-Pakete auflisten
628 +
629 +{{code language="PowerShell"}}
630 +Get-AESBMicroservicePackages
631 +
632 +{{/code}}
633 +
634 +Dieser Befehl ruft alle verfügbaren Microservice-Pakete und die zugehörigen Versionen ab.
635 +
636 +=== **Rückgabewert** ===
637 +
638 +Das Cmdlet gibt für jedes gefundene Microservice-Paket ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
639 +
640 +* **PackageName**: Der Name des Microservice-Pakets.
641 +* **PackageVersions**: Eine Liste der verfügbaren Versionen für dieses Paket.
642 +
383 383  = Templates =
384 384  
385 385  == Add-AESBMicroserviceTemplate ==
386 386  
647 +Dieses Cmdlet fügt eine Microservice-Vorlage auf Basis der beigefügten Vorlagen-Konfiguration hinzu.
648 +
649 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
650 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die eine Vorlage hinzugefügt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
651 +|-TemplateName|String|❌|Keine|Der Name für die Vorlage.
652 +|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration der Vorlage.
653 +
654 +=== **Beispiele** ===
655 +
656 +Beispiel 1: Fügt ein neue Microservice-Vorlage hinzu
657 +
658 +{{code language="PowerShell"}}
659 +Add-AESBMicroserviceTemplate -TemplateName "Test" -TemplateConfig $templateConfig
660 +{{/code}}
661 +
662 +Dieses Beispiel fügt eine neue Vorlagen-konfiguration mit dem Namen "Test" auf Basis des $templateConfig-Objekts hinzu. Die Standardverbindung wird verwendet.
663 +
664 +{{apimacro title="Beispiel der Funktion in PowerShell"}}
665 +{{code language="PowerShell" layout="LINENUMBERS"}}
666 +function Add-MicroserviceTemplate {
667 + param (
668 + [string]$Name
669 + )
670 +
671 + $packages = Get-AESBMicroservicePackages
672 +
673 + $microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packages[0].PackageName -PackageVersion $packages[0].PackageVersions[0]
674 +
675 + $addMicroserviceResult = Add-AESBMicroserviceTemplate -TemplateName $Name -TemplateConfig $microserviceTemplateConfig
676 +
677 + return $addMicroserviceResult
678 +}
679 +{{/code}}
680 +{{/apimacro}}
681 +
682 +{{apimacro title="Beispiel der Vorlagen-Konfiguration"}}
683 +{{code language="PowerShell" layout="LINENUMBERS"}}
684 +$templateConfig = "<MicroserviceConfiguration Version=`"1.11.0.895`" Type=`"SnmpConnector`" SessionKey=`"bcafdb4e94f2572eed78525430ad0e0275229f98`">
685 + <SnmpConnectorConfiguration>
686 + <SnmpReader>
687 + <ParallelRequests>10</ParallelRequests>
688 + <SchedulingConfig>
689 + <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
690 + <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
691 + <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
692 + </SchedulingConfig>
693 + <Groups />
694 + <GlobalCredentialLists>
695 + <GlobalCredentials />
696 + <GlobalCredentialsNoPriv />
697 + <GlobalCredentialsNoAuthNoPriv />
698 + </GlobalCredentialLists>
699 + </SnmpReader>
700 + <SnmpWriters>
701 + <DescriptionWriteMode>Keep</DescriptionWriteMode>
702 + <LocationWriteMode>Ignore</LocationWriteMode>
703 + <ContactWriteMode>Ignore</ContactWriteMode>
704 + <ProcessorWriter />
705 + <DispatcherStarter />
706 + <FileDumper />
707 + </SnmpWriters>
708 + </SnmpConnectorConfiguration>
709 +</MicroserviceConfiguration>"
710 +{{/code}}
711 +{{/apimacro}}
712 +
713 +=== **Rückgabewerte** ===
714 +
715 +Bei erfolgreicher Anwendung erhalten Sie zwei Objekte zurück.
716 +
717 +* String
718 +** Erfolgreiche Statusmeldung
719 +* TemplateInfo
720 +** TemplateId
721 +*** ID der Vorlage
722 +** Configuration
723 +*** Aktuelle Konfiguration der Vorlage
724 +** Name
725 +*** Name der Vorlage
726 +** Type
727 +*** Der Typ der Vorlage
728 +** Version
729 +*** Die Versionierung der Vorlage
730 +
731 +{{apimacro title="Rückgabewerte der Vorlagen-Konfiguration"}}
732 +{{code language="PowerShell" layout="LINENUMBERS"}}
733 +Successfully added template 'Test'.
734 +
735 +TemplateId : 119398aa-8108-43bd-811b-bd3e703e7f5c
736 +Configuration : <SnmpConnectorConfiguration><SnmpReader><ParallelRequests>10</ParallelRequests><SchedulingConfig><Sched
737 + ulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling><SchedulingConfig_Interval>P1D</Scheduling
738 + Config_Interval><SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTi
739 + me></SchedulingConfig><Groups /><GlobalCredentialLists><GlobalCredentials /><GlobalCredentialsNoPriv
740 + /><GlobalCredentialsNoAuthNoPriv /></GlobalCredentialLists></SnmpReader><SnmpWriters><DescriptionWriteM
741 + ode>Keep</DescriptionWriteMode><LocationWriteMode>Ignore</LocationWriteMode><ContactWriteMode>Ignore</C
742 + ontactWriteMode><ProcessorWriter /><DispatcherStarter /><FileDumper
743 + /></SnmpWriters></SnmpConnectorConfiguration>
744 +Name : Test
745 +Type : SnmpConnector
746 +Version : 1.11.0.895
747 +{{/code}}
748 +{{/apimacro}}
749 +
387 387  == Export-MicroserviceTemplateConfig ==
388 388  
752 +Dieses Cmdlet ermöglicht es, die Konfiguration einer Microservice-Vorlagen zu exportieren.
753 +
754 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
755 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
756 +|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration, die exportiert werden soll.
757 +|-Path|String|❌|Keine|Der Pfad, unter dem die Microservice-Vorlagen-Konfiguration gespeichert werden soll.
758 +
759 +=== **Beispiele** ===
760 +
761 +Beispiel 1: Microservice-Vorlage exportieren
762 +
763 +{{code language="PowerShell"}}
764 +Export-AESBMicroserviceTemplateConfig -TemplateConfig $templateConfig -Path $path
765 +
766 +{{/code}}
767 +
768 +In diesem Beispiel wird die //$templateConfig// am Speicherort "C:\Test.xml" exportiert.
769 +
770 +{{code language="PowerShell" layout="LINENUMBERS"}}
771 +function Export-MicroserviceTemplateConfig {
772 + param (
773 + [string]$Path
774 + )
775 +
776 + $microserviceTemplates = Get-AESBMicroserviceTemplates
777 +
778 + $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $microserviceTemplates[0].Name
779 +
780 + $exportMicroserviceTemplateConfigResult = Export-AESBMicroserviceTemplateConfig -TemplateConfig $microserviceTemplateConfig -Path $Path
781 +
782 + return $exportMicroserviceTemplateConfigResult
783 +}
784 +{{/code}}
785 +
786 +{{apimacro title="Beispielhafte XML-Datei nach dem Exportieren"}}
787 +{{code language="XML" layout="LINENUMBERS"}}
788 +<MicroserviceConfiguration Version="1.11.0.895" Type="SnmpConnector" SessionKey="bcafdb4e94f2572eed78525430ad0e0275229f98">
789 + <SnmpConnectorConfiguration>
790 + <SnmpReader>
791 + <ParallelRequests>10</ParallelRequests>
792 + <SchedulingConfig>
793 + <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
794 + <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
795 + <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
796 + </SchedulingConfig>
797 + <Groups />
798 + <GlobalCredentialLists>
799 + <GlobalCredentials />
800 + <GlobalCredentialsNoPriv />
801 + <GlobalCredentialsNoAuthNoPriv />
802 + </GlobalCredentialLists>
803 + </SnmpReader>
804 + <SnmpWriters>
805 + <DescriptionWriteMode>Keep</DescriptionWriteMode>
806 + <LocationWriteMode>Ignore</LocationWriteMode>
807 + <ContactWriteMode>Ignore</ContactWriteMode>
808 + <ProcessorWriter />
809 + <DispatcherStarter />
810 + <FileDumper />
811 + </SnmpWriters>
812 + </SnmpConnectorConfiguration>
813 +</MicroserviceConfiguration>
814 +{{/code}}
815 +{{/apimacro}}
816 +
817 +=== Rückgabewerte ===
818 +
819 +Nach erfolgreichem Exportieren erhalten Sie eine Statusmeldung zurück.
820 +
821 +{{code language="none"}}
822 +Writing the file was successful.
823 +
824 +{{/code}}
825 +
389 389  == Get-AESBMicroserviceTemplateConfig ==
390 390  
828 +Dieses Cmdlet fragt die TemplateConfig einer bestimmten Microservice-Vorlage ab.
829 +
830 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
831 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
832 +|-TemplateName|String|❌|Keine|Der Name der Vorlage für die gewünschte Konfiguration.
833 +
834 +=== Beispiele ===
835 +
836 +Beispiel 1: Konfiguration der Microservice-Vorlage von //$templateName// anfragen
837 +
838 +{{code language="PowerShell"}}
839 +Get-AESBMicroserviceTemplateConfig -TemplateName $templateName
840 +{{/code}}
841 +
842 +Dieses Beispiel fragt die Vorlagen-Konfiguration mit dem Namen //$templateName// an. Die Standardverbindung wird verwendet.
843 +
844 +{{code language="PowerShell" layout="LINENUMBERS"}}
845 +function Get-MicroserviceTemplateConfig {
846 +
847 + $aesbMicroserviceTemplates = Get-AESBMicroserviceTemplates
848 +
849 + $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $aesbMicroserviceTemplates[0].Name
850 +
851 + return $microserviceTemplateConfig
852 +}
853 +{{/code}}
854 +
855 +=== Rückgabewerte ===
856 +
857 +Bei erfolgreicher Anwendung erhalten Sie die gewünschte Microservice-Konfiguration zurück:
858 +
859 +* MicroserviceConfiguration
860 +** Version
861 +*** Die jeweilige Version des Microservices
862 +** Type
863 +*** Der Typ des Microservices
864 +** TypeConfiguration
865 +*** Die jeweilige Typ-Konfiguration des Microservices
866 +
867 +{{code language="PowerShell"}}
868 +$microserviceTemplateConfig
869 +
870 +MicroserviceConfiguration
871 +-------------------------
872 +MicroserviceConfiguration
873 +
874 +$microserviceTemplateConfig.MicroserviceConfiguration
875 +
876 +Version Type SnmpConnectorConfiguration
877 +------- ---- --------------------------
878 +1.11.0.895 SnmpConnector SnmpConnectorConfiguration
879 +{{/code}}
880 +
881 +== Get-AESBMicroserviceTemplates ==
882 +
883 +Dieses Cmdlet fragt die vorhandenen Microservice-Vorlagen ab und listet sie auf.
884 +
885 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
886 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservices-Vorlagen-Konfiguration importiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
887 +|-PackageName|String|✅| |Der Name des Microservice-Pakets, dessen Vorlagen geholt werden sollen
888 +|-PackageVersion|String|✅| |Die Version des Pakets, dessen Vorlagen geholt werden sollen
889 +
890 +=== Beispiele ===
891 +
892 +Beispiel 1: Alle vorhandenen Microservice-Vorlagen anzeigen
893 +
894 +{{code language="PowerShell"}}
895 +Get-AESBMicroserviceTemplates
896 +{{/code}}
897 +
898 +Dieses Beispiel listet alle vorhandenen Microservice-Vorlagen auf. Die Standardverbindung wird verwendet. Falls keine Vorlagen vorhanden sind, wird ein Fehler angezeigt.
899 +
900 +Beispiel 2: Die Vorlagen eines bestimmten Microservice-Pakets einer bestimmten Version auflisten
901 +
902 +{{code language="PowerShell"}}
903 +Get-AESBMicroserviceTemplates -PackageName "SnmpConnector" -PackageVersion "1.11.0.895"
904 +
905 +{{/code}}
906 +
907 + Dieses Beispiel listet alle vorhandenen Microservice-Vorlagen des Pakets "SnmpConnector" in der Version "1.11.0.895" auf. Die Standardverbindung wird verwendet.
908 +
909 +=== Rückgabewerte ===
910 +
911 +Bei erfolgreicher Anwendung werden die gewünschten Microservice-Vorlagen als Objekte aufgelistet.
912 +
913 +* MicroserviceTemplate
914 +** Name
915 +*** Der Name der Vorlage
916 +** Id
917 +*** Die Id der Vorlage
918 +** PackageName
919 +*** Der Name des Microservice-Pakets
920 +** PackageVersion
921 +*** Die Version des Microservice-Pakets
922 +
923 +{{code language="PowerShell"}}
924 +Name Id PackageName PackageVersion
925 +
926 +---- -- ----------- --------------
927 +
928 +SnmpConnector a6e37f49-5a15-4213-96f5-e23cc03209a8 SnmpConnector 1.11.0.895
929 +
930 +PS_Microservice1 33618fc3-60f2-484b-b6c9-b9f19c5eb4fa PS_Microservice1 1.1.0.1
931 +{{/code}}
932 +
391 391  == Import-AESBMicroserviceTemplateConfig ==
392 392  
935 +Dieses Cmdlet importiert die Vorlagen-Konfiguration vom angegebenen Pfad.
936 +
937 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
938 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservices-Vorlagen-Konfiguration importiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
939 +|-Path|String|❌|Keine|Der Pfad, von dem die Konfiguration importiert werden soll.
940 +
941 +=== Beispiele ===
942 +
943 +Beispiel 1: Vorlagen-Konfiguration von //$path// laden
944 +
945 +{{code language="PowerShell"}}
946 +Import-AESBMicroserviceTemplateConfig -Path $path
947 +
948 +{{/code}}
949 +
950 +Dieses Beispiel importiert die Vorlagen-Konfiguration beim hinterlegten Pfad. Die Standardverbindung wird verwendet.
951 +
952 +=== Rückgabewerte ===
953 +
954 +Bei erfolgreicher Anwendung erhalten Sie die gewünschte MicroserviceConfiguration zurück:
955 +
956 +* MicroserviceConfiguration
957 +** Version
958 +*** Die jeweilige Version des Microservices
959 +** Type
960 +*** Der Typ des Microservices
961 +** TypeConfiguration
962 +*** Die jeweilige Typ-Konfiguration des Microservices
963 +
964 +{{code language="PowerShell"}}
965 +$microserviceTemplateConfig
966 +
967 +MicroserviceConfiguration
968 +-------------------------
969 +MicroserviceConfiguration
970 +
971 +$microserviceTemplateConfig.MicroserviceConfiguration
972 +
973 +Version Type SnmpConnectorConfiguration
974 +------- ---- --------------------------
975 +1.11.0.895 SnmpConnector SnmpConnectorConfiguration
976 +{{/code}}
977 +
393 393  == Migrate-AESBMicroserviceTemplate ==
394 394  
980 +Mit diesem Cmdlet werden bestehende Vorlagen auf die gewünschte Zielversion übertragen.
981 +
982 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
983 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Vorlagen migriert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
984 +|-TemplateNames|String[]|❌|Keine|Hier sind die Namen der Vorlagen, die übertragen werden sollen.
985 +|-TargetVersion|String|❌|Keine|Die Zielversion, auf die die Vorlagen migriert werden sollen.
986 +|-KeepTemplateIds|SwitchParameter|✅|Keine|Hier wird festgelegt, ob die bestehenden Template-IDs gleich bleiben oder beim Migrieren neu erstellt werden sollen.
987 +
988 +=== Beispiele ===
989 +
990 +Beispiel 1: Mehrere Vorlagen auf Version //$templateVersion// migrieren
991 +
992 +{{code language="PowerShell"}}
993 +Migrate-AESBMicroserviceTemplates -TemplateNames $templateNames -TargetVersion $templateVersion
994 +
995 +{{/code}}
996 +
997 +Dieses Beispiel migriert alle Vorlagen, die in //$templateNames// stehen, auf die Version //$templateVersion//.
998 +
999 +=== Rückgabewerte ===
1000 +
1001 +Bei erfolgreicher Anwendung erhalten Sie eine Liste von Vorlagen-Informationen mit den neuen Daten der erfolgreich migrierten Vorlagen:
1002 +
1003 +* TemplateInfo
1004 +** TemplateId
1005 +*** Die neu erstellte / gleichbleibende Id der Vorlage
1006 +** Configuration
1007 +*** Die aktuelle Konfiguration der Vorlage
1008 +** Name
1009 +*** Der neue Name der Vorlage
1010 +** Type
1011 +*** Der Typ der Vorlage
1012 +** Version
1013 +*** Die neue Version der Vorlage
1014 +
1015 +{{code language="PowerShell"}}
1016 +TemplateId : ffffffff-ffff-ffff-ffff-ffffffffffff"
1017 +Configuration : <Configuration>
1018 + <SchedulingConfig>
1019 + <SchedulingConfig_Scheduling>Disabled</SchedulingConfig_Scheduling>
1020 + </SchedulingConfig>
1021 + </Configuration>
1022 +Name : TestTest_1_0_0_1
1023 +Type : Test
1024 +Version : 1.0.0.1
1025 +{{/code}}
1026 +
395 395  == New-AESBMicroserviceTemplateConfig ==
396 396  
1029 +Mit diesem Cmdlet wird eine neue Vorlagen-Konfiguration auf Basis des Pakets erstellt.
1030 +
1031 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
1032 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration erstellt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
1033 +|-PackageName|String|❌|Keine|Der Name des Pakets.
1034 +|-PackageVersion|String|❌|Keine|Die Version des Pakets.
1035 +
1036 +=== Beispiele ===
1037 +
1038 +Beispiel 1: MicroserviceTemplateConfig erstellen
1039 +
1040 +{{code language="PowerShell" layout="LINENUMBERS"}}
1041 +$packageVersion = "1.0.0.0"
1042 +$packageName = "Test"
1043 +
1044 +New-AESBMicroserviceTemplateConfig -PackageName $packageName -PackageVersion $packageVersion
1045 +{{/code}}
1046 +
1047 +Dieses Beispiel erstellt eine Vorlagen-Konfiguration auf Basis des angegebenen Microservice-Pakets.
1048 +
1049 +=== Rückgabewerte ===
1050 +
1051 +* MicroserviceConfiguration
1052 +** Version
1053 +*** Die neue Version der Vorlage
1054 +** Type
1055 +*** Der Typ der Vorlage
1056 +** Configuration
1057 +*** Die aktuelle Konfiguration der Vorlage
1058 +
1059 +{{code language="PowerShell" layout="LINENUMBERS"}}
1060 +$microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packageName -PackageVersion $packageVersion
1061 +
1062 +MicroserviceConfiguration
1063 +-------------------------
1064 +MicroserviceConfiguration
1065 +
1066 +$microserviceTemplateConfig.MicroserviceConfiguration
1067 +
1068 +Version Type Configuration
1069 +------- ---- -------------
1070 +1.0.0.0 Test Configuration
1071 +{{/code}}
1072 +
397 397  == Remove-AESBMicroserviceTemplate ==
398 398  
1075 +Mit diesem Cmdlet können Sie Microservice-Vorlagen löschen.
1076 +
1077 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
1078 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen gelöscht werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
1079 +|-TemplateIds|String[]|❌|Keine|Die ID's der Vorlagen, die zu löschen sind.
1080 +|-RemoveReferences|SwitchParameter|✅|Keine|Gibt an ob alle erstellten Referenzen der Vorlagen mitgelöscht werden sollen.
1081 +
1082 +=== Beispiele ===
1083 +
1084 +Beispiel 1: Vorlage löschen
1085 +
1086 +{{code language="PowerShell"}}
1087 +Remove-AESBMicroserviceTemplate -TemplateIds 4b016fd1-47fb-4f24-87dd-4e365fe870d3
1088 +
1089 +{{/code}}
1090 +
1091 +Dieses Beispiel löscht eine Microservice-Vorlage auf Basis der angegebenen Id.
1092 +
1093 +Beispiel 2: Vorlagen löschen
1094 +
1095 +{{code language="PowerShell"}}
1096 +Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3", "D1936807-E1B0-4F8B-AB7F-98ECD202CF8F"
1097 +{{/code}}
1098 +
1099 +Dieses Beispiel löscht mehrere Microservice-Vorlagen auf Basis der angegebenen Ids.
1100 +
1101 +Beispiel 3: Vorlagen löschen mitsamt den Referenzen
1102 +
1103 +{{code language="PowerShell"}}
1104 +Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3" -RemoveReferences
1105 +
1106 +{{/code}}
1107 +
1108 +Dieses Beispiel löscht eine Microservice-Vorlage mitsamt den erstellten Referenzen der Vorlage .
1109 +
1110 +=== Rückgabewerte ===
1111 +
1112 +* RemoveMicroserviceTemplateStatusData
1113 +** StatusResult
1114 +*** Ergebnis des Resultats des Vorgangs
1115 +** TemplateId
1116 +*** Die erfolgreich gelöschte Id der Vorlage
1117 +** Message
1118 +*** Status Nachricht
1119 +
1120 +{{code language="PowerShell"}}
1121 +StatusResult TemplateId Message
1122 +------------ ---------- -------
1123 + Success bde8016f-8557-4438-a165-ab05a4a78db4 The template was successfully removed.
1124 +{{/code}}
1125 +
399 399  == Update-AESBMicroserviceTemplate ==
1127 +
1128 +Dieses Cmdlet aktualisiert die Microservice-Vorlage mittels der beigefügten Microservice-Vorlagen-Konfiguration.
1129 +
1130 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
1131 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlage aktualisiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
1132 +|-TemplateId|String|❌|Keine|Die ID der Vorlage, die aktualisiert werden soll.
1133 +|-TemplateConfig|XmlDocument|❌|Keine|Die neue Microservices-Vorlagen-Konfiguration, die die aktuelle Konfiguration überschreiben soll. 
1134 +
1135 +=== Beispiele ===
1136 +
1137 +Beispiel 1: Vorlage updaten
1138 +
1139 +{{code language="PowerShell" layout="LINENUMBERS"}}
1140 +$templateConfiguration = <MicroserviceConfiguration Version="1.0.0.0" Type="Test" SessionKey="72962557bb8bbd00b53dcb53d99cea685ed636bf">
1141 + <Configuration>
1142 + <SchedulingConfig>
1143 + <SchedulingConfig_Scheduling>Enabled</SchedulingConfig_Scheduling>
1144 + </SchedulingConfig>
1145 + </Configuration>
1146 +</MicroserviceConfiguration>
1147 +
1148 +
1149 +Update-AESBMicroserviceTemplate -TemplateId "838fb7e2-e293-4004-9602-7223aaa3854a" -TemplateConfig $templateConfiguration
1150 +{{/code}}
1151 +
1152 +Dieses Beispiel updated die Vorlage mit der beigefügten Konfiguration.
1153 +
1154 +=== Rückgabewerte ===
1155 +
1156 +* Templateinfo
1157 +** TemplateId
1158 +** Configuration
1159 +** Name
1160 +** Type
1161 +** Version
1162 +
1163 +{{code language="PowerShell"}}
1164 +TemplateId : 838fb7e2-e293-4004-9602-7223aaa3854a
1165 +Configuration : <Configuration>
1166 + <SchedulingConfig>
1167 + <SchedulingConfig_Scheduling>Enabled</SchedulingConfig_Scheduling>
1168 + </SchedulingConfig>
1169 + </Configuration>
1170 +Name : ASDASDASD
1171 +Type : ASD
1172 +Version : 1.0.0.0
1173 +{{/code}}
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community