Wiki source code of Microservice Cmdlets

Version 2.5 by jklein on 2025/06/20 09:31
Show last authors
1 {{aagon.floatingbox/}}
2
3 = Instances =
4
5 == Add-AESBMicroservice ==
6
7 Mit diesem Cmdlet wird eine neue Microservice-Instanz nach der Vorlage eines Templates hinzugefügt.
8
9 |=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
10 |-ConnectionName|Keine|String|✅|C|Der Name der Verbindung, über die die Microservice-Instanz hinzugefügt werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
11 |-InstanceName|Keine|String|❌|Keine|Der Name der Instanz.
12 |-TemplateName|UseTemplateName|String|❌|Keine|Der Name des Templates für die Vorlage der Instanz.
13 |-TemplateId|UseTemplateId|String|❌|Keine|Die Id des Templates für die Vorlage der Instanz.
14 |-SupervisorId|Keine|String|✅|Keine|Die Id des Supervisors zu der die Instanz hinzugefügt werden soll.
15 |-StartupType|Keine|InstanceStartType|✅|Keine|Setzt die Art der Zeitplanung der Instanz.
16 |-StoppedAfterCreation|Keine|Bool|✅|Keine|Setzt den Wert um die Instanz direkt nach der Erstellung zu starten.
17
18 === **Beispiele** ===
19
20 Beispiel 1: Microservice über Template-Name hinzufügen
21
22 {{code language="PowerShell"}}
23 Add-AESBMicroservice -InstanceName "Test" -TemplateName "Tester"
24 {{/code}}
25
26 Dieses Beispiel fügt eine neue Instanz mithilfe des Template-Namen hinzu. Die Standardverbindung wird verwendet.
27
28 Beispiel 2: Microservice über Template-Id hinzufügen
29
30 {{code language="PowerShell"}}
31 Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff"
32
33 {{/code}}
34
35 (% class="wikigeneratedid" %)
36 Dieses Beispiel fügt eine neue Instanz mithilfe der Template-Id hinzu. Die Standardverbindung wird verwendet.
37
38 Beispiel 3: Microservice StartUpType beim Hinzufügen setze
39
40 {{code language="PowerShell"}}
41 Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StartupType Manual
42 {{/code}}
43
44 Dieses Beispiel fügt eine neue Instanz mithilfe der Template-Id hinzu und setzt den //StartupType// auf //Manuell//. Die Standardverbindung wird verwendet.
45
46 Beispiel 4: Microservice mit SupervisorId setzen
47
48 {{code language="PowerShell"}}
49 Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff"
50
51 {{/code}}
52
53 Dieses Beispiel fügt eine neue Instanz einen bestimmten Supervisor hinzu, der über die Supervisor-Id angegeben wird. Die Standardverbindung wird verwendet.
54
55 Beispiel 5: Microservice mit StoppedAfterCreation setze
56
57 {{code language="PowerShell"}}
58 Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StoppedAfterCreation false
59
60 {{/code}}
61
62 Dieses Beispiel fügt eine neue Instanz hinzu und setzt den Wert von //StoppedAfterCreation// auf //false,// womit der Start nach dem Hinzufügen des Microservices verhindert wird. Die Standardverbindung wird verwendet.
63
64 Beispiel 6: Microservice mit vielen Parametern
65
66 {{code language="PowerShell"}}
67 Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StartupType Manual -StoppedAfterCreation false
68 {{/code}}
69
70 Dieses Beispiel fügt eine neue Instanz zu einem angegebenen Supervisor hinzu, setzt den //StartupType// auf //Manuell und //den Wert von //StoppedAfterCreation// auf //false//. Die Standardverbindung wird verwendet
71
72 (% style="color:inherit; font-family:inherit; font-size:25px; font-weight:bold" %)**Get-AESBMicroservice**
73
74 Mit diesem Cmdlet erhalten Sie eine Liste mit allen installierten und registrierten Microservices des AESB. In dieser Liste finden Sie detaillierte Informationen zu jedem Microservice, einschließlich seines Namens, des zugehörigen Pakets, der Version, des aktuellen Zustands und der Ressourcennutzung.
75 Diese Informationen sind nützlich für die Überwachung, Fehlerbehebung und Verwaltung der Microservice-Infrastruktur.
76
77 Mit den optionalen Parametern können Sie die Ausgabe filtern und spezifische Microservices oder Instanzen abrufen.
78
79 |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
80 |-ConnectionName|String|✅|C|Der Name der Verbindung, Informationen zu Microservice-Instanzen abgerufen werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
81 |-InstanceNames|String[]|✅❌| |Gibt die Namen der Microservice-Instanzen an, die abgerufen werden sollen. Du kannst einen oder mehrere Instanznamen als String-Array übergeben.
82 |-SupervisorIds|String[]|✅❌| |Filtert Microservices basierend auf den IDs ihrer übergeordneten Supervisoren. Du musst eine oder mehrere Supervisor-IDs als String-Array übergeben.
83 |-ShowAllInstances|SwitchParameter|✅| |Wenn dieser Parameter angegeben wird, zeigt das Cmdlet alle Instanzen von Microservices an, einschließlich derer, die normalerweise ausgeblendet oder als inaktiv betrachtet werden könnten.
84
85 === Parameter-Sets ===
86
87 Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:
88
89 * **InstanceNamesParameterSetName**: Ermöglicht das Abrufen von Microservices, basierend auf ihren Instanznamen.
90 * **SupervisorsParameterSetName**: Ermöglicht das Abrufen von Microservices, die bestimmten Supervisor-IDs zugeordnet sind.
91 * **NotRequiredParameterSetName**: Dient hauptsächlich dazu, die ShowAllInstances-Option zu ermöglichen.
92
93 Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
94
95 === **Beispiele** ===
96
97 Beispiel 1: Alle Microservices auflisten
98
99 {{code language="PowerShell"}}
100 Get-AESBMicroservices
101 {{/code}}
102
103 Dieser Befehl ruft alle registrierten AESB Microservices ab und zeigt deren detaillierte Informationen an. Ohne explizite Parameterauswahl fällt dies in das //NotRequiredParameterSetName//.
104
105 Beispiel 2: Einen spezifischen Microservice nach Namen abrufen
106
107 {{code language="PowerShell"}}
108 Get-AESBMicroservices -InstanceNames "TestMicroservice"
109
110 {{/code}}
111
112 Dieser Befehl ruft Informationen nur für die Microservice-Instanz mit dem Namen "TestMicroservice" ab. Hier wird das //InstanceNamesParameterSetName// verwendet.
113
114 Beispiel 3: Mehrere Microservices nach Namen abrufen
115
116 {{code language="PowerShell"}}
117 Get-AESBMicroservices -InstanceNames "TestMicroservice1", "TestMicroservice2"
118
119 {{/code}}
120
121 Dieser Befehl ruft Informationen für die Microservice-Instanzen "TestMicroservice1" und "TestMicroservice2" ab, ebenfalls unter Verwendung des //InstanceNamesParameterSetName.//
122
123 Beispiel 4: Alle Microservices inklusive inaktiver Instanzen anzeigen
124
125 {{code language="PowerShell"}}
126 Get-AESBMicroservices -ShowAllInstances
127 {{/code}}
128
129 Dieser Befehl zeigt alle Microservice-Instanzen an, auch diejenigen, die normalerweise ausgeblendet würden. Dies nutzt das //NotRequiredParameterSetName//.
130
131 Beispiel 5: Microservices nach Supervisor-ID Filtern (GUID
132
133 {{code language="PowerShell"}}
134 Get-AESBMicroservices -SupervisorIds "ffffffff-ffff-ffff-ffff-ffffffffffff"
135
136 {{/code}}
137
138 === **Rückgabewerte** ===
139
140 Das Cmdlet gibt eine Sammlung von Objekten zurück, die jeweils die folgenden Eigenschaften für einen Microservice enthalten:
141
142 * **Name**: Der eindeutige Name der Microservice-Instanz.
143 * **Package**: Der Name des Pakets, zu dem der Microservice gehört.
144 * **PackageVersion**: Die Version des zugehörigen Pakets.
145 * **TemplateName**: Der Name der Vorlage, die zum Erstellen dieser Microservice-Instanz verwendet wurde.
146 * **InstanceId**: Eine eindeutige ID der Microservice-Instanz (GUID).
147 * **Routing**: Informationen zum Routing des Microservices (in der Regel ein leeres Array, wenn keine spezifischen Routing-Regeln konfiguriert sind).
148 * **IndividualSicsCredentials**: Zeigt an, ob der Microservice individuelle SICS-Anmeldeinformationen verwendet (True/False).
149 * **LoggingEnabled**: Zeigt an, ob die Protokollierung für den Microservice aktiviert ist (True/False).
150 * **StartupType**: Der Starttyp des Microservices (z.B. Manuell oder Automatisch).
151 * **Scheduling**: Informationen zur Zeitplanung des Microservices (z.B. NotAvailable, wenn keine Zeitplanung konfiguriert ist).
152 * **ServiceState**: Der aktuelle Zustand des Microservices (z.B. Stopped, Running).
153 * **ProcessId**: Die Prozess-ID des Microservices, wenn er ausgeführt wird.
154 * **SicsUsername**: Der SICS-Benutzername, der vom Microservice verwendet wird.
155 * **CpuUsage**: Die aktuelle CPU-Auslastung des Microservices in Prozent.
156 * **MemoryUsage**: Die aktuelle Speicherauslastung des Microservices in Bytes.
157
158 == Edit-AESBMicroservices ==
159
160 Dieses Cmdlet ermöglicht die Bearbeitung der Konfiguration eines spezifischen Microservice. Derzeit unterstützt es die Änderung des Starttyps (StartupType) und optional die Konfiguration von Anmeldeinformationen (Credentials) für den Microservice. Dies ist besonders nützlich, um das Startverhalten von Microservices zu steuern oder SICS-Anmeldeinformationen zu aktualisieren.
161
162 |=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=Datentyp|=Optional|=Beschreibung
163 |-ConnectionName| |String|✅|Der Name der Verbindung, über die Microservice-Instanzen bearbeitet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
164 |-InstanceName|NoCredentialParameterSetName,
165 CredentialParameterSetName|String|❌|Gibt den eindeutigen Namen der Microservice-Instanz an, deren Konfiguration geändert werden soll. Dieser Parameter ist in beiden Parametersets obligatorisch.
166 |-UseCredentials|CredentialParameterSetName|SwitchParameter|✅❌|Gibt an, dass Anmeldeinformationen für den Microservice konfiguriert werden sollen. Dieser Parameter gehört zum CredentialParameterSetName und ist obligatorisch, wenn dieses Set verwendet wird.
167 |-UserName|CredentialParameterSetName|String|✅❌|Gibt den Benutzernamen an, der verwendet werden soll, wenn UseCredentials aktiviert ist. Dieser Parameter gehört zum CredentialParameterSetName und ist obligatorisch, wenn dieses Set verwendet wird.
168 |-Password|CredentialParameterSetName|SecureString|✅❌|Gibt das Passwort für den angegebenen Benutzernamen an. Das Passwort muss als SecureString-Objekt übergeben werden. Dieser Parameter gehört zum CredentialParameterSetName und ist obligatorisch, wenn dieses Set verwendet wird.
169 |-StartupType|NoCredentialParameterSetName,
170 CredentialParameterSetName|Enum|❌|Legt fest, wie der Microservice beim Systemstart verhalten soll. Dies ist ein Enum-Wert vom Typ InstanceStartType. Gängige Werte sind Automatic (startet automatisch mit dem System) und Manual (muss manuell gestartet werden).
171
172 === Parameter-Sets ===
173
174 Das Cmdlet verwendet Parameter-Sets, um zwei Hauptszenarien zu unterstützen:
175
176 * **NoCredentialParameterSetName**: Ermöglicht die Bearbeitung des Starttyps ohne die Angabe von Anmeldeinformationen.
177 * **CredentialParameterSetName**: Ermöglicht die Bearbeitung des Starttyps //und// die Konfiguration von Anmeldeinformationen für den Microservice.
178
179 Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
180
181 === Beispiele ===
182
183 Beispiel 1: Starttyp eines Microservice auf "Automatisch" ändern
184
185 {{code language="PowerShell"}}
186 Edit-AESBMicroservice -InstanceName "TestMicroservice1" -StartupType Automatic
187
188 {{/code}}
189
190 Dieser Befehl ändert den Starttyp des Microservice mit dem Namen "TestMicroservice" auf "Automatisch". Hier wird das //NoCredentialParameterSetName// verwendet.
191
192 Beispiel 2: Starttyp ändern und individuelle Anmeldeinformationen festlegen
193
194 {{code language="PowerShell" layout="LINENUMBERS"}}
195 $password = ConvertTo-SecureString "YourSecurePassword" -AsPlainText -Force
196 Edit-AESBMicroservice -InstanceName "TestMicroservice" -UseCredentials -Username "MySicsUser" -Password $password -StartupType Automatic
197 {{/code}}
198
199 Dieser Befehl ändert den Starttyp des Microservice "TestMicroservice" auf "Automatisch" und konfiguriert individuelle SICS-Anmeldeinformationen mit dem angegebenen Benutzernamen und Passwort. Hier wird das //CredentialParameterSetName// verwendet.
200
201 == Kill-AESBMicroservices ==
202
203 Mit diesem Cmdlet können Sie laufende Microservices gezielt beenden. Dies ist nützlich für die Wartung, Fehlerbehebung oder das Herunterfahren bestimmter Microservice-Instanzen. Das Cmdlet bietet zwei Methoden zum Ansprechen der zu beendenden Microservices: entweder direkt über deren Instanz-IDs oder indirekt über die ID ihres Supervisoren, wodurch alle zugehörigen Microservices beendet werden.
204
205 |=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=Datentyp|=Optional|=Beschreibung
206 |-ConnectionName| |String|✅|Der Name der Verbindung, über welche die Ausführung von Microservice-Instanzen abgebrochen werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
207 |-InstanceIds|UseMicroservicesIdListParameterSet|String[]|✅❌|Gibt eine Liste von eindeutigen Instanz-IDs (GUIDs als String) der Microservices an, die beendet werden sollen.
208 |-SupervisorId|UseSupervisorIdParameterSet|String|✅❌|Der **SupervisorId**-Parameter gibt die eindeutige ID (GUID als String) des Supervisors an. Alle Microservices, die von diesem spezifischen Supervisor verwaltet werden, werden beendet.
209
210 === Parameter-Sets ===
211
212 Das Cmdlet verwendet Parameter-Sets, um diese beiden Betriebsmodi zu unterscheiden:
213
214 * **UseMicroservicesIdListParameterSet**: Ermöglicht das Ansprechen von Microservices über eine Liste ihrer eindeutigen Instanz-IDs.
215 * **UseSupervisorIdParameterSet**: Ermöglicht das Ansprechen von Microservices durch Angabe der ID ihres Supervisoren. Alle Microservices, die diesem Supervisor zugeordnet sind, werden beendet.
216
217 Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
218
219 === Beispiele ===
220
221
222 == Move-AESBMicroservices ==
223
224 == Remove-AESBMicroservices ==
225
226 == Restart-AESBMicroservices ==
227
228 == Set-AESBMicroserviceLogging ==
229
230 == Start-AESBMicroservices ==
231
232 == Stop-AESBMicroservices ==
233
234 = Packages =
235
236 == Get-AESBMicroservicePackages ==
237
238 = Templates =
239
240 == Add-AESBMicroserviceTemplate ==
241
242 == Export-MicroserviceTemplateConfig ==
243
244 == Get-AESBMicroserviceTemplateConfig ==
245
246 == Import-AESBMicroserviceTemplateConfig ==
247
248 == Migrate-AESBMicroserviceTemplate ==
249
250 == New-AESBMicroserviceTemplateConfig ==
251
252 == Remove-AESBMicroserviceTemplate ==
253
254 == Update-AESBMicroserviceTemplate ==
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community