Changes for page Microservice Cmdlets

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

From version 11.1
edited by jklein
on 2025/07/21 08:49
Change comment: There is no comment for this version
To version 14.1
edited by jklein
on 2025/07/30 13:43
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,29 +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 9  (% style="width:902px" %)
10 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 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 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 des Templates 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 des Templates für die Vorlage 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 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 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 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.
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 +
19 19  === **Beispiele** ===
20 20  
21 -Beispiel 1: Microservice über Template-Name hinzufügen
29 +Beispiel 1: Microservice über Vorlagen-Name hinzufügen
22 22  
23 23  {{code language="PowerShell"}}
24 24  Add-AESBMicroservice -InstanceName "Test" -TemplateName "Tester"
25 25  {{/code}}
26 26  
27 -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.
28 28  
29 -Beispiel 2: Microservice über Template-Id hinzufügen
37 +Beispiel 2: Microservice über Vorlagen-Id hinzufügen
30 30  
31 31  {{code language="PowerShell"}}
32 32  Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff"
... ... @@ -34,15 +34,15 @@
34 34  {{/code}}
35 35  
36 36  (% class="wikigeneratedid" %)
37 -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.
38 38  
39 -Beispiel 3: Microservice StartUpType beim Hinzufügen setze
47 +Beispiel 3: Microservice-StartUpType beim Hinzufügen setzen
40 40  
41 41  {{code language="PowerShell"}}
42 42  Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StartupType Manual
43 43  {{/code}}
44 44  
45 -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.
46 46  
47 47  Beispiel 4: Microservice mit SupervisorId setzen
48 48  
... ... @@ -51,7 +51,7 @@
51 51  
52 52  {{/code}}
53 53  
54 -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.
55 55  
56 56  Beispiel 5: Microservice mit StoppedAfterCreation setze
57 57  
... ... @@ -78,7 +78,7 @@
78 78  Mit den optionalen Parametern können Sie die Ausgabe filtern und spezifische Microservices oder Instanzen abrufen.
79 79  
80 80  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
81 -|-ConnectionName|String|✅|C|Der Name der Verbindung, Informationen zu Microservice-Instanzen abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
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.
82 82  |-InstanceNames|String[]|✅❌| |Gibt die Namen der Microservice-Instanzen an, die abgerufen werden sollen. Du kannst einen oder mehrere Instanznamen als String-Array übergeben.
83 83  |-SupervisorIds|String[]|✅❌| |Filtert Microservices basierend auf den IDs ihrer übergeordneten Supervisoren. Du musst eine oder mehrere Supervisor-IDs als String-Array übergeben.
84 84  |-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.
... ... @@ -87,9 +87,9 @@
87 87  
88 88  Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:
89 89  
90 -* **InstanceNamesParameterSetName**: Ermöglicht das Abrufen von Microservices, basierend auf ihren Instanznamen.
91 -* **SupervisorsParameterSetName**: Ermöglicht das Abrufen von Microservices, die bestimmten Supervisor-IDs zugeordnet sind.
92 -* **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.
93 93  
94 94  Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
95 95  
... ... @@ -162,20 +162,20 @@
162 162  
163 163  |=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=Datentyp|=Optional|=Beschreibung
164 164  |-ConnectionName| |String|✅|Der Name der Verbindung, über die Microservice-Instanzen bearbeitet werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
165 -|-InstanceName|NoCredentialParameterSetName,
166 -CredentialParameterSetName|String|❌|Gibt den eindeutigen Namen der Microservice-Instanz an, deren Konfiguration geändert werden soll. Dieser Parameter ist in beiden Parametersets obligatorisch.
167 -|-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.
168 -|-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.
169 -|-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.
170 -|-StartupType|NoCredentialParameterSetName,
171 -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).
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).
172 172  
173 173  === Parameter-Sets ===
174 174  
175 175  Das Cmdlet verwendet Parameter-Sets, um zwei Hauptszenarien zu unterstützen:
176 176  
177 -* **NoCredentialParameterSetName**: Ermöglicht die Bearbeitung des Starttyps ohne die Angabe von Anmeldeinformationen.
178 -* **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.
179 179  
180 180  Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
181 181  
... ... @@ -249,9 +249,9 @@
249 249  
250 250  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:
251 251  
252 -* **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//).
253 253  * **InstanceId**: Die eindeutige ID der betroffenen Microservice-Instanz.
254 -* **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//).
255 255  * **Error**: Eine Fehlermeldung, falls die Operation nicht erfolgreich war oder ein Problem aufgetreten ist.
256 256  
257 257  == Move-AESBMicroservices ==
... ... @@ -258,13 +258,12 @@
258 258  
259 259  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.
260 260  
261 -
262 262  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
263 263  |-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen verschoben werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
264 -|-InstanceIds|String[]|❌| |Die IDs der zu verschiebenden Microservice-Instanzen (Pflichtfeld, unterstützt mehrere Werte)
265 -|-SupervisorId|String|❌| |Die Ziel-SupervisorId, auf die die Instanzen verschoben werden sollen
266 -|-Timeout|String|✅| |Optionales Timeout für die Operation (Standard: "30s")
267 -|-NoWait|SwitchParameter|✅| |Gibt an, ob das Cmdlet auf den Abschluss der Operation warten soll (asynchron)
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).
268 268  
269 269  === Beispiele ===
270 270  
... ... @@ -318,6 +318,13 @@
318 318  |-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//.
319 319  |-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//.
320 320  
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 +
321 321  === Beispiele ===
322 322  
323 323  Beispiel 1: Einen Microservice anhand seiner Instanz-ID entfernen
... ... @@ -375,11 +375,18 @@
375 375  
376 376  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
377 377  |-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen neugestartet werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
378 -|-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.
379 379  |-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.
380 380  |-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Neustartvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
381 381  |-NoWait|SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Neustartvorgangs, sondern kehrt sofort zurück.
382 382  
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 +
383 383  ==== **Beispiele** ====
384 384  
385 385  Beispiel 1: Einen Microservice anhand seiner Instanz-ID neu starten
... ... @@ -476,11 +476,10 @@
476 476  
477 477  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.
478 478  
479 -
480 480  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
481 481  |-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestartet werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
482 -|-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestartet werden sollen. Obligatorisch für Parametersatz `SupervisorParametersetName`.
483 -|-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`.
502 +|-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestartet werden sollen. Obligatorisch für Parametersatz `SupervisorParameterset`.
503 +|-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`.
484 484  |-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Startvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
485 485  |-NoWait      |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Startvorgangs, sondern kehrt sofort zurück.
486 486  
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community