Wiki source code of Operative Cmdlets

Last modified by Jannis Klein on 2025/01/10 07:49
Show last authors
1 {{aagon.floatingbox/}}
2
3 (% class="wikigeneratedid" %)
4 Bei den operativen Cmdlets handelt es sich um Shell-Befehle, die für die Steuerung und das weiterführende Arbeiten in AESB verwendet werden können.
5
6 = Add-AESBAlias =
7
8 Mit diesem Cmdlet wird ein neuer Alias für eine SICS-Verbindung im Qualified Name Service (QNS) hinzugefügt. Wenn der Parameter //-ConnectionName// nicht angegeben wird, wird der Alias für die Standardverbindung hinzugefügt.
9
10 (% style="width:977px" %)
11 |=Parameter |=(% style="width: 101px;" %)Datentyp|=(% style="width: 94px;" %)Optional|=(% style="width: 87px;" %)Alias|=(% style="width: 505px;" %)Beschreibung
12 |-Alias|(% style="width:101px" %)String|(% style="width:94px" %)❌|(% style="width:87px" %)Keine|(% style="width:505px" %)Der Name des Alias, der dem Qualified Name Service (QNS) hinzugefügt werden soll.
13 |-ConnectionName|(% style="width:101px" %)String|(% style="width:94px" %)✅|(% style="width:87px" %)Keine|(% style="width:505px" %)Der Name der SICS-Verbindung, für die der Alias hinzugefügt wird. Wenn dieser Parameter nicht angegeben ist, wird der Alias für die Standardverbindung hinzugefügt.
14
15 === **Beispiele** ===
16
17 Beispiel 1: Hinzufügen des Alias "MyAlias" für die Standardverbindung
18
19 {{code language="powershell"}}
20 Add-AESBAlias -Alias "MyAlias"
21 {{/code}}
22
23 Beispiel 2: Hinzufügen des Alias "MyAlias" für die SICS-Verbindung "MyConnection"
24
25 {{code language="powershell"}}
26 Add-AESBAlias -Alias "MyAlias" -ConnectionName "MyConnection"
27
28 {{/code}}
29
30 = Add-AESBCallbackTarget =
31
32 Mtit diesem Cmdlet wird ein neues Callback-Target zur SICS-Verbindung hinzugefügt. Das Callback-Target wird für den Empfang von Nachrichten verwendet und erfordert eine Routing-Key-Konfiguration sowie einen Virtual Router.
33
34 (% style="width:1073px" %)
35 |=(% style="width: 166px;" %)Parameter |=(% style="width: 127px;" %)Datentyp|=(% style="width: 90px;" %)Optional|=(% style="width: 74px;" %)Alias|=(% style="width: 614px;" %)Beschreibung
36 |(% style="width:166px" %)-ConnectionName|(% style="width:127px" %)String|(% style="width:90px" %)✅|(% style="width:74px" %)Keine|(% style="width:614px" %)Der Name der SICS-Verbindung, zu der das Callback-Target hinzugefügt wird. Wenn dieser Parameter nicht angegeben ist, wird das Callback-Target zur Standardverbindung hinzugefügt.
37 |(% style="width:166px" %)-VirtualRouter|(% style="width:127px" %)String|(% style="width:90px" %)❌|(% style="width:74px" %)Keine|(% style="width:614px" %)Der Name des Virtual Routers, dem das Callback-Target zugeordnet werden soll.
38 |(% style="width:166px" %)-TargetName|(% style="width:127px" %)String|(% style="width:90px" %)❌|(% style="width:74px" %)Keine|(% style="width:614px" %)Der Name des Callback-Targets, das hinzugefügt werden soll.
39 |(% style="width:166px" %)-RoutingKey|(% style="width:127px" %)String|(% style="width:90px" %)❌|(% style="width:74px" %)Keine|(% style="width:614px" %)Der Routing-Key, der verwendet wird, um Nachrichten an das Callback-Target zu routen.
40
41 === (% id="cke_bm_70797S" style="display:none" %)** **(%%)**Beispiele** ===
42
43 Beispiel 1: Hinzufügen eines Callback-Targets "CallbackTarget1" zur Standardverbindung. Dabei wird das Callback-Target über den Routing-Key "Key1" zum Virtual Router "Router1" zugeordnet
44
45 {{code language="powershell"}}
46 Add-AESBCallbackTarget -VirtualRouter "Router1" -TargetName "CallbackTarget1" -RoutingKey "Key1"
47
48 {{/code}}
49
50 Beispiel 2: Hinzufügen eines Callback-Targets "CallbackTarget1" zur SICS-Verbindung "MyConnection". Dabei wird das Callback-Target über den Routing-Key "Key1" zum Virtual Router "Router1" zugeordnet
51
52 {{code language="powershell"}}
53 Add-AESBCallbackTarget -ConnectionName "MyConnection" -VirtualRouter "Router1" -TargetName "CallbackTarget1" -RoutingKey "Key1"
54
55 {{/code}}
56
57 = Add-AESBQueueTarget =
58
59 Dieses Cmdlet fügt ein neues Target zu einer SICS-Verbindung hinzu. Innerhalb dieses Targets ist eine Queue enthalten, in der Nachrichten weiterverarbeitet werden, die an das Target gesendet werden. Daher handelt es sich bei diesem Cmdlet um eine spezifische Form eines [[AESB-Targets.>>doc:||anchor="HAdd-AESBTarget"]]
60
61 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
62 |(% style="width:199px" %)-ConnectionName|(% style="width:160px" %)String|(% style="width:119px" %)✅|(% style="width:168px" %)Keine|(% style="width:827px" %)Der Name der SICS-Verbindung, zu der das Queue-Target hinzugefügt wird. Wenn dieser Parameter nicht angegeben ist, wird das Queue-Target zur Standardverbindung hinzugefügt.
63 |(% style="width:199px" %)-VirtualRouter|(% style="width:160px" %)String|(% style="width:119px" %)❌|(% style="width:168px" %)Keine|(% style="width:827px" %)Der Name des Virtual Routers, dem das Queue-Target zugeordnet wird.
64 |(% style="width:199px" %)-TargetName|(% style="width:160px" %)String|(% style="width:119px" %)❌|(% style="width:168px" %)Keine|(% style="width:827px" %)Der Name des Queue-Targets, das hinzugefügt werden soll.
65 |(% style="width:199px" %)-RoutingKey|(% style="width:160px" %)String|(% style="width:119px" %)❌|(% style="width:168px" %)Keine|(% style="width:827px" %)Der Routing-Key, der verwendet wird, um Nachrichten an das Queue-Targets zu senden.
66
67 === **Beispiele** ===
68
69 Beispiel 1: Hinzufügen eines Queue-Targets "QueueTarget1" zur Standardverbindung. Dabei wird das Queue-Target über den Routing-Key "Key1" zum Virtual Router "Router1" zugeordnet
70
71 {{code language="powershell"}}
72 Add-AESBQueueTarget -VirtualRouter "Router1" -TargetName "QueueTarget1" -RoutingKey "Key1"
73
74 {{/code}}
75
76 Beispiel 2: Hinzufügen eines Queue-Targets "QueueTarget1" zur SICS-Verbindung "MyConnection". Dabei wird das Queue-Target über den Routing-Key "Key1" zum Virtual Router "Router1" zugeordnet
77
78 {{code language="powershell"}}
79 Add-AESBQueueTarget -ConnectionName "MyConnection" -VirtualRouter "Router1" -TargetName "QueueTarget1" -RoutingKey "Key1"
80
81 {{/code}}
82
83 = Add-AESBRoutingKey =
84
85 Dieses Cmdlet wird verwendet, um Routing-Informationen für ein [[AESB-Target>>doc:||anchor="HAdd-AESBTarget"]] zu konfigurieren. Dabei wird ein RoutingKey zu einem Target in einem VirtualRouter hinzugefügt.
86
87 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
88 |-ConnectionName|string|✅|C|Der Name der SICS-Verbindung, für die der Routing Key hinzugefügt werden soll.
89 |-VirtualRouter|string|❌|VR|Der Name des Virtual Router, zu dem der Routing Key gehört.
90 |-TargetName|string|❌|TName|Der Name des Targets, für das der Routing Key hinzugefügt wird.
91 |-RoutingKey|string|❌|RK|Der Name des Routing Keys, der hinzugefügt werden soll.
92
93 === **Beispiele** ===
94
95 Beispiel 1: Hinzufügen des Routing Keys "Key1"  für die Standardverbindung. Dabei wird angegeben, dass der Routing Key für das Target "MyTarget". hinzugefügt wird und zum Virtual Router "Router1" gehört
96
97 {{code language="powershell"}}
98 Add-AESBQueueTarget -VirtualRouter "Router1" -TargetName "QueueTarget1" -RoutingKey "Key1"
99
100 {{/code}}
101
102 Beispiel 2: Hinzufügen des Routing Keys "AnotherKey"  für die SICS-Verbindung "MyConnection". Dabei wird angegeben, dass der Routing Key für das Target "AnotherTarget". hinzugefügt wird und zum Virtual Router "AnotherRouter" gehört
103
104 {{code language="powershell"}}
105 Add-AESBRoutingKey -ConnectionName "MyConnection" -VirtualRouter "AnotherRouter" -TargetName "AnotherTarget" -RoutingKey "AnotherKey"
106
107 {{/code}}
108
109 = Add-AESBRoutingToAlias =
110
111 Dieses Cmdlet wird verwendet, um Routing-Informationen für den AESB zu konfigurieren, indem ein Routing-Paar mit einem Alias verknüpft wird. Das Routing-Paar besteht aus einem Virtual Router und einem Routing Key, die zu einem Alias im QNS hinzugefügt werden.
112
113 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
114 |-Alias|string|❌|A|Der Alias, zu dem das Routing-Paar im QNS hinzugefügt werden soll.
115 |-ConnectionName|string|✅|C|Der Name der SICS-Verbindung, für die das Routing-Paar hinzugefügt werden soll.
116 |-RoutingKey|string|❌|RK|Der Name des Routing Keys, der zusammen mit dem Virtual Router hinzugefügt werden soll.
117 |-VirtualRouter|string|❌|VR|Der Name des Virtual Router, der zusammen mit dem Routing Key hinzugefügt werden soll.
118
119 === (% id="cke_bm_22527S" style="display:none" %)** **(%%)**Beispiele** ===
120
121 Beispiel 1: Hinzufügen des Routing-Paars zum Alias "MyAlias" für die Standardverbindung. Dabei werden der Routing Key "MyKey" und der Virtual Router "MyRouter" als Routing-Paar verknüpft.
122
123 {{code language="powershell"}}
124 Add-AESBRoutingToAlias -Alias "MyAlias" -VirtualRouter "MyRouter" -RoutingKey "MyKey" -ConnectionName "MyConnection"
125 {{/code}}
126
127 Beispiel 2: Hinzufügen des Routing-Paars zum Alias "AnotherAlias" für die SICS-Verbindung "MyConnection". Dabei werden der Routing Key "AnotherKey" und der Virtual Router "AnotherRouter" als Routing-Paar verknüpft.
128
129 {{code language="powershell"}}
130 Add-AESBRoutingToAlias -Alias "AnotherAlias" -VirtualRouter "AnotherRouter" -RoutingKey "AnotherKey" -ConnectionName "MyConnection"
131 {{/code}}
132
133 = Add-AESBTarget =
134
135 Dieses Cmdlet wird verwendet, um ein neues Target für eine SICS-Verbindung in einem Virtual Router hinzuzufügen. Dabei wird ein Target Type und Target Name mit einem Routing Key verknüpft.
136
137 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
138 |-ConnectionName|string|✅|C|Der Name der SICS-Verbindung, für die das Target hinzugefügt werden soll.
139 |-RoutingKey|string|❌|RK|Der Routing Key, der dem Target zugewiesen wird.
140 |-TargetName|string|❌|TName|Der Name des Targets, das hinzugefügt werden soll.
141 |-TargetType|string|❌|TType|Der Typ des Targets, das hinzugefügt werden soll.
142 |-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, zu dem das Target hinzugefügt wird.
143
144 === **Beispiele** ===
145
146 Beispiel 1: Hinzufügen eines Queue-Targets "MyTarget" für die Standardverbindung. Das Target wird dem Virtual Router "MyRouter" hinzugefügt und ihm wird der Routing Key "MyKey" zugewiesen
147
148 {{code language="powershell"}}
149 Add-AESBTarget -VirtualRouter "MyRouter" -TargetType "Queue" -TargetName "MyTarget" -RoutingKey "MyKey"
150
151 {{/code}}
152
153 Beispiel 2: Hinzufügen eines Queue-Targets "MyTarget" für die SICS-Verbindung "MyConnection". Das Target wird dem Virtual Router "MyRouter" hinzugefügt und ihm wird der Routing Key "MyKey" zugewiesen
154
155 {{code language="powershell"}}
156 Add-AESBTarget -VirtualRouter "AnotherRouter" -TargetType "Queue" -TargetName "AnotherTarget" -RoutingKey "AnotherKey" -ConnectionName "MyConnection"
157
158 {{/code}}
159
160 = Add-AESBVirtualRouter =
161
162 Dieses Cmdlet wird verwendet, um einen neuen Virtual Router innerhalb der angegebenen SICS-Verbindung zu konfigurieren.
163
164 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
165 |-ConnectionName|string|✅|C|Der Name der Verbindung, in der der VirtualRouter hinzugefügt werden soll.
166 |-VirtualRouter|string|❌|VR|Der Name des VirtualRouter, der hinzugefügt werden soll.
167
168 === **Beispiele** ===
169
170 Beispiel 1: Hinzufügen eines Virtual Routers "MyRouter" in der Standardverbindung
171
172 {{code language="powershell"}}
173 Add-AESBVirtualRouter -VirtualRouter "MyRouter"
174
175 {{/code}}
176
177 Beispiel 2: Hinzufügen eines Virtual Routers "AnotherRouter" in der SICS-Verbindung "MyConnection"
178
179 {{code language="powershell"}}
180 Add-AESBVirtualRouter -VirtualRouter "AnotherRouter" -ConnectionName "MyConnection"
181
182 {{/code}}
183
184 = ConvertFrom-AESBBase64 =
185
186 Dieses Cmdlet wird verwendet, um eine Base64-kodierte Zeichenfolge zurück in ihre unkodierte Form zu dekodieren.
187
188 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
189 |-Input|string|❌|In|Die Base64-kodierte Zeichenfolge, die dekodiert werden soll.
190
191 === **Beispiele** ===
192
193 Beispiel 1: Dekodieren einer Base64-kodierten Zeichenfolge. Zurückgegeben wird der ursprüngliche Text "Hello World!"
194
195 {{code language="powershell"}}
196 ConvertFrom-AESBBase64 -Input "SGVsbG8gV29ybGQh"
197
198 {{/code}}
199
200 Beispiel 2: Dekodieren einer Base64-Zeichenfolge aus der Variable $base64string. Zurückgegeben wird der ursprüngliche Text "Some base64 text"
201
202 {{code language="powershell"}}
203 $base64String = "U29tZSBiYXNlNjQgdGV4dA=="
204 ConvertFrom-AESBBase64 -Input $base64String
205 {{/code}}
206
207 = ConvertFrom-AESBBase64ToFile =
208
209 Dieses Cmdlet wird verwendet, um eine Base64-kodierte Zeichenfolge zu dekodieren und in einer Datei zu speichern.
210
211 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
212 |-Input|string|❌|In|Die Base64-kodierte Zeichenfolge, die dekodiert werden soll.
213 |-OutputPath|string|❌|None|Der Pfad inklusive Dateinamen, unter dem die dekodierten Daten gespeichert werden sollen.
214 |-Force|switch|✅|F|Überschreibt die Datei am OutputPath, falls bereits eine Datei mit diesem Namen existiert.
215
216 === **Beispiele** ===
217
218 Beispiel 1: Dekodieren einer Base64-Zeichenfolge und Speichern vom ursprünglichen Text "Hello World!" in der Datei "output.txt" im angegebenen Pfad
219
220 {{code language="powershell"}}
221 ConvertFrom-AESBBase64ToFile -Input "SGVsbG8gV29ybGQh" -OutputPath "C:\path\to\output.txt"
222
223 {{/code}}
224
225 Beispiel 2: Dekodieren einer Base64-Zeichenfolge und Speichern vom ursprünglichen Text "Some base64 text" in der Datei "output.txt" im angegebenen Pfad. Da die Datei bereits vorhanden ist, wird sie überschrieben
226
227 {{code language="powershell"}}
228 ConvertFrom-AESBBase64ToFile -Input "U29tZSBiYXNlNjQgdGV4dA==" -OutputPath "C:\path\to\output.txt" -Force
229 {{/code}}
230
231 = ConvertFrom-AESBIcql =
232
233 Dieses Cmdlet wird verwendet, um eine AESB Icql-Zeichenfolge zurück in ein PowerShell-Objekt zu dekodieren.
234
235 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
236 |-Icql|string|❌|None|Die AESB Icql-Zeichenfolge, die dekodiert werden soll.
237
238 === **Beispiele** ===
239
240 Beispiel 1: Dekodieren einer AESB Icql-Zeichenfolge aus der Variable $icqlString
241
242 {{code language="powershell"}}
243 $icqlString = "<ICQL><POWERSHELL><MESSAGE><TargetName>MyTarget</TargetName><TargetType>Queue</TargetType><RoutingKey>MyRoutingKey</RoutingKey><VirtualRouter>MyRouter</VirtualRouter><ConnectionName>MyConnection</ConnectionName></MESSAGE></POWERSHELL></ICQL>"
244 ConvertFrom-AESBIcql -Icql $icqlString
245 {{/code}}
246
247 Dabei wird das PSCustomObject mit folgenden Daten zurückgegeben:
248
249 {{code language="none" layout="LINENUMBERS"}}
250 TargetName : MyTarget
251 TargetType : Queue
252 RoutingKey : MyRoutingKey
253 VirtualRouter : MyRouter
254 ConnectionName : MyConnection
255 {{/code}}
256
257 Beispiel 2: Kodieren eines PSCustomObjects in eine Icql-Zeichenfolge und anschließendes Dekodieren zurück in ein PSCustomObject. Die resultierenden Daten entsprechen den ursprünglichen Eingabewerten
258
259 {{code language="powershell" layout="LINENUMBERS"}}
260 # Erstellen eines PSCustomObject mit Beispieldaten
261 $exampleObject = [PSCustomObject]@{
262 TargetName = "MyTarget"
263 TargetType = "Queue"
264 RoutingKey = "MyRoutingKey"
265 VirtualRouter = "MyRouter"
266 ConnectionName = "MyConnection"
267 }
268
269 # Konvertieren des Objekts in eine Icql-Zeichenfolge
270 $x = ConvertTo-AESBIcql -InputObject $exampleObject
271
272 # Zurückkonvertieren der Icql-Zeichenfolge in ein PSCustomObject
273 $decodedObject = ConvertFrom-AESBIcql -Icql $x
274
275 # Anzeigen des dekodierten Objekts
276 $decodedObjectConvertFrom-AESBIcql -Icql $icqlString
277 {{/code}}
278
279 = ConvertTo-AESBBase64 =
280
281 Dieses Cmdlet wird verwendet, um eine Zeichenfolge in das Base64-Format zu konvertieren.
282
283 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
284 |-Input|string|❌|In|Die Zeichenfolge, die in Base64 kodiert werden soll.
285
286 === **Beispiele** ===
287
288 Beispiel 1: Kodieren der Zeichenfolge// //"Hello World!"// //in Base64. Zurückgegeben wird die Base64-kodierte Version
289
290 {{code language="powershell"}}
291 ConvertTo-AESBBase64 -Input "Hello World!"
292 ConvertFrom-AESBIcql -Icql $icqlString
293 {{/code}}
294
295 Beispiel 2: Kodieren der Zeichenfolge aus der Variable $string in Base64. Zurückgegeben wird die Base64-kodierte Zeichenfolge in der Variable $base64String
296
297 {{code language="powershell"}}
298 $string = "Base64 encoding example"
299 $base64String = ConvertTo-AESBBase64 -Input $string
300 $base64StringConvertFrom-AESBIcql -Icql $icqlString
301 {{/code}}
302
303 = ConvertTo-AESBBase64FromFile =
304
305 Dieses Cmdlet wird verwendet, um den Inhalt einer Datei in eine Base64-kodierte Zeichenfolge zu konvertieren.
306
307 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
308 |-InputPath|string|❌|InPath|Der Pfad zur Datei, deren Inhalt in Base64 kodiert werden soll.
309
310 === **Beispiele** ===
311
312 Beispiel 1: Kodieren des Inhalts der Datei "file.txt" unter dem angegebenen Pfad in Base64. Zurückgegeben wird die Base64-kodierte Zeichenfolge
313
314 {{code language="powershell"}}
315 ConvertTo-AESBBase64FromFile -InputPath "C:\path\to\file.txt"
316
317 {{/code}}
318
319 Beispiel 2: Kodieren des Inhalts der Datei, deren Pfad in der Variable $filePath gespeichert ist, in Base64. Zurückgegeben wird die Base64-kodierte Zeichenfolge in der Variable $base64String
320
321 {{code language="powershell"}}
322 $filePath = "C:\path\to\anotherfile.txt"
323 $base64String = ConvertTo-AESBBase64FromFile -InputPath $filePath
324 $base64String
325 {{/code}}
326
327 = ConvertTo-AESBIcql =
328
329 Dieses Cmdlet wird verwendet, um ein PowerShell-Objekt in das Icql-Format zu kodieren, das vom AESB verwendet wird.
330
331 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
332 |-InputObject|psobject|❌|InObj|Das PSCustomObject, das in eine AESB Icql-Zeichenfolge konvertiert werden soll.
333 |-Sequence|string|✅| |Setzt die Sequence einer ICQL Message
334 |-Action|string|✅| |Setzt die Action einer ICQL Message
335
336 === **Beispiele** ===
337
338 Beispiel 1: Konvertiert das PSCustomObject in eine AESB Icql-Zeichenfolge und gibt die resultierende Icql-Zeichenfolge zurück.
339
340 {{code language="powershell" layout="LINENUMBERS"}}
341 # Erstellen eines PSCustomObject mit Beispieldaten
342 $exampleObject = [PSCustomObject]@{
343 TargetName = "MyTarget"
344 TargetType = "Queue"
345 RoutingKey = "MyRoutingKey"
346 VirtualRouter = "MyRouter"
347 ConnectionName = "MyConnection"
348 }
349
350 # Konvertieren des Objekts in eine Icql-Zeichenfolge
351 $icqlString = ConvertTo-AESBIcql -InputObject $exampleObject
352 $icqlString
353 {{/code}}
354
355 = Get-AESBActivityLogItemById =
356
357 Gibt den Activity Log-Eintrag anhand einer ID zurück.
358
359 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
360 |-Id|string|❌| |Die ID des Logeintrags
361
362 === **Beispiele** ===
363
364 Beispiel 1: Abruf eines Log-Eintrags anhand einer ID
365
366 {{code language="powershell"}}
367 Get-AESBActivityLogItemById -Id "ItemID"
368
369 {{/code}}
370
371 = Get-AESBAliasList =
372
373 Dieses Cmdlet wird verwendet, um eine Übersicht der im AESB gespeicherten Aliase zu erhalten.
374
375 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
376 |-ConnectionName|string|✅|C|Der Name der Verbindung, für die die Alias-Liste abgerufen werden soll.
377
378 === **Beispiele** ===
379
380 Beispiel 1: Abrufen einer Liste aller Aliase im AESB, ohne Angabe einer speziellen Verbindung
381
382 {{code language="powershell"}}
383 Get-AESBAliasList
384
385 {{/code}}
386
387 Beispiel 2: Abrufen einer Liste aller Aliase im AESB für die angegebene Verbindung "MyConnection"
388
389 {{code language="powershell"}}
390 Get-AESBAliasList -ConnectionName "MyConnection"
391
392 {{/code}}
393
394 = Get-AESBVirtualRouters =
395
396 Gibt eine Liste aller Virtual Router zurück.
397
398 === **Beispiele** ===
399
400 Beispiel 1: Abrufen einer Liste aller Virtual Router
401
402 {{code language="powershell"}}
403 Get-AESBVirtualRouters
404
405 {{/code}}
406
407 = Get-AESBAlias =
408
409 Gibt alle Informationen zu einer Verbindung mit einem bestimmten Alias wieder.
410
411 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
412 |-Alias|string|❌| |Gibt die Informationen zum angegebenen Alias wieder.
413
414 === **Beispiele** ===
415
416 Beispiel 1: Abrufen der Informationen zur Verbindung mit dem Alias "AliasName"
417
418 {{code language="powershell"}}
419 Get-AESBAlias -Alias "AliasName"
420
421 {{/code}}
422
423 = Get-AESBConnectionInfo =
424
425 Dieses Cmdlet wird verwendet, um Details über die Konfiguration und den Status einer Verbindung zu erhalten.
426
427 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
428 |-ConnectionName|string|✅|C|Der Name der Verbindung, für die Informationen abgerufen werden sollen.
429
430 === **Beispiele** ===
431
432 Beispiel 1: Abrufen von Informationen zu allen verfügbaren Verbindungen im AESB
433
434 {{code language="powershell" layout="LINENUMBERS"}}
435 Get-AESBConnectionInfo
436
437 #Beispiel-Output:
438
439 EndPoint VirtualRouter RoutingKey
440 -------- ------------- ----------
441 wss://localhost:3950 SHELL SICS.Aagon.Shell.local.a9857af7-bf81-44cd-8047-628956aad668
442 {{/code}}
443
444 Beispiel 2: Abrufen der Informationen zur Verbindung "MyConnection"
445
446 {{code language="powershell"}}
447 Get-AESBAliasList -ConnectionName "MyConnection"
448
449 {{/code}}
450
451 = Get-AESBTargetMessageCount =
452
453 Dieses Cmdlet wird verwendet, um die Anzahl der Nachrichten zu ermitteln, die sich derzeit im angegebenen Target befinden.
454
455 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
456 |-ConnectionName|string|✅|C|Der Name der Verbindung, für die die Zielnachrichtenzahl abgerufen werden soll.
457 |-TargetName|string|❌|TName|Der Name des Targets, für das die Nachrichtenzahl abgerufen werden soll.
458 |-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, unter dem das Target läuft.
459
460 === **Beispiele** ===
461
462 Beispiel 1: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem Virtual Router "MyRouter"
463
464 {{code language="powershell"}}
465 Get-AESBTargetMessageCount -VirtualRouter "MyRouter" -TargetName "MyTarget"
466 {{/code}}
467
468 Beispiel 2: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem Virtual Router "MyRouter" und der Verbindung "MyConnection"
469
470 {{code language="powershell"}}
471 Get-AESBTargetMessageCount -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"
472
473 {{/code}}
474
475 = Get-AESBTargets =
476
477 Dieses Cmdlet wird verwendet, um eine Übersicht der im AESB definierten Targets zu erhalten.
478
479 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
480 |-ConnectionName|string|✅|C|Der Name der Verbindung, für die die Liste der Targets abgerufen werden soll.
481 |-VirtualRouter|string|❌|VR|Der Name des VirtualRouters, für den die Liste der Targets abgerufen werden soll.
482
483 === **Beispiele** ===
484
485 Beispiel 1: Abrufen der Liste aller Targets unter dem Virtual Router "MyRouter"
486
487 {{code language="powershell"}}
488 Get-AESBTargets -VirtualRouter "MyRouter"
489
490 {{/code}}
491
492 Beispiel 2: Abrufen der Liste aller Targets für den Virtual Router "MyRouter" und die Verbindung "MyConnection"
493
494 {{code language="powershell"}}
495 Get-AESBTargets -ConnectionName "MyConnection" -VirtualRouter "MyRouter"
496
497 {{/code}}
498
499 = Publish-AESBMessage =
500
501 Dieses Cmdlet wird verwendet, um Nachrichten an die angegebenen Ziele oder Aliase zu senden.
502
503 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
504 |-Alias|string|❌|A|Der Name des Alias, an den die Nachricht veröffentlicht werden soll.
505 |-ConnectionName|string|✅|C|Der Name der Verbindung, über die die Nachricht gesendet werden soll.
506 |-Force|switch|✅|F|Zwingt die Veröffentlichung der Nachricht, auch wenn dies normalerweise nicht zulässig wäre.
507 |-Message|Object|❌|M|Die Nachricht, die veröffentlicht werden soll.
508 |-RoutingKey|string|❌|RK|Der RoutingKey, der für das Routing der Nachricht verwendet wird.
509 |-VirtualRouter|string|❌|VR|Der Name des VirtualRouters, über den die Nachricht veröffentlicht werden soll.
510
511 === Parameter-Sets ===
512
513 Für die Parameter dieses Cmdlets wurden eigene Parameter-Sets definiert, die Sie verwenden können:
514
515 * (((
516 RoutingParameterSet - Message, VirtualRouter, RoutingKey
517 )))
518 * (((
519 AliasParameterSet - Message, Alias
520 )))
521
522 === **Beispiele** ===
523
524 Beispiel 1: Senden der Nachricht "This is a test message" an den Alias "MyAlias"
525
526 {{code language="powershell"}}
527 Publish-AESBMessage -Alias "MyAlias" -Message "This is a test message"
528
529 {{/code}}
530
531 Beispiel 2: Senden der Nachricht "This is a test message" über den Virtual Router "MyRouter" mit dem Routing Key "MyRoutingKey"
532
533 {{code language="powershell"}}
534 Publish-AESBMessage -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey" -Message "This is a test message"
535
536 {{/code}}
537
538 Beispiel 3: Konvertieren eines PSCustomObject in das ICQL-Format und senden der Nachricht an den Alias "MyAlias"
539
540 {{code language="powershell"}}
541 ConvertTo-AESBIcql $exampleObject | Publish-AESBMessage -Alias "MyAlias"
542
543 {{/code}}
544
545 = Publish-AESBMessageAndAwait =
546
547 Mit diesem Cmdlet können Sie eine Nachricht an ein bestimmtes Target oder einen Alias im AESB senden. Anschließend wird auf eine Bestätigung oder Antwort innerhalb des angegebenen Zeitlimits gewartet.
548
549 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
550 |-Alias|string|❌|A|Der Name des Alias, an den die Nachricht veröffentlicht werden soll.
551 |-ConnectionName|string|✅|C|Der Name der Verbindung, über die die Nachricht gesendet werden soll.
552 |-Force|switch|✅|F|Zwingt die Veröffentlichung der Nachricht, auch wenn dies normalerweise nicht zulässig wäre.
553 |-Message|Object|❌|M|Die Nachricht, die veröffentlicht werden soll.
554 |-RoutingKey|string|❌|RK|Der Routing Key, der für das Routing der Nachricht verwendet wird.
555 |-Timeout|string|✅|T|Die maximale Zeitdauer, die auf eine Bestätigung gewartet wird. Der Wert kann in Sekunden, Minuten oder Stunden angegeben werden, z.B. "5s", "5 sec", "5 seconds", "5m", "5 min", "5 minutes", "2h", "2 hours". Standardmäßig wird der Wert in Sekunden interpretiert.
556 |-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, über den die Nachricht veröffentlicht werden soll.
557
558 === **Beispiele** ===
559
560 Beispiel 1: Senden der Nachricht "This is a test message" an den Alias "MyAlias" und wartet bis zu 5 Minuten auf eine Bestätigung
561
562 {{code language="powershell"}}
563 Publish-AESBMessageAndAwait -Alias "MyAlias" -Message "This is a test message" -Timeout "5m"
564
565 {{/code}}
566
567 Beispiel 2: Senden der Nachricht "This is a test message" über den Virtual Router "MyRouter" mit dem Routing Key "MyRoutingKey" und wartet bis zu 1 Stunde auf eine Bestätigung.
568
569 {{code language="powershell"}}
570 Publish-AESBMessageAndAwait -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey" -Message "This is a test message" -Timeout "1h"
571
572 {{/code}}
573
574 = Receive-AESBTargetMessages =
575
576 Mit diesem Cmdlet können Sie Nachrichten von einem Ziel im AESB empfangen.
577
578 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
579 |-ConnectionName|//string//|✅|C|Der Name der Verbindung zum AESB.
580 |-MessageCount|//int//|✅|MC|Die Anzahl der Nachrichten, die empfangen werden sollen.
581 |-TargetName|//string//|❌|TName|Der Name des Ziels, von dem die Nachrichten empfangen werden.
582 |-VirtualRouter|//string//|❌|VR|Der Name des Virtual Routers, der für das Ziel verwendet wird.
583
584 === **Beispiele** ===
585
586 Beispiel 1: Empfangen von Nachrichten vom Ziel mit dem Namen "MyTarget", das dem Virtual Router "MyRouter" zugeordnet ist
587
588 {{code language="powershell"}}
589 Receive-AESBTargetMessages -VirtualRouter "MyRouter" -TargetName "MyTarget"
590
591 {{/code}}
592
593 Beispiel 2: Empfangen von bis zu 10 Nachrichten vom Ziel mit dem Namen "MyTarget", das dem Virtual Router "MyRouter" zugeordnet ist
594
595 {{code language="powershell"}}
596 Receive-AESBTargetMessages -VirtualRouter "MyRouter" -TargetName "MyTarget" -MessageCount 10
597
598 {{/code}}
599
600 = Remove-AESBAlias =
601
602 Mit diesem Cmdlet können Sie einen Alias aus dem AESB entfernen.
603
604 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
605 |-Alias|string|❌|A|Der Name des zu entfernenden Alias.
606 |-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
607
608 === **Beispiele** ===
609
610 Beispiel 1: Entfernen vom Alias "MyAlias" aus dem AESB
611
612 {{code language="powershell"}}
613 Remove-AESBAlias -Alias "MyAlias"
614
615 {{/code}}
616
617 Beispiel 2: Entfernen vom Alias "MyAlias" aus dem AESB über die angegebene Verbindung
618
619 {{code language="powershell"}}
620 Remove-AESBAlias -ConnectionName "MyConnection" -Alias "MyAlias"
621
622 {{/code}}
623
624 = Remove-AESBRoutingFromAlias =
625
626 Mit diesem Cmdlet können Sie ein Routing-Paar (bestehend aus Virtual Router und Routing Key) von einem Alias im QNS entfernen. Das Routing-Paar wird vollständig gelöscht.
627
628 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
629 |-Alias|string|❌|A|Der Name des Alias, von dem das Routing-Paar entfernt werden soll.
630 |-ConnectionName|string|✅|C|Der Name der Verbindung, die verwendet wird.
631 |-RoutingKey|string|❌|RK|Der Routing Key, der aus dem Alias entfernt werden soll.
632 |-VirtualRouter|string|❌|VR|Der Virtual Router, der zusammen mit dem Routing Key entfernt werden soll.
633
634 === **Beispiele** ===
635
636 Beispiel 1: Entfernen vom Routing-Paar mit Virtual Router "MyRouter" und Routing Key "MyRoutingKey" vom Alias "MyAlias"
637
638 {{code language="powershell"}}
639 Remove-AESBRoutingFromAlias -Alias "MyAlias" -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey"
640
641 {{/code}}
642
643 Beispiel 2: Entfernen vom Routing-Paar mit Virtual Router "MyRouter" und Routing Key "MyRoutingKey" vom Alias "MyAlias" unter Verwendung der Verbindung "MyConnection"
644
645 {{code language="powershell"}}
646 Remove-AESBRoutingFromAlias -Alias "MyAlias" -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey"
647
648 {{/code}}
649
650 = Remove-AESBRoutingKey =
651
652 Mit diesem Cmdlet können Sie einen Routing Key von einem bestimmten Ziel in einem Virtual Router im AESB entfernen. Der Routing Key wird aus der Konfiguration entfernt, die mit dem angegebenen Ziel und Virtual Router verknüpft ist.
653
654 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
655 |-ConnectionName|string|✅|C|Der Name der Verbindung, die verwendet werden soll.
656 |-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, von dem der Routing Key entfernt werden soll.
657 |-TargetName|string|❌|TName|Der Name des Ziels, von dem der Routing Key entfernt werden soll.
658 |-RoutingKey|string|❌|RK|Der Routing Key, der entfernt werden soll.
659
660 === **Beispiele** ===
661
662 Beispiel 1: Entfernen vom Routing Key "MyRoutingKey" vom Ziel "MyTarget" im Virtual Router "MyRouter"
663
664 {{code language="powershell"}}
665 Remove-AESBRoutingKey -VirtualRouter "MyRouter" -TargetName "MyTarget" -RoutingKey "MyRoutingKey"
666
667 {{/code}}
668
669 Beispiel 2: Entfernen vom Routing Key "MyRoutingKey" vom Ziel "MyTarget" im Virtual Router "MyRouter" unter Verwendung der Verbindung "MyConnection"
670
671 {{code language="powershell"}}
672 Remove-AESBRoutingKey -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget" -RoutingKey "MyRoutingKey"
673
674 {{/code}}
675
676 = Remove-AESBTarget =
677
678 Mit diesem Cmdlet können Sie ein Ziel aus dem Virtual Router des AESB entfernen.
679
680 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
681 |-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
682 |-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, von dem das Ziel entfernt werden soll.
683 |-TargetName|string|❌|TName|Der Name des Ziels, das entfernt werden soll.
684
685 === **Beispiele** ===
686
687 Beispiel 1: Entfernen vom Ziel "MyTarget" vom Virtual Router "MyRouter"
688
689 {{code language="powershell"}}
690 Remove-AESBTarget -VirtualRouter "MyRouter" -TargetName "MyTarget"
691 {{/code}}
692
693 Beispiel 2: Entfernen vom Ziel "MyTarget" vom Virtual Router "MyRouter" unter Verwendung der Verbindung "MyConnection"
694
695 {{code language="powershell"}}
696 Remove-AESBTarget -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"
697 {{/code}}
698
699 = Remove-AESBVirtualRouter =
700
701 Mit diesem Cmdlet können Sie einen angegebenen Virtual Router entfernen.
702
703 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
704 |ConnectionName|string|✅|C|Gibt den Namen der Verbindung an.
705 |VirtualRouter|string|❌|VR|Gibt den Namen des zu entfernenden Virtual Router an.
706
707 === **Beispiele** ===
708
709 Beispiel 1: Entfernen vom Virtual Router mit dem Namen "MyRouter"
710
711 {{code language="powershell"}}
712 Remove-AESBVirtualRouter -VirtualRouter "MyRouter"
713
714 {{/code}}
715
716 Beispiel 2: Entfernen vom Virtual Router mit dem Namen "MyRouter" unter der Verbindung "MyConnection"
717
718 {{code language="powershell"}}
719 Remove-AESBVirtualRouter -ConnectionName "MyConnection" -VirtualRouter "MyRouter"
720 {{/code}}
721
722 = Set-AESBBSelfAsAlias =
723
724 Bei diesem Cmdlet wird ein existierender Alias verwendet, um einen neuen Alias hinzuzufügen. Durch Verwendung des bereits existierenden Alias, müssen so nicht der Routing Key und Virtual Router verwendet werden.
725
726 {{aagon.warnungsbox}}
727 Die Parameter RemoveExistingAlias und AddToExistingAlias dürfen nicht gleichzeitig verwendet werden!
728 {{/aagon.warnungsbox}}
729
730 **Parameter**
731
732 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
733 |-Alias|string|❌| |Gibt den Namen vom Alias an
734 |-RemoveExistingAlias|bool|✅| |Der bestehende Alias wird ersetzt.
735 |-AddToExistingAlias|bool|✅| |Der Virtual Router und Routing Key wird zu dem angegebenen Alias hinzugefügt
736
737 === **Beispiele** ===
738
739 Beispiel 1: Überschreiben vom existierenden Alias „AliasName“. Wenn z.B. der vorherige Alias mehrere Virtual Router und Routing Keys hatte, werden diese gelöscht
740
741 {{code language="powershell"}}
742 Set-AESBSelfAsAlias -Alias "AliasName" -RemoveExistingAlias $true
743
744 {{/code}}
745
746 Beispiel 2: Hinzufügen der Virtual Router und Routing Keys vom Alias „AliasName“ zum angegebenen Alias "SelfAliasTest".
747
748 {{code language="powershell"}}
749 Set-AESBSelfAsAlias -Alias "AliasName" -AddToExistingAlias "SelfAliasTest"
750 {{/code}}
751
752 = Show-AESBRoutingTable =
753
754 Dieses Cmdlet zeigt die Routing-Tabelle für den angegebenen Virtual Router an. Mit den Parametern ist es möglich, die angezeigten Daten weiter einzuschränken.
755
756 **Parameter**
757
758 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
759 |-ConnectionName|string|✅|C|Der Name der Verbindung, die für das Abrufen der Routing-Tabelle verwendet wird.
760 |-ExchangeType|ExchangeTypes|✅|ET|Der Typ des Exchanges, der angezeigt werden soll. Mögliche Werte sind DIRECT oder ROUTING.
761 |-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, für den die Routing-Tabelle angezeigt wird.
762
763 === **Beispiele** ===
764
765 Beispiel 1: Anzeigen der Routing-Tabelle für den Virtual Router „MyRouter“
766
767 {{code language="powershell"}}
768 Show-AESBRoutingTable -VirtualRouter "MyRouter"
769
770 {{/code}}
771
772 Beispiel 2: Anzeigen der Routing-Tabelle für den Virtual Router „MyRouter“ an, wobei nur Einträge vom Typ „DIRECT“ angezeigt werden. Die Verbindung „MyConnection“ wird verwendet.
773
774 {{code language="powershell"}}
775 Show-AESBRoutingTable -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -ExchangeType DIRECT
776
777 {{/code}}
778
779 = Write-AESBActivityLog =
780
781 Mit diesem Cmdlet wird ein Eintrag in das ActivityLog des AESB geschrieben. Wenn keine ID angegeben wird, wird ein neuer Log-Eintrag erstellt. Falls eine ID angegeben wird, wird der vorhandene Log-Eintrag mit dieser ID aktualisiert.
782
783 **Parameter**
784
785 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
786 |-ConnectionName|string|✅|C|Der Name der Verbindung, die für die Kommunikation verwendet wird.
787 |-Id|string|✅|None|Die ID des Log-Eintrags, der aktualisiert werden soll. Wird ein neuer Eintrag erstellt, kann dieser Parameter weggelassen werden.
788 |-Name|string|❌|N|Der Name des Log-Eintrags.
789 |-Description|string|❌|D|Die Beschreibung des Log-Eintrags.
790 |-Status|JobFeedbackResultCode|❌|ST|Der Status des Logs, z.B. "Warning", "Created", "Started", "Running", "Stopping", "Stopped", "Failed" oder "Finished".
791 |-ComponentName|string|✅|ComName|Der Name der Komponente, die den Log-Eintrag erstellt hat.
792
793 === **Beispiele** ===
794
795 Beispiel 1: Erstellen eines neuen Log-Eintrags. Der Eintrag erhält den Namen "ProcessStart", die Beschreibung "Der Prozess wurde gestartet" und den Status "Started". Da keine ID angegeben ist, wird ein neuer Log-Eintrag erstellt.
796
797 {{code language="powershell"}}
798 Write-AESBActivityLog -Name "ProcessStart" -Description "Der Prozess wurde gestartet." -Status Started
799 {{/code}}
800
801 Beispiel 2: Aktualisieren eines vorhandenen Log-Eintrags mit der ID "12345". Der Log-Eintrag wird auf den Namen "ProcessUpdate", die Beschreibung "Der Prozessstatus wurde aktualisiert" und den Status "Running" gesetzt. Die ID wird verwendet, um den spezifischen Eintrag zu finden und zu aktualisieren.
802
803 {{code language="powershell"}}
804 Write-AESBActivityLog -Id "12345" -Name "ProcessUpdate" -Description "Der Prozessstatus wurde aktualisiert." -Status Running
805
806 {{/code}}
807
808 = Write-AESBBusinessLog =
809
810 Mit diesem Cmdlet wird eine Nachricht in das Business-Log des AESB geschrieben. Jeder Aufruf des Cmdlets erzeugt immer einen neuen Log-Eintrag
811
812 **Parameter**
813
814 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
815 |-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
816 |-IsError|bool|✅|IsErr|Gibt an, ob die Nachricht als Fehler protokolliert wird.
817 |-Message|string|❌|M|Die zu protokollierende Nachricht.
818 |-ComponentId|string|✅|CId|Die ID des Komponenten.
819 |-ComponentName|string|✅|ComName|Der Name des Komponenten.
820 |-ComponentPart|string|✅|ComPart|Der Teil des Komponenten.
821 |-HostId|string|✅|HId|Die ID des Hosts.
822 |-HostName|string|✅|HN|Der Name des Hosts.
823 |-Context|string|✅|CT|Der Kontext der Nachricht.
824
825 === **Beispiele** ===
826
827 Beispiel 1: Erstellen eines neuen Log-Eintrags im Business-Log mit der Nachricht "System started successfully". Der Log-Eintrag wird dem Komponenten-Namen "MyComponent" und dem Kontext "Initialization" zugeordnet.
828
829 {{code language="powershell"}}
830 Write-AESBBusinessLog -Message "System started successfully" -ComponentName "MyComponent" -Context "Initialization"
831
832 {{/code}}
833
834 Beispiel 2: Erstellen eines neuen Log-Eintrag im Business-Log, der als Fehler gekennzeichnet ist. Die Nachricht "Error connecting to database" wird dem Komponenten-ID "DBComponent" und dem Host-Namen "Server01" zugeordnet.
835
836 {{code language="powershell"}}
837 Write-AESBBusinessLog -IsError $true -Message "Error connecting to database" -ComponentId "DBComponent" -HostName "Server01"
838 {{/code}}
839
840
© Aagon GmbH 2025
Besuchen Sie unsere neue Aagon-Community