Wiki source code of Microservice Cmdlets

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