Wiki source code of Operative Cmdlets

Version 22.4 by jklein on 2024/12/18 10:02

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
334 === **Beispiele** ===
335
336 Beispiel 1: Konvertiert das PSCustomObject in eine AESB Icql-Zeichenfolge und gibt die resultierende Icql-Zeichenfolge zurück.
337
338 {{code language="powershell" layout="LINENUMBERS"}}
339 # Erstellen eines PSCustomObject mit Beispieldaten
340 $exampleObject = [PSCustomObject]@{
341 TargetName = "MyTarget"
342 TargetType = "Queue"
343 RoutingKey = "MyRoutingKey"
344 VirtualRouter = "MyRouter"
345 ConnectionName = "MyConnection"
346 }
347
348 # Konvertieren des Objekts in eine Icql-Zeichenfolge
349 $icqlString = ConvertTo-AESBIcql -InputObject $exampleObject
350 $icqlString
351 {{/code}}
352
353 Beispiel 2: Konvertiert das PSCustomObject, das in der Variable $exampleObject gespeichert ist, in eine AESB Icql-Zeichenfolge und gibt die resultierende Icql-Zeichenfolge in der Variable $icqlString zurück.
354
355 {{code language="powershell" layout="LINENUMBERS"}}
356 # Erstellen eines PSCustomObject mit Beispieldaten
357 $exampleObject = [PSCustomObject]@{
358 TargetName = "MyTarget"
359 TargetType = "Queue"
360 RoutingKey = "MyRoutingKey"
361 VirtualRouter = "MyRouter"
362 ConnectionName = "MyConnection"
363 }
364
365 # Konvertieren des Objekts in eine Icql-Zeichenfolge
366 $icqlString = ConvertTo-AESBIcql -InputObject $exampleObject
367 $icqlString
368 {{/code}}
369
370 = Get-AESBActivityLogItemById =
371
372 Gibt den Activity Log-Eintrag anhand einer ID zurück.
373
374 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
375 |-Id|string|❌| |Die ID des Logeintrags
376
377 === **Beispiele** ===
378
379 Beispiel 1: Abruf eines Log-Eintrags anhand einer ID
380
381 {{code language="powershell"}}
382 Get-AESBActivityLogItemById -Id "ItemID"
383
384 {{/code}}
385
386 = Get-AESBAliasList =
387
388 Dieses Cmdlet wird verwendet, um eine Übersicht der im AESB gespeicherten Aliase zu erhalten.
389
390 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
391 |-ConnectionName|string|✅|C|Der Name der Verbindung, für die die Alias-Liste abgerufen werden soll.
392
393 === **Beispiele** ===
394
395 Beispiel 1: Abrufen einer Liste aller Aliase im AESB, ohne Angabe einer speziellen Verbindung
396
397 {{code language="powershell"}}
398 Get-AESBAliasList
399
400 {{/code}}
401
402 Beispiel 2: Abrufen einer Liste aller Aliase im AESB für die angegebene Verbindung "MyConnection"
403
404 {{code language="powershell"}}
405 Get-AESBAliasList -ConnectionName "MyConnection"
406
407 {{/code}}
408
409 = Get-AESBVirtualRouters =
410
411 Gibt eine Liste aller Virtual Router zurück.
412
413 === **Beispiele** ===
414
415 Beispiel 1: Abrufen einer Liste aller Virtual Router
416
417 {{code language="powershell"}}
418 Get-AESBVirtualRouters
419
420 {{/code}}
421
422 = Get-AESBAlias =
423
424 Gibt alle Informationen zu einer Verbindung mit einem bestimmten Alias wieder.
425
426 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
427 |-Alias|string|❌| |Gibt die Informationen zum angegebenen Alias wieder.
428
429 === **Beispiele** ===
430
431 Beispiel 1: Abrufen der Informationen zur Verbindung mit dem Alias "AliasName"
432
433 {{code language="powershell"}}
434 Get-AESBAlias -Alias "AliasName"
435
436 {{/code}}
437
438 = Get-AESBConnectionInfo =
439
440 Dieses Cmdlet wird verwendet, um Details über die Konfiguration und den Status einer Verbindung zu erhalten.
441
442 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
443 |-ConnectionName|string|✅|C|Der Name der Verbindung, für die Informationen abgerufen werden sollen.
444
445 === **Beispiele** ===
446
447 Beispiel 1: Abrufen von Informationen zu allen verfügbaren Verbindungen im AESB
448
449 {{code language="powershell" layout="LINENUMBERS"}}
450 Get-AESBConnectionInfo
451
452 #Beispiel-Output:
453
454 EndPoint VirtualRouter RoutingKey
455 -------- ------------- ----------
456 wss://localhost:3950 SHELL SICS.Aagon.Shell.local.a9857af7-bf81-44cd-8047-628956aad668
457 {{/code}}
458
459 Beispiel 2: Abrufen der Informationen zur Verbindung "MyConnection"
460
461 {{code language="powershell"}}
462 Get-AESBAliasList -ConnectionName "MyConnection"
463
464 {{/code}}
465
466 = Get-AESBTargetMessageCount =
467
468 Dieses Cmdlet wird verwendet, um die Anzahl der Nachrichten zu ermitteln, die sich derzeit im angegebenen Target befinden.
469
470 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
471 |-ConnectionName|string|✅|C|Der Name der Verbindung, für die die Zielnachrichtenzahl abgerufen werden soll.
472 |-TargetName|string|❌|TName|Der Name des Targets, für das die Nachrichtenzahl abgerufen werden soll.
473 |-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, unter dem das Target läuft.
474
475 === **Beispiele** ===
476
477 Beispiel 1: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem Virtual Router "MyRouter"
478
479 {{code language="powershell"}}
480 Get-AESBTargetMessageCount -VirtualRouter "MyRouter" -TargetName "MyTarget"
481 {{/code}}
482
483 Beispiel 2: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem Virtual Router "MyRouter" und der Verbindung "MyConnection"
484
485 {{code language="powershell"}}
486 Get-AESBTargetMessageCount -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"
487
488 {{/code}}
489
490 = Get-AESBTargets =
491
492 Dieses Cmdlet wird verwendet, um eine Übersicht der im AESB definierten Targets zu erhalten.
493
494 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
495 |-ConnectionName|string|✅|C|Der Name der Verbindung, für die die Liste der Targets abgerufen werden soll.
496 |-VirtualRouter|string|❌|VR|Der Name des VirtualRouters, für den die Liste der Targets abgerufen werden soll.
497
498 === **Beispiele** ===
499
500 Beispiel 1: Abrufen der Liste aller Targets unter dem Virtual Router "MyRouter"
501
502 {{code language="powershell"}}
503 Get-AESBTargets -VirtualRouter "MyRouter"
504
505 {{/code}}
506
507 Beispiel 2: Abrufen der Liste aller Targets für den Virtual Router "MyRouter" und die Verbindung "MyConnection"
508
509 {{code language="powershell"}}
510 Get-AESBTargets -ConnectionName "MyConnection" -VirtualRouter "MyRouter"
511
512 {{/code}}
513
514 = Publish-AESBMessage =
515
516 Dieses Cmdlet wird verwendet, um Nachrichten an die angegebenen Ziele oder Aliase zu senden.
517
518 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
519 |-Alias|string|❌|A|Der Name des Alias, an den die Nachricht veröffentlicht werden soll.
520 |-ConnectionName|string|✅|C|Der Name der Verbindung, über die die Nachricht gesendet werden soll.
521 |-Force|switch|✅|F|Zwingt die Veröffentlichung der Nachricht, auch wenn dies normalerweise nicht zulässig wäre.
522 |-Message|Object|❌|M|Die Nachricht, die veröffentlicht werden soll.
523 |-RoutingKey|string|❌|RK|Der RoutingKey, der für das Routing der Nachricht verwendet wird.
524 |-VirtualRouter|string|❌|VR|Der Name des VirtualRouters, über den die Nachricht veröffentlicht werden soll.
525
526 === Parameter-Sets ===
527
528 Für die Parameter dieses Cmdlets wurden eigene Parameter-Sets definiert, die Sie verwenden können:
529
530 * (((
531 RoutingParameterSet - Message, VirtualRouter, RoutingKey
532 )))
533 * (((
534 AliasParameterSet - Message, Alias
535 )))
536
537 === **Beispiele** ===
538
539 Beispiel 1: Senden der Nachricht "This is a test message" an den Alias "MyAlias"
540
541 {{code language="powershell"}}
542 Publish-AESBMessage -Alias "MyAlias" -Message "This is a test message"
543
544 {{/code}}
545
546 Beispiel 2: Senden der Nachricht "This is a test message" über den Virtual Router "MyRouter" mit dem Routing Key "MyRoutingKey"
547
548 {{code language="powershell"}}
549 Publish-AESBMessage -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey" -Message "This is a test message"
550
551 {{/code}}
552
553 Beispiel 3: Konvertieren eines PSCustomObject in das ICQL-Format und senden der Nachricht an den Alias "MyAlias"
554
555 {{code language="powershell"}}
556 ConvertTo-AESBIcql $exampleObject | Publish-AESBMessage -Alias "MyAlias"
557
558 {{/code}}
559
560 = Publish-AESBMessageAndAwait =
561
562 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.
563
564 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
565 |-Alias|string|❌|A|Der Name des Alias, an den die Nachricht veröffentlicht werden soll.
566 |-ConnectionName|string|✅|C|Der Name der Verbindung, über die die Nachricht gesendet werden soll.
567 |-Force|switch|✅|F|Zwingt die Veröffentlichung der Nachricht, auch wenn dies normalerweise nicht zulässig wäre.
568 |-Message|Object|❌|M|Die Nachricht, die veröffentlicht werden soll.
569 |-RoutingKey|string|❌|RK|Der Routing Key, der für das Routing der Nachricht verwendet wird.
570 |-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.
571 |-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, über den die Nachricht veröffentlicht werden soll.
572
573 === **Beispiele** ===
574
575 Beispiel 1: Senden der Nachricht "This is a test message" an den Alias "MyAlias" und wartet bis zu 5 Minuten auf eine Bestätigung
576
577 {{code language="powershell"}}
578 Publish-AESBMessageAndAwait -Alias "MyAlias" -Message "This is a test message" -Timeout "5m"
579
580 {{/code}}
581
582 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.
583
584 {{code language="powershell"}}
585 Publish-AESBMessageAndAwait -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey" -Message "This is a test message" -Timeout "1h"
586
587 {{/code}}
588
589 = Receive-AESBTargetMessages =
590
591 Mit diesem Cmdlet können Sie Nachrichten von einem Ziel im AESB empfangen.
592
593 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
594 |-ConnectionName|//string//|✅|C|Der Name der Verbindung zum AESB.
595 |-MessageCount|//int//|✅|MC|Die Anzahl der Nachrichten, die empfangen werden sollen.
596 |-TargetName|//string//|❌|TName|Der Name des Ziels, von dem die Nachrichten empfangen werden.
597 |-VirtualRouter|//string//|❌|VR|Der Name des Virtual Routers, der für das Ziel verwendet wird.
598
599 === **Beispiele** ===
600
601 Beispiel 1: Empfangen von Nachrichten vom Ziel mit dem Namen "MyTarget", das dem Virtual Router "MyRouter" zugeordnet ist
602
603 {{code language="powershell"}}
604 Receive-AESBTargetMessages -VirtualRouter "MyRouter" -TargetName "MyTarget"
605
606 {{/code}}
607
608 Beispiel 2: Empfangen von bis zu 10 Nachrichten vom Ziel mit dem Namen "MyTarget", das dem Virtual Router "MyRouter" zugeordnet ist
609
610 {{code language="powershell"}}
611 Receive-AESBTargetMessages -VirtualRouter "MyRouter" -TargetName "MyTarget" -MessageCount 10
612
613 {{/code}}
614
615 = Remove-AESBAlias =
616
617 Mit diesem Cmdlet können Sie einen Alias aus dem AESB entfernen.
618
619 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
620 |-Alias|string|❌|A|Der Name des zu entfernenden Alias.
621 |-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
622
623 === **Beispiele** ===
624
625 Beispiel 1: Entfernen vom Alias "MyAlias" aus dem AESB
626
627 {{code language="powershell"}}
628 Remove-AESBAlias -Alias "MyAlias"
629
630 {{/code}}
631
632 Beispiel 2: Entfernen vom Alias "MyAlias" aus dem AESB über die angegebene Verbindung
633
634 {{code language="powershell"}}
635 Remove-AESBAlias -ConnectionName "MyConnection" -Alias "MyAlias"
636
637 {{/code}}
638
639 = Remove-AESBRoutingFromAlias =
640
641 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.
642
643 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
644 |-Alias|string|❌|A|Der Name des Alias, von dem das Routing-Paar entfernt werden soll.
645 |-ConnectionName|string|✅|C|Der Name der Verbindung, die verwendet wird.
646 |-RoutingKey|string|❌|RK|Der Routing Key, der aus dem Alias entfernt werden soll.
647 |-VirtualRouter|string|❌|VR|Der Virtual Router, der zusammen mit dem Routing Key entfernt werden soll.
648
649 === **Beispiele** ===
650
651 Beispiel 1: Entfernen vom Routing-Paar mit Virtual Router "MyRouter" und Routing Key "MyRoutingKey" vom Alias "MyAlias"
652
653 {{code language="powershell"}}
654 Remove-AESBRoutingFromAlias -Alias "MyAlias" -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey"
655
656 {{/code}}
657
658 Beispiel 2: Entfernen vom Routing-Paar mit Virtual Router "MyRouter" und Routing Key "MyRoutingKey" vom Alias "MyAlias" unter Verwendung der Verbindung "MyConnection"
659
660 {{code language="powershell"}}
661 Remove-AESBRoutingFromAlias -Alias "MyAlias" -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey"
662
663 {{/code}}
664
665 = Remove-AESBRoutingKey =
666
667 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.
668
669 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
670 |-ConnectionName|string|✅|C|Der Name der Verbindung, die verwendet werden soll.
671 |-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, von dem der Routing Key entfernt werden soll.
672 |-TargetName|string|❌|TName|Der Name des Ziels, von dem der Routing Key entfernt werden soll.
673 |-RoutingKey|string|❌|RK|Der Routing Key, der entfernt werden soll.
674
675 === **Beispiele** ===
676
677 Beispiel 1: Entfernen vom Routing Key "MyRoutingKey" vom Ziel "MyTarget" im Virtual Router "MyRouter"
678
679 {{code language="powershell"}}
680 Remove-AESBRoutingKey -VirtualRouter "MyRouter" -TargetName "MyTarget" -RoutingKey "MyRoutingKey"
681
682 {{/code}}
683
684 Beispiel 2: Entfernen vom Routing Key "MyRoutingKey" vom Ziel "MyTarget" im Virtual Router "MyRouter" unter Verwendung der Verbindung "MyConnection"
685
686 {{code language="powershell"}}
687 Remove-AESBRoutingKey -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget" -RoutingKey "MyRoutingKey"
688
689 {{/code}}
690
691 = Remove-AESBTarget =
692
693 Mit diesem Cmdlet können Sie ein Ziel aus dem Virtual Router des AESB entfernen.
694
695 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
696 |-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
697 |-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, von dem das Ziel entfernt werden soll.
698 |-TargetName|string|❌|TName|Der Name des Ziels, das entfernt werden soll.
699
700 === **Beispiele** ===
701
702 Beispiel 1: Entfernen vom Ziel "MyTarget" vom Virtual Router "MyRouter"
703
704 {{code language="powershell"}}
705 Remove-AESBTarget -VirtualRouter "MyRouter" -TargetName "MyTarget"
706 {{/code}}
707
708 Beispiel 2: Entfernen vom Ziel "MyTarget" vom Virtual Router "MyRouter" unter Verwendung der Verbindung "MyConnection"
709
710 {{code language="powershell"}}
711 Remove-AESBTarget -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"
712 {{/code}}
713
714 = Remove-AESBVirtualRouter =
715
716 Mit diesem Cmdlet können Sie einen angegebenen Virtual Router entfernen.
717
718 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
719 |ConnectionName|string|✅|C|Gibt den Namen der Verbindung an.
720 |VirtualRouter|string|❌|VR|Gibt den Namen des zu entfernenden Virtual Router an.
721
722 === **Beispiele** ===
723
724 Beispiel 1: Entfernen vom Virtual Router mit dem Namen "MyRouter"
725
726 {{code language="powershell"}}
727 Remove-AESBVirtualRouter -VirtualRouter "MyRouter"
728
729 {{/code}}
730
731 Beispiel 2: Entfernen vom Virtual Router mit dem Namen "MyRouter" unter der Verbindung "MyConnection"
732
733 {{code language="powershell"}}
734 Remove-AESBVirtualRouter -ConnectionName "MyConnection" -VirtualRouter "MyRouter"
735 {{/code}}
736
737 = Set-AESBBSelfAsAlias =
738
739 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.
740
741 {{aagon.warnungsbox}}
742 Die Parameter RemoveExistingAlias und AddToExistingAlias dürfen nicht gleichzeitig verwendet werden!
743 {{/aagon.warnungsbox}}
744
745 **Parameter**
746
747 |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
748 |-Alias|string|❌| |Gibt den Namen vom Alias an
749 |-RemoveExistingAlias|bool|✅| |Der bestehende Alias wird ersetzt.
750 |-AddToExistingAlias|bool|✅| |Der Virtual Router und Routing Key wird zu dem angegebenen Alias hinzugefügt
751
752 === **Beispiele** ===
753
754 Beispiel 1: Überschreiben vom existierenden Alias „AliasName“. Wenn z.B. der vorherige Alias mehrere Virtual Router und Routing Keys hatte, werden diese gelöscht
755
756 {{code language="powershell"}}
757 Set-AESBSelfAsAlias -Alias "AliasName" -RemoveExistingAlias $true
758
759 {{/code}}
760
761 Beispiel 2: Hinzufügen der Virtual Router und Routing Keys vom Alias „AliasName“ zum angegebenen Alias "SelfAliasTest".
762
763 {{code language="powershell"}}
764 Set-AESBSelfAsAlias -Alias "AliasName" -AddToExistingAlias "SelfAliasTest"
765 {{/code}}
766
767 = Show-AESBRoutingTable =
768
769 = Write-AESBActivityLog =
770
771 = Write-AESBBusinessLog =
© Aagon GmbH 2025
Besuchen Sie unsere neue Aagon-Community