Wiki source code of Operative Cmdlets

Version 15.3 by jklein on 2024/12/05 12:18

version	line-number	content
1.1	1	{{aagon.floatingbox/}}
2.1	2
3.1	3	(% class="wikigeneratedid" %)
4.1	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.
2.1	5
3.1	6	= Add-AESBAlias =
	7
5.1	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
14.1	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.
5.1	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
2.1	30	= Add-AESBCallbackTarget =
	31
5.1	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
13.1	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.
5.1	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
2.1	57	= Add-AESBQueueTarget =
	58
9.1	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"]]
6.1	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
2.1	83	= Add-AESBRoutingKey =
	84
7.1	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
2.1	109	= Add-AESBRoutingToAlias =
	110
9.1	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.
7.1	112
9.1	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.
7.1	118
9.1	119	=== (% id="cke_bm_22527S" style="display:none" %) (%%)Beispiele ===
7.1	120
9.1	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.
7.1	122
9.1	123	{{code language="powershell"}}
	124	Add-AESBRoutingToAlias -Alias "MyAlias" -VirtualRouter "MyRouter" -RoutingKey "MyKey" -ConnectionName "MyConnection"
	125	{{/code}}
7.1	126
10.1	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.
7.1	128
10.1	129	{{code language="powershell"}}
	130	Add-AESBRoutingToAlias -Alias "AnotherAlias" -VirtualRouter "AnotherRouter" -RoutingKey "AnotherKey" -ConnectionName "MyConnection"
	131	{{/code}}
8.1	132
10.1	133	= Add-AESBTarget =
9.1	134
10.1	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.
9.1	136
10.1	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.
2.1	143
10.1	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
2.1	160	= Add-AESBVirtualRouter =
	161
11.1	162	Dieses Cmdlet wird verwendet, um einen neuen Virtual Router innerhalb der angegebenen SICS-Verbindung zu konfigurieren.
10.1	163
11.1	164	\|=(% style="width: 199px;" %)Parameter \|=(% style="width: 160px;" %)Datentyp\|=(% style="width: 119px;" %)Optional\|=(% style="width: 168px;" %)Alias\|=(% style="width: 827px;" %)Beschreibung
15.1	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.
10.1	167
15.1	168	=== Beispiele ===
10.1	169
15.1	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
2.1	184	= ConvertFrom-AESBBase64 =
	185
15.1	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
2.1	207	= ConvertFrom-AESBBase64ToFile =
	208
15.2	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
2.1	231	= ConvertFrom-AESBIcql =
	232
15.2	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:
	258
	259
	260
2.1	261	= ConvertTo-AESBBase64 =
	262
	263	= ConvertTo-AESBBase64FromFile =
	264
	265	= ConvertTo-AESBIcql =
	266
	267	= Get-AESBActivityLogItemById =
	268
	269	= Get-AESBAliasList =
	270
	271	= Get-AESBVirtualRouters =
	272
	273	= Get-AESBAlias =
	274
	275	= Get-AESBConnectionInfo =
	276
	277	= Get-AESBTargetMessageCount =
	278
	279	= Get-AESBTargets =
	280
	281	= Publish-AESBMessage =
	282
	283	= Publish-AESBMessageAndAwait =
	284
	285	= Receive-AESBTargetMessages =
	286
	287	= Remove-AESBAlias =
	288
	289	= Remove-AESBRoutingFromAlias =
	290
	291	= Remove-AESBRoutingKey =
	292
	293	= Remove-AESBTarget =
	294
	295	= Remove-AESBVirtualRouter =
	296
	297	= Set-AESBBSelfAsAlias =
	298
	299	= Show-AESBRoutingTable =
	300
	301	= Write-AESBActivityLog =
	302
	303	= Write-AESBBusinessLog =