Wiki-Quellcode von Microservice Cmdlets

Version 14.1 von jklein am 2025/07/30 13:43
Zeige letzte Bearbeiter
1 {{aagon.floatingbox/}}
2
3 = Instances =
4
5 == Add-AESBMicroservice ==
6
7 Mit diesem Cmdlet wird eine neue Microservice-Instanz auf Grundlage einer bestimmten Vorlage hinzugefügt.
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.
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 === **Beispiele** ===
28
29 Beispiel 1: Microservice über Vorlagen-Name hinzufügen
30
31 {{code language="PowerShell"}}
32 Add-AESBMicroservice -InstanceName "Test" -TemplateName "Tester"
33 {{/code}}
34
35 Dieses Beispiel fügt eine neue Instanz mithilfe des Vorlagen-Namen hinzu. Die Standardverbindung wird verwendet.
36
37 Beispiel 2: Microservice über Vorlagen-Id hinzufügen
38
39 {{code language="PowerShell"}}
40 Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff"
41
42 {{/code}}
43
44 (% class="wikigeneratedid" %)
45 Dieses Beispiel fügt eine neue Instanz mithilfe der Vorlagen-Id hinzu. Die Standardverbindung wird verwendet.
46
47 Beispiel 3: Microservice-StartUpType beim Hinzufügen setzen
48
49 {{code language="PowerShell"}}
50 Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StartupType Manual
51 {{/code}}
52
53 Dieses Beispiel fügt eine neue Instanz mithilfe der Vorlagen-Id hinzu und setzt den //StartupType// auf //Manuell//. Die Standardverbindung wird verwendet.
54
55 Beispiel 4: Microservice mit SupervisorId setzen
56
57 {{code language="PowerShell"}}
58 Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff"
59
60 {{/code}}
61
62 Dieses Beispiel fügt eine neue Instanz einem bestimmten Supervisor hinzu, der über die Supervisor-Id angegeben wird. Die Standardverbindung wird verwendet.
63
64 Beispiel 5: Microservice mit StoppedAfterCreation setze
65
66 {{code language="PowerShell"}}
67 Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StoppedAfterCreation false
68
69 {{/code}}
70
71 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.
72
73 Beispiel 6: Microservice mit vielen Parametern
74
75 {{code language="PowerShell"}}
76 Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StartupType Manual -StoppedAfterCreation false
77 {{/code}}
78
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
81 (% style="color:inherit; font-family:inherit; font-size:25px; font-weight:bold" %)**Get-AESBMicroservice**
82
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 Diese Informationen sind nützlich für die Überwachung, Fehlerbehebung und Verwaltung der Microservice-Infrastruktur.
85
86 Mit den optionalen Parametern können Sie die Ausgabe filtern und spezifische Microservices oder Instanzen abrufen.
87
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.
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 |-SupervisorIds|String[]|✅❌| |Filtert Microservices basierend auf den IDs ihrer übergeordneten Supervisoren. Du musst eine oder mehrere Supervisor-IDs als String-Array übergeben.
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.
93
94 === Parameter-Sets ===
95
96 Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:
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.
101
102 Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
103
104 === **Beispiele** ===
105
106 Beispiel 1: Alle Microservices auflisten
107
108 {{code language="PowerShell"}}
109 Get-AESBMicroservices
110 {{/code}}
111
112 Dieser Befehl ruft alle registrierten AESB Microservices ab und zeigt deren detaillierte Informationen an. Ohne explizite Parameterauswahl fällt dies in das //NotRequiredParameterSetName//.
113
114 Beispiel 2: Einen spezifischen Microservice nach Namen abrufen
115
116 {{code language="PowerShell"}}
117 Get-AESBMicroservices -InstanceNames "TestMicroservice"
118
119 {{/code}}
120
121 Dieser Befehl ruft Informationen nur für die Microservice-Instanz mit dem Namen "TestMicroservice" ab. Hier wird das //InstanceNamesParameterSetName// verwendet.
122
123 Beispiel 3: Mehrere Microservices nach Namen abrufen
124
125 {{code language="PowerShell"}}
126 Get-AESBMicroservices -InstanceNames "TestMicroservice1", "TestMicroservice2"
127
128 {{/code}}
129
130 Dieser Befehl ruft Informationen für die Microservice-Instanzen "TestMicroservice1" und "TestMicroservice2" ab, ebenfalls unter Verwendung des //InstanceNamesParameterSetName.//
131
132 Beispiel 4: Alle Microservices inklusive inaktiver Instanzen anzeigen
133
134 {{code language="PowerShell"}}
135 Get-AESBMicroservices -ShowAllInstances
136 {{/code}}
137
138 Dieser Befehl zeigt alle Microservice-Instanzen an, auch diejenigen, die normalerweise ausgeblendet würden. Dies nutzt das //NotRequiredParameterSetName//.
139
140 Beispiel 5: Microservices nach Supervisor-ID Filtern (GUID
141
142 {{code language="PowerShell"}}
143 Get-AESBMicroservices -SupervisorIds "ffffffff-ffff-ffff-ffff-ffffffffffff"
144
145 {{/code}}
146
147 === **Rückgabewerte** ===
148
149 Das Cmdlet gibt eine Sammlung von Objekten zurück, die jeweils die folgenden Eigenschaften für einen Microservice enthalten:
150
151 * **Name**: Der eindeutige Name der Microservice-Instanz.
152 * **Package**: Der Name des Pakets, zu dem der Microservice gehört.
153 * **PackageVersion**: Die Version des zugehörigen Pakets.
154 * **TemplateName**: Der Name der Vorlage, die zum Erstellen dieser Microservice-Instanz verwendet wurde.
155 * **InstanceId**: Eine eindeutige ID der Microservice-Instanz (GUID).
156 * **Routing**: Informationen zum Routing des Microservices (in der Regel ein leeres Array, wenn keine spezifischen Routing-Regeln konfiguriert sind).
157 * **IndividualSicsCredentials**: Zeigt an, ob der Microservice individuelle SICS-Anmeldeinformationen verwendet (True/False).
158 * **LoggingEnabled**: Zeigt an, ob die Protokollierung für den Microservice aktiviert ist (True/False).
159 * **StartupType**: Der Starttyp des Microservices (z.B. Manuell oder Automatisch).
160 * **Scheduling**: Informationen zur Zeitplanung des Microservices (z.B. NotAvailable, wenn keine Zeitplanung konfiguriert ist).
161 * **ServiceState**: Der aktuelle Zustand des Microservices (z.B. Stopped, Running).
162 * **ProcessId**: Die Prozess-ID des Microservices, wenn er ausgeführt wird.
163 * **SicsUsername**: Der SICS-Benutzername, der vom Microservice verwendet wird.
164 * **CpuUsage**: Die aktuelle CPU-Auslastung des Microservices in Prozent.
165 * **MemoryUsage**: Die aktuelle Speicherauslastung des Microservices in Bytes.
166
167 == Edit-AESBMicroservice ==
168
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
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).
180
181 === Parameter-Sets ===
182
183 Das Cmdlet verwendet Parameter-Sets, um zwei Hauptszenarien zu unterstützen:
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.
187
188 Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
189
190 === Beispiele ===
191
192 Beispiel 1: Starttyp eines Microservice auf "Automatisch" ändern
193
194 {{code language="PowerShell"}}
195 Edit-AESBMicroservice -InstanceName "TestMicroservice1" -StartupType Automatic
196
197 {{/code}}
198
199 Dieser Befehl ändert den Starttyp des Microservice mit dem Namen "TestMicroservice" auf "Automatisch". Hier wird das //NoCredentialParameterSetName// verwendet.
200
201 Beispiel 2: Starttyp ändern und individuelle Anmeldeinformationen festlegen
202
203 {{code language="PowerShell" layout="LINENUMBERS"}}
204 $password = ConvertTo-SecureString "YourSecurePassword" -AsPlainText -Force
205 Edit-AESBMicroservice -InstanceName "TestMicroservice" -UseCredentials -Username "MySicsUser" -Password $password -StartupType Automatic
206 {{/code}}
207
208 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.
209
210 == Kill-AESBMicroservices ==
211
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
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.
216 |-InstanceIds|UseMicroservicesIdListParameterSet|String[]|✅❌|Gibt eine Liste von eindeutigen Instanz-IDs (GUIDs als String) der Microservices an, die beendet werden sollen.
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
219 === Parameter-Sets ===
220
221 Das Cmdlet verwendet Parameter-Sets, um diese beiden Betriebsmodi zu unterscheiden:
222
223 * **UseMicroservicesIdListParameterSet**: Ermöglicht das Ansprechen von Microservices über eine Liste ihrer eindeutigen Instanz-IDs.
224 * **UseSupervisorIdParameterSet**: Ermöglicht das Ansprechen von Microservices durch Angabe der ID ihres Supervisoren. Alle Microservices, die diesem Supervisor zugeordnet sind, werden beendet.
225
226 Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.
227
228 === Beispiele ===
229
230 Beispiel 1: Einen spezifischen Microservice mit seiner Instanz-ID beenden
231
232 {{code language="PowerShell"}}
233 Kill-AESBMicroservices -InstanceIds "ffffffff-ffff-ffff-ffff-ffffffffffff"
234
235 {{/code}}
236
237 Dieser Befehl versucht, den Microservice mit der angegebenen Instanz-ID zu beenden. Die Beispielausgabe zeigt, dass der Microservice bereits gestoppt war. Hier wird das //UseMicroservicesIdListParameterSet// verwendet.
238
239 Beispiel 2: Mehrere Microservices mit ihren Instanz-IDs beenden
240
241 {{code language="PowerShell"}}
242 Kill-AESBMicroservices -InstanceIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2"
243
244 {{/code}}
245
246 Dieser Befehl versucht, die Microservices mit den angegebenen Instanz-IDs zu beenden.
247
248 Beispiel 3: Alle Microservices beenden, die einem bestimmten Supervisor zugeordnet sin
249
250 {{code language="PowerShell"}}
251 Kill-AESBMicroservices -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff"
252 {{/code}}
253
254 Dieser Befehl beendet alle Microservices, die dem Supervisor mit der angegebenen ID zugeordnet sind. Hier wird das //UseSupervisorIdParameterSet// verwendet.
255
256 === Rückgabewerte ===
257
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
260 * **Status**: Der Status der Beendigungsoperation (z.B. //Unchanged/Changed//).
261 * **InstanceId**: Die eindeutige ID der betroffenen Microservice-Instanz.
262 * **InstanceState**: Der Zustand des Microservice nach der Operation (z.B. //Stopped/Already stopped//).
263 * **Error**: Eine Fehlermeldung, falls die Operation nicht erfolgreich war oder ein Problem aufgetreten ist.
264
265 == Move-AESBMicroservices ==
266
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
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).
275
276 === Beispiele ===
277
278 Beispiel 1: Einen Microservice zu einem neuen Supervisor verschieben
279
280 {{code language="PowerShell"}}
281 Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa"
282 {{/code}}
283
284 Dieser Befehl verschiebt den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-ffffffffffff" zu dem Supervisor mit der ID "ffffffff-ffff-ffff-ffff-aaaaaaaa".
285
286 Das Cmdlet wartet, bis der Vorgang abgeschlossen ist (Standard-Timeout von 30 Sekunden).
287
288 Beispiel 2: Mehrere Microservices zu einem neuen Supervisor verschieben und nicht auf Abschluss warten.
289
290 {{code language="PowerShell"}}
291 Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -NoWait
292
293 {{/code}}
294
295 Dieser Befehl initiiert die Verschiebung der Microservices mit den Instanz-IDs "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" und "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" zu "ffffffff-ffff-ffff-ffff-aaaaaaaa" und kehrt sofort zurück, ohne auf den Abschluss des Vorgangs zu warten.
296
297 Beispiel 3: Einen Microservice verschieben mit längerem Timeout
298
299 {{code language="PowerShell"}}
300 Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -Timeout "5m"
301 {{/code}}
302
303 Dieser Befehl versucht, "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" zu "ffffffff-ffff-ffff-ffff-aaaaaaaa" zu verschieben und wartet bis zu 5 Minuten auf den Abschluss des Vorgangs.
304
305 === Rückgabewerte ===
306
307 Das Cmdlet gibt für jede verschobene Instanz ein Objekt mit folgenden Eigenschaften zurück:
308
309 * **InstanceId**: Die ID der verschobenen Microservice-Instanz
310 * **SicsUsername**: Der zugehörige Benutzername (z. B. für die Verbindung)
311 * **IsIdentified**: Gibt an, ob die Instanz eindeutig identifiziert wurde
312 * **ProcessState**: Aktueller Prozessstatus der Instanz (z. B. Stopped)
313 * **LastUpdate**: Zeitpunkt der letzten Statusänderung
314 * **Timestamp**: Zeitstempel der letzten Änderung
315 * **ProcessId**: (Optional) Prozess-ID der Instanz
316 * **CpuUsage**: (Optional) CPU-Auslastung der Instanz
317 * **RamUsage**: (Optional) RAM-Auslastung der Instanz
318
319 == Remove-AESBMicroservices ==
320
321 Dieses Cmdlet entfernt die angegebenen Microservice-Instanzen. Die zu entfernenden Microservices können entweder über ihre Instanz-Namen oder ihre Instanz-IDs identifiziert werden. Es muss einer der Parameter -//InstanceNames// oder -//InstanceIds// angegeben werden. Die Parameter können nicht zusammen verwendet werden.
322
323 |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
324 |-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen entfernt werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
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 |-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
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 === Beispiele ===
336
337 Beispiel 1: Einen Microservice anhand seiner Instanz-ID entfernen
338
339 {{code language="PowerShell"}}
340 Remove-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"
341 {{/code}}
342
343 Dieser Befehl entfernt den Microservice mit der Instanz-ID "b6cb7044-b6b2-4a64-9997-29f0ea5283db". Die Ausgabe zeigt die Instanz und das Ergebnis "Success".
344
345 Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs entfernen
346
347 {{code language="PowerShell"}}
348 Remove-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"
349 {{/code}}
350
351 Dieser Befehl entfernt zwei Microservices, die durch ihre jeweiligen Instanz-IDs identifiziert werden.
352
353 Beispiel 3: Einen Microservice anhand seines Namens entfernen
354
355 {{code language="PowerShell"}}
356 Remove-AESBMicroservice -InstanceNames "MeinService"
357
358 {{/code}}
359
360 Dieser Befehl entfernt den Microservice mit dem Namen "MeinService".
361
362 Beispiel 4: Mehrere Microservices anhand ihrer Namen entfernen und Bestätigung anfordern
363
364 {{code language="PowerShell"}}
365 Remove-AESBMicroservice -InstanceNames "Service1", "Service2" -Confirm
366 {{/code}}
367
368 Dieser Befehl versucht, die Microservices "Service1" und "Service2" zu entfernen. Vor dem eigentlichen Entfernen wird der Benutzer um Bestätigung gebeten.
369
370 Beispiel 5: Microservices über die Pipeline anhand von Instanz-IDs entfernen
371
372 {{code language="PowerShell"}}
373 "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" | Remove-AESBMicroservice -InstanceIds
374
375 {{/code}}
376
377 Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Remove-Microservice`, um die entsprechenden Microservices zu entfernen.
378
379 === Rückgabewerte ===
380
381 Das Cmdlet gibt für jeden versuchten Entfernungsvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
382
383 * **Instance**: Die ID oder der Name des Microservices.
384 * **Result**: Das Ergebnis des Entfernungsvorgangs (z.B. "Success", "Failed").
385
386 == Restart-AESBMicroservices ==
387
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
449 == Set-AESBMicroserviceLogging ==
450
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 === **Beispiele** ===
460
461 Beispiel 1: Logging für einen Microservice aktivieren
462
463 {{code language="PowerShell"}}
464 Set-AESBMicroserviceLogging -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -Enable
465 {{/code}}
466
467 Dieser Befehl aktiviert das Logging für den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffffffff1".
468
469 Beispiel 2: Logging für mehrere Microservices deaktivieren
470
471 {{code language="PowerShell"}}
472 Set-AESBMicroserviceLogging -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -Disable
473
474 {{/code}}
475
476 Dieser Befehl deaktiviert das Logging für die Microservices mit den angegebenen Instanz-IDs.
477
478 Beispiel 3: Logging für einen Microservice über die Pipeline aktivieren
479
480 {{code language="PowerShell"}}
481 "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" | Set-AESBMicroserviceLogging -Enable
482
483 {{/code}}
484
485 Dieser Befehl übergibt eine Instanz-ID über die Pipeline an `Set-MicroserviceLogging`, um das Logging für den entsprechenden Microservice zu aktivieren.
486
487 === Rückgabewerte ===
488
489 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:
490
491 * **Status**: Der Status der Operation (z.B. "Changed", "Unchanged", "Failed").
492 * **MicroserviceId**: Die Instanz-ID des Microservices.
493 * **MicroserviceName**: Der Name des Microservices.
494 * **Logging**: Der neue Logging-Status (True oder False).
495
496 == Start-AESBMicroservices ==
497
498 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.
499
500 |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
501 |-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestartet werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
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`.
504 |-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Startvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
505 |-NoWait      |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Startvorgangs, sondern kehrt sofort zurück.
506
507 === **Beispiele** ===
508
509 Beispiel 1: Einen Microservice anhand seiner Instanz-ID starten
510
511 {{code language="PowerShell"}}
512 Start-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffff1"
513
514 {{/code}}
515
516 Dieser Befehl startet den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffff1" und wartet auf das Ergebnis.
517
518 Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs starten mit Timeout
519
520 {{code language="PowerShell"}}
521 Start-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffff2" -Timeout "1m"
522
523 {{/code}}
524
525 Dieser Befehl startet zwei Microservices und setzt das Timeout für den Vorgang auf eine Minute.
526
527 Beispiel 3: Alle Microservices eines Supervisors starten, ohne auf den Abschluss zu warten
528
529 {{code language="PowerShell"}}
530 Start-AESBMicroservices -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -NoWait
531
532 {{/code}}
533
534 Dieser Befehl initiiert den Start aller Microservices, die vom Supervisor "ffffffff-ffff-ffff-ffff-aaaaaaaa" verwaltet werden, und kehrt sofort zurück.
535
536 Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs starten
537
538 {{code language="PowerShell"}}
539 "aaaaaaaa-ffff-ffff-ffff-fffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffff2" | Start-AESBMicroservices
540
541 {{/code}}
542
543 Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Start-Microservices`, um die entsprechenden Microservices zu starten.
544
545 === **Rückgabewert** ===
546
547 Das Cmdlet gibt für jeden versuchten Startvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
548
549 * **InstanceName**: Der Name des Microservices.
550 * **InstanceId:** Die Instanz-ID des Microservices.
551 * **Status**: Das Ergebnis des Startvorgangs (z.B. "Started", "Failed", "AlreadyRunning").
552
553 == Stop-AESBMicroservices ==
554
555 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.
556
557 |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
558 |-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestoppt werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
559 |-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestoppt werden sollen. Obligatorisch für Parametersatz `UseSupervisorIdParameterSet`.
560 |-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`.
561 |-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Stoppvorgang an (z.B. "5s", "1m"). Standardwert: "5s".
562 |-NoWait      |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Stoppvorgangs, sondern kehrt sofort zurück.
563
564 === **Beispiele** ===
565
566 Beispiel 1: Einen Microservice anhand seiner Instanz-ID stoppen
567
568 {{code language="PowerShell"}}
569 Stop-AESBMicroservices -InstanceIds "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1"
570 {{/code}}
571
572 Dieser Befehl stoppt den Microservice mit der Instanz-ID "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1" und wartet auf das Ergebnis.
573
574 Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs stoppen mit Timeout
575
576 {{code language="PowerShell"}}
577 Stop-AESBMicroservices -InstanceIds "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" -Timeout "10s"
578
579 {{/code}}
580
581 Dieser Befehl stoppt zwei Microservices und setzt das Timeout für den Vorgang auf zehn Sekunden.
582
583 Beispiel 3: Alle Microservices eines Supervisors stoppen, ohne auf den Abschluss zu warten
584
585 {{code language="PowerShell"}}
586 Stop-AESBMicroservices -SupervisorId "FinanceSupervisor" -NoWait
587
588 {{/code}}
589
590 Dieser Befehl initiiert den Stoppvorgang aller Microservices, die vom Supervisor "FinanceSupervisor" verwaltet werden, und kehrt sofort zurück.
591
592 Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs stoppen
593
594 {{code language="PowerShell"}}
595 "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1", "another-guid-for-stop" | Stop-AESBMicroservices
596
597 {{/code}}
598
599 Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Stop-AESBMicroservices`, um die entsprechenden Microservices zu stoppen.
600
601 === **Rückgabewert** ===
602
603 Das Cmdlet gibt für jeden versuchten Stoppvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
604
605 * **Status**: Der Status der Operation (z.B. "Changed", "Unchanged", "Failed")
606 * **InstanceId**: Die Instanz-ID des Microservices.
607 * **InstanceState**: Der Zustand des Microservices nach dem versuchten Stoppvorgang (z.B. "Stopped", "Running").
608 * **Error**: Fehlermeldungen, falls der Stoppvorgang nicht erfolgreich war.
609
610 = Packages =
611
612 == Get-AESBMicroservicePackages ==
613
614 Dieses Cmdlet ruft eine Liste aller verfügbaren Microservice-Pakete und deren Versionen ab. Es sind keine spezifischen Parameter erforderlich.
615
616 |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
617 |-ConnectionName|String|✅|C|Der Name der Verbindung, über die Informationen zu Microservice-Paketen abgerufen werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
618
619 === **Beispiele** ===
620
621 Beispiel 1: Alle verfügbaren Microservice-Pakete auflisten
622
623 {{code language="PowerShell"}}
624 Get-AESBMicroservicePackages
625
626 {{/code}}
627
628 Dieser Befehl ruft alle verfügbaren Microservice-Pakete und die zugehörigen Versionen ab.
629
630 === **Rückgabewert** ===
631
632 Das Cmdlet gibt für jedes gefundene Microservice-Paket ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
633
634 * **PackageName**: Der Name des Microservice-Pakets.
635 * **PackageVersions**: Eine Liste der verfügbaren Versionen für dieses Paket.
636
637 = Templates =
638
639 == Add-AESBMicroserviceTemplate ==
640
641 Dieses Cmdlet fügt eine Microservice-Vorlage auf Basis der beigefügten Vorlagen-Konfiguration hinzu.
642
643 |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
644 |-ConnectionName|String|✅|C|Der Name der Verbindung, über die eine Vorlage hinzugefügt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
645 |-TemplateName|String|❌|Keine|Der Name für die Vorlage.
646 |-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration der Vorlage.
647
648 === **Beispiele** ===
649
650 Beispiel 1: Fügt ein neue Microservice-Vorlage hinzu
651
652 {{code language="PowerShell"}}
653 Add-AESBMicroserviceTemplate -TemplateName "Test" -TemplateConfig $templateConfig
654 {{/code}}
655
656 Dieses Beispiel fügt eine neue Vorlagen-konfiguration mit dem Namen "Test" auf Basis des $templateConfig-Objekts hinzu. Die Standardverbindung wird verwendet.
657
658 {{apimacro title="Beispiel der Funktion in PowerShell"}}
659 {{code language="PowerShell" layout="LINENUMBERS"}}
660 function Add-MicroserviceTemplate {
661 param (
662 [string]$Name
663 )
664
665 $packages = Get-AESBMicroservicePackages
666
667 $microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packages[0].PackageName -PackageVersion $packages[0].PackageVersions[0]
668
669 $addMicroserviceResult = Add-AESBMicroserviceTemplate -TemplateName $Name -TemplateConfig $microserviceTemplateConfig
670
671 return $addMicroserviceResult
672 }
673 {{/code}}
674 {{/apimacro}}
675
676 {{apimacro title="Beispiel der Vorlagen-Konfiguration"}}
677 {{code language="PowerShell" layout="LINENUMBERS"}}
678 $templateConfig = "<MicroserviceConfiguration Version=`"1.11.0.895`" Type=`"SnmpConnector`" SessionKey=`"bcafdb4e94f2572eed78525430ad0e0275229f98`">
679 <SnmpConnectorConfiguration>
680 <SnmpReader>
681 <ParallelRequests>10</ParallelRequests>
682 <SchedulingConfig>
683 <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
684 <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
685 <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
686 </SchedulingConfig>
687 <Groups />
688 <GlobalCredentialLists>
689 <GlobalCredentials />
690 <GlobalCredentialsNoPriv />
691 <GlobalCredentialsNoAuthNoPriv />
692 </GlobalCredentialLists>
693 </SnmpReader>
694 <SnmpWriters>
695 <DescriptionWriteMode>Keep</DescriptionWriteMode>
696 <LocationWriteMode>Ignore</LocationWriteMode>
697 <ContactWriteMode>Ignore</ContactWriteMode>
698 <ProcessorWriter />
699 <DispatcherStarter />
700 <FileDumper />
701 </SnmpWriters>
702 </SnmpConnectorConfiguration>
703 </MicroserviceConfiguration>"
704 {{/code}}
705 {{/apimacro}}
706
707 === **Rückgabewerte** ===
708
709 Bei erfolgreicher Anwendung erhalten Sie zwei Objekte zurück.
710
711 * String
712 ** Erfolgreiche Statusmeldung
713 * TemplateInfo
714 ** TemplateId
715 *** ID der Vorlage
716 ** Configuration
717 *** Aktuelle Konfiguration der Vorlage
718 ** Name
719 *** Name der Vorlage
720 ** Type
721 *** Der Typ der Vorlage
722 ** Version
723 *** Die Versionierung der Vorlage
724
725 {{apimacro title="Rückgabewerte der Vorlagen-Konfiguration"}}
726 {{code language="PowerShell" layout="LINENUMBERS"}}
727 Successfully added template 'Test'.
728
729 TemplateId : 119398aa-8108-43bd-811b-bd3e703e7f5c
730 Configuration : <SnmpConnectorConfiguration><SnmpReader><ParallelRequests>10</ParallelRequests><SchedulingConfig><Sched
731 ulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling><SchedulingConfig_Interval>P1D</Scheduling
732 Config_Interval><SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTi
733 me></SchedulingConfig><Groups /><GlobalCredentialLists><GlobalCredentials /><GlobalCredentialsNoPriv
734 /><GlobalCredentialsNoAuthNoPriv /></GlobalCredentialLists></SnmpReader><SnmpWriters><DescriptionWriteM
735 ode>Keep</DescriptionWriteMode><LocationWriteMode>Ignore</LocationWriteMode><ContactWriteMode>Ignore</C
736 ontactWriteMode><ProcessorWriter /><DispatcherStarter /><FileDumper
737 /></SnmpWriters></SnmpConnectorConfiguration>
738 Name : Test
739 Type : SnmpConnector
740 Version : 1.11.0.895
741 {{/code}}
742 {{/apimacro}}
743
744 == Export-MicroserviceTemplateConfig ==
745
746 Dieses Cmdlet ermöglicht es, die Konfiguration einer Microservice-Vorlagen zu exportieren.
747
748 |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
749 |-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
750 |-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration, die exportiert werden soll.
751 |-Path|String|❌|Keine|Der Pfad, unter dem die Microservice-Vorlagen-Konfiguration gespeichert werden soll.
752
753 === **Beispiele** ===
754
755 Beispiel 1: Microservice-Vorlage exportieren
756
757 {{code language="PowerShell"}}
758 Export-AESBMicroserviceTemplateConfig -TemplateConfig $templateConfig -Path $path
759
760 {{/code}}
761
762 In diesem Beispiel wird die //$templateConfig// am Speicherort "C:\Test.xml" exportiert.
763
764 {{code language="PowerShell" layout="LINENUMBERS"}}
765 function Export-MicroserviceTemplateConfig {
766 param (
767 [string]$Path
768 )
769
770 $microserviceTemplates = Get-AESBMicroserviceTemplates
771
772 $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $microserviceTemplates[0].Name
773
774 $exportMicroserviceTemplateConfigResult = Export-AESBMicroserviceTemplateConfig -TemplateConfig $microserviceTemplateConfig -Path $Path
775
776 return $exportMicroserviceTemplateConfigResult
777 }
778 {{/code}}
779
780 {{apimacro title="Beispielhafte XML-Datei nach dem Exportieren"}}
781 {{code language="XML" layout="LINENUMBERS"}}
782 <MicroserviceConfiguration Version="1.11.0.895" Type="SnmpConnector" SessionKey="bcafdb4e94f2572eed78525430ad0e0275229f98">
783 <SnmpConnectorConfiguration>
784 <SnmpReader>
785 <ParallelRequests>10</ParallelRequests>
786 <SchedulingConfig>
787 <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
788 <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
789 <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
790 </SchedulingConfig>
791 <Groups />
792 <GlobalCredentialLists>
793 <GlobalCredentials />
794 <GlobalCredentialsNoPriv />
795 <GlobalCredentialsNoAuthNoPriv />
796 </GlobalCredentialLists>
797 </SnmpReader>
798 <SnmpWriters>
799 <DescriptionWriteMode>Keep</DescriptionWriteMode>
800 <LocationWriteMode>Ignore</LocationWriteMode>
801 <ContactWriteMode>Ignore</ContactWriteMode>
802 <ProcessorWriter />
803 <DispatcherStarter />
804 <FileDumper />
805 </SnmpWriters>
806 </SnmpConnectorConfiguration>
807 </MicroserviceConfiguration>
808 {{/code}}
809 {{/apimacro}}
810
811 === Rückgabewerte ===
812
813 Nach erfolgreichem Exportieren erhalten Sie eine Statusmeldung zurück.
814
815 {{code language="none"}}
816 Writing the file was successful.
817
818 {{/code}}
819
820 == Get-AESBMicroserviceTemplateConfig ==
821
822 Dieses Cmdlet fragt die TemplateConfig einer bestimmten Microservice-Vorlage ab.
823
824 |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
825 |-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
826 |-TemplateName|String|❌|Keine|Der Name der Vorlage für die gewünschte Konfiguration.
827
828 === Beispiele ===
829
830 Beispiel 1: Konfiguration der Microservice-Vorlage von //$templateName// anfragen
831
832 {{code language="PowerShell"}}
833 Get-AESBMicroserviceTemplateConfig -TemplateName $templateName
834 {{/code}}
835
836 Dieses Beispiel fragt die Vorlagen-Konfiguration mit dem Namen //$templateName// an. Die Standardverbindung wird verwendet.
837
838 {{code language="PowerShell" layout="LINENUMBERS"}}
839 function Get-MicroserviceTemplateConfig {
840
841 $aesbMicroserviceTemplates = Get-AESBMicroserviceTemplates
842
843 $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $aesbMicroserviceTemplates[0].Name
844
845 return $microserviceTemplateConfig
846 }
847 {{/code}}
848
849 === Rückgabewerte ===
850
851 Bei erfolgreicher Anwendung erhalten Sie die gewünschte Microservice-Konfiguration zurück:
852
853 * MicroserviceConfiguration
854 ** Version
855 *** Die jeweilige Version des Microservices
856 ** Type
857 *** Der Typ des Microservices
858 ** TypeConfiguration
859 *** Die jeweilige Typ-Konfiguration des Microservices
860
861 {{code language="PowerShell"}}
862 $microserviceTemplateConfig
863
864 MicroserviceConfiguration
865 -------------------------
866 MicroserviceConfiguration
867
868 $microserviceTemplateConfig.MicroserviceConfiguration
869
870 Version Type SnmpConnectorConfiguration
871 ------- ---- --------------------------
872 1.11.0.895 SnmpConnector SnmpConnectorConfiguration
873 {{/code}}
874
875 == Get-AESBMicroserviceTemplates ==
876
877 Dieses Cmdlet fragt die vorhandenen Microservice-Vorlagen ab und listet sie auf.
878
879 |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
880 |-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservices-Vorlagen-Konfiguration importiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
881 |-PackageName|String|✅| |Der Name des Microservice-Pakets, dessen Vorlagen geholt werden sollen
882 |-PackageVersion|String|✅| |Die Version des Pakets, dessen Vorlagen geholt werden sollen
883
884 === Beispiele ===
885
886 Beispiel 1: Alle vorhandenen Microservice-Vorlagen anzeigen
887
888 {{code language="PowerShell"}}
889 Get-AESBMicroserviceTemplates
890 {{/code}}
891
892 Dieses Beispiel listet alle vorhandenen Microservice-Vorlagen auf. Die Standardverbindung wird verwendet. Falls keine Vorlagen vorhanden sind, wird ein Fehler angezeigt.
893
894 Beispiel 2: Die Vorlagen eines bestimmten Microservice-Pakets einer bestimmten Version auflisten
895
896 {{code language="PowerShell"}}
897 Get-AESBMicroserviceTemplates -PackageName "SnmpConnector" -PackageVersion "1.11.0.895"
898
899 {{/code}}
900
901 Dieses Beispiel listet alle vorhandenen Microservice-Vorlagen des Pakets "SnmpConnector" in der Version "1.11.0.895" auf. Die Standardverbindung wird verwendet.
902
903 === Rückgabewerte ===
904
905 Bei erfolgreicher Anwendung werden die gewünschten Microservice-Vorlagen als Objekte aufgelistet.
906
907 * MicroserviceTemplate
908 ** Name
909 *** Der Name der Vorlage
910 ** Id
911 *** Die Id der Vorlage
912 ** PackageName
913 *** Der Name des Microservice-Pakets
914 ** PackageVersion
915 *** Die Version des Microservice-Pakets
916
917 {{code language="PowerShell"}}
918 Name Id PackageName PackageVersion
919
920 ---- -- ----------- --------------
921
922 SnmpConnector a6e37f49-5a15-4213-96f5-e23cc03209a8 SnmpConnector 1.11.0.895
923
924 PS_Microservice1 33618fc3-60f2-484b-b6c9-b9f19c5eb4fa PS_Microservice1 1.1.0.1
925 {{/code}}
926
927 == Import-AESBMicroserviceTemplateConfig ==
928
929 Dieses Cmdlet importiert die Vorlagen-Konfiguration vom angegebenen Pfad.
930
931 |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
932 |-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservices-Vorlagen-Konfiguration importiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
933 |-Path|String|❌|Keine|Der Pfad, von dem die Konfiguration importiert werden soll.
934
935 === Beispiele ===
936
937 Beispiel 1: Vorlagen-Konfiguration von //$path// laden
938
939 {{code language="PowerShell"}}
940 Import-AESBMicroserviceTemplateConfig -Path $path
941
942 {{/code}}
943
944 Dieses Beispiel importiert die Vorlagen-Konfiguration beim hinterlegten Pfad. Die Standardverbindung wird verwendet.
945
946 === Rückgabewerte ===
947
948 Bei erfolgreicher Anwendung erhalten Sie die gewünschte MicroserviceConfiguration zurück:
949
950 * MicroserviceConfiguration
951 ** Version
952 *** Die jeweilige Version des Microservices
953 ** Type
954 *** Der Typ des Microservices
955 ** TypeConfiguration
956 *** Die jeweilige Typ-Konfiguration des Microservices
957
958 {{code language="PowerShell"}}
959 $microserviceTemplateConfig
960
961 MicroserviceConfiguration
962 -------------------------
963 MicroserviceConfiguration
964
965 $microserviceTemplateConfig.MicroserviceConfiguration
966
967 Version Type SnmpConnectorConfiguration
968 ------- ---- --------------------------
969 1.11.0.895 SnmpConnector SnmpConnectorConfiguration
970 {{/code}}
971
972 == Migrate-AESBMicroserviceTemplate ==
973
974 Mit diesem Cmdlet werden bestehende Vorlagen auf die gewünschte Zielversion übertragen.
975
976 |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
977 |-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Vorlagen migriert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
978 |-TemplateNames|String[]|❌|Keine|Hier sind die Namen der Vorlagen, die übertragen werden sollen.
979 |-TargetVersion|String|❌|Keine|Die Zielversion, auf die die Vorlagen migriert werden sollen.
980 |-KeepTemplateIds|SwitchParameter|✅|Keine|Hier wird festgelegt, ob die bestehenden Template-IDs gleich bleiben oder beim Migrieren neu erstellt werden sollen.
981
982 === Beispiele ===
983
984 Beispiel 1: Mehrere Vorlagen auf Version //$templateVersion// migrieren
985
986 {{code language="PowerShell"}}
987 Migrate-AESBMicroserviceTemplates -TemplateNames $templateNames -TargetVersion $templateVersion
988
989 {{/code}}
990
991 Dieses Beispiel migriert alle Vorlagen, die in //$templateNames// stehen, auf die Version //$templateVersion//.
992
993 === Rückgabewerte ===
994
995 Bei erfolgreicher Anwendung erhalten Sie eine Liste von Vorlagen-Informationen mit den neuen Daten der erfolgreich migrierten Vorlagen:
996
997 * TemplateInfo
998 ** TemplateId
999 *** Die neu erstellte / gleichbleibende Id der Vorlage
1000 ** Configuration
1001 *** Die aktuelle Konfiguration der Vorlage
1002 ** Name
1003 *** Der neue Name der Vorlage
1004 ** Type
1005 *** Der Typ der Vorlage
1006 ** Version
1007 *** Die neue Version der Vorlage
1008
1009 {{code language="PowerShell"}}
1010 TemplateId : ffffffff-ffff-ffff-ffff-ffffffffffff"
1011 Configuration : <Configuration>
1012 <SchedulingConfig>
1013 <SchedulingConfig_Scheduling>Disabled</SchedulingConfig_Scheduling>
1014 </SchedulingConfig>
1015 </Configuration>
1016 Name : TestTest_1_0_0_1
1017 Type : Test
1018 Version : 1.0.0.1
1019 {{/code}}
1020
1021 == New-AESBMicroserviceTemplateConfig ==
1022
1023 Mit diesem Cmdlet wird eine neue Vorlagen-Konfiguration auf Basis des Pakets erstellt.
1024
1025 |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
1026 |-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration erstellt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
1027 |-PackageName|String|❌|Keine|Der Name des Pakets.
1028 |-PackageVersion|String|❌|Keine|Die Version des Pakets.
1029
1030 === Beispiele ===
1031
1032 Beispiel 1: MicroserviceTemplateConfig erstellen
1033
1034 {{code language="PowerShell" layout="LINENUMBERS"}}
1035 $packageVersion = "1.0.0.0"
1036 $packageName = "Test"
1037
1038 New-AESBMicroserviceTemplateConfig -PackageName $packageName -PackageVersion $packageVersion
1039 {{/code}}
1040
1041 Dieses Beispiel erstellt eine Vorlagen-Konfiguration auf Basis des angegebenen Microservice-Pakets.
1042
1043 === Rückgabewerte ===
1044
1045 * MicroserviceConfiguration
1046 ** Version
1047 *** Die neue Version der Vorlage
1048 ** Type
1049 *** Der Typ der Vorlage
1050 ** Configuration
1051 *** Die aktuelle Konfiguration der Vorlage
1052
1053 {{code language="PowerShell" layout="LINENUMBERS"}}
1054 $microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packageName -PackageVersion $packageVersion
1055
1056 MicroserviceConfiguration
1057 -------------------------
1058 MicroserviceConfiguration
1059
1060 $microserviceTemplateConfig.MicroserviceConfiguration
1061
1062 Version Type Configuration
1063 ------- ---- -------------
1064 1.0.0.0 Test Configuration
1065 {{/code}}
1066
1067 == Remove-AESBMicroserviceTemplate ==
1068
1069 Mit diesem Cmdlet können Sie Microservice-Vorlagen löschen.
1070
1071 |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
1072 |-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen gelöscht werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
1073 |-TemplateIds|String[]|❌|Keine|Die ID's der Vorlagen, die zu löschen sind.
1074 |-RemoveReferences|SwitchParameter|✅|Keine|Gibt an ob alle erstellten Referenzen der Vorlagen mitgelöscht werden sollen.
1075
1076 === Beispiele ===
1077
1078 Beispiel 1: Vorlage löschen
1079
1080 {{code language="PowerShell"}}
1081 Remove-AESBMicroserviceTemplate -TemplateIds 4b016fd1-47fb-4f24-87dd-4e365fe870d3
1082
1083 {{/code}}
1084
1085 Dieses Beispiel löscht eine Microservice-Vorlage auf Basis der angegebenen Id.
1086
1087 Beispiel 2: Vorlagen löschen
1088
1089 {{code language="PowerShell"}}
1090 Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3", "D1936807-E1B0-4F8B-AB7F-98ECD202CF8F"
1091 {{/code}}
1092
1093 Dieses Beispiel löscht mehrere Microservice-Vorlagen auf Basis der angegebenen Ids.
1094
1095 Beispiel 3: Vorlagen löschen mitsamt den Referenzen
1096
1097 {{code language="PowerShell"}}
1098 Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3" -RemoveReferences
1099
1100 {{/code}}
1101
1102 Dieses Beispiel löscht eine Microservice-Vorlage mitsamt den erstellten Referenzen der Vorlage .
1103
1104 === Rückgabewerte ===
1105
1106 * RemoveMicroserviceTemplateStatusData
1107 ** StatusResult
1108 *** Ergebnis des Resultats des Vorgangs
1109 ** TemplateId
1110 *** Die erfolgreich gelöschte Id der Vorlage
1111 ** Message
1112 *** Status Nachricht
1113
1114 {{code language="PowerShell"}}
1115 StatusResult TemplateId Message
1116 ------------ ---------- -------
1117 Success bde8016f-8557-4438-a165-ab05a4a78db4 The template was successfully removed.
1118 {{/code}}
1119
1120 == Update-AESBMicroserviceTemplate ==
1121
1122 Dieses Cmdlet aktualisiert die Microservice-Vorlage mittels der beigefügten Microservice-Vorlagen-Konfiguration.
1123
1124 |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
1125 |-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlage aktualisiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
1126 |-TemplateId|String|❌|Keine|Die ID der Vorlage, die aktualisiert werden soll.
1127 |-TemplateConfig|XmlDocument|❌|Keine|Die neue Microservices-Vorlagen-Konfiguration, die die aktuelle Konfiguration überschreiben soll. 
1128
1129 === Beispiele ===
1130
1131 Beispiel 1: Vorlage updaten
1132
1133 {{code language="PowerShell" layout="LINENUMBERS"}}
1134 $templateConfiguration = <MicroserviceConfiguration Version="1.0.0.0" Type="Test" SessionKey="72962557bb8bbd00b53dcb53d99cea685ed636bf">
1135 <Configuration>
1136 <SchedulingConfig>
1137 <SchedulingConfig_Scheduling>Enabled</SchedulingConfig_Scheduling>
1138 </SchedulingConfig>
1139 </Configuration>
1140 </MicroserviceConfiguration>
1141
1142
1143 Update-AESBMicroserviceTemplate -TemplateId "838fb7e2-e293-4004-9602-7223aaa3854a" -TemplateConfig $templateConfiguration
1144 {{/code}}
1145
1146 Dieses Beispiel updated die Vorlage mit der beigefügten Konfiguration.
1147
1148 === Rückgabewerte ===
1149
1150 * Templateinfo
1151 ** TemplateId
1152 ** Configuration
1153 ** Name
1154 ** Type
1155 ** Version
1156
1157 {{code language="PowerShell"}}
1158 TemplateId : 838fb7e2-e293-4004-9602-7223aaa3854a
1159 Configuration : <Configuration>
1160 <SchedulingConfig>
1161 <SchedulingConfig_Scheduling>Enabled</SchedulingConfig_Scheduling>
1162 </SchedulingConfig>
1163 </Configuration>
1164 Name : ASDASDASD
1165 Type : ASD
1166 Version : 1.0.0.0
1167 {{/code}}
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community