Wiki-Quellcode von Microservice Cmdlets

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