Wiki source code of Microservice Cmdlets

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