Operative Cmdlets

Version 20.1 von jklein am 2024/12/16 14:59

Inhalt

Add-AESBAlias
Add-AESBCallbackTarget
Add-AESBQueueTarget
Add-AESBRoutingKey
Add-AESBRoutingToAlias
Add-AESBTarget
Add-AESBVirtualRouter
ConvertFrom-AESBBase64
ConvertFrom-AESBBase64ToFile
ConvertFrom-AESBIcql
ConvertTo-AESBBase64
ConvertTo-AESBBase64FromFile
ConvertTo-AESBIcql
Get-AESBActivityLogItemById
Get-AESBAliasList
Get-AESBVirtualRouters
Get-AESBAlias
Get-AESBConnectionInfo
Get-AESBTargetMessageCount
Get-AESBTargets
Publish-AESBMessage
Publish-AESBMessageAndAwait
Add-AESBAlias
Add-AESBCallbackTarget
Add-AESBQueueTarget
Add-AESBRoutingKey
Add-AESBRoutingToAlias
Add-AESBTarget
Add-AESBVirtualRouter
ConvertFrom-AESBBase64
ConvertFrom-AESBBase64ToFile
ConvertFrom-AESBIcql
ConvertTo-AESBBase64
ConvertTo-AESBBase64FromFile
ConvertTo-AESBIcql
Get-AESBActivityLogItemById
Get-AESBAliasList
Get-AESBVirtualRouters
Get-AESBAlias
Get-AESBConnectionInfo
Get-AESBTargetMessageCount
Get-AESBTargets
Publish-AESBMessage
Receive-AESBTargetMessages
Remove-AESBAlias
Remove-AESBRoutingFromAlias
Remove-AESBRoutingKey
Remove-AESBTarget
Remove-AESBVirtualRouter
Set-AESBBSelfAsAlias
Show-AESBRoutingTable
Write-AESBActivityLog
Write-AESBBusinessLog

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.

Add-AESBAlias

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.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Alias	String	❌	Keine	Der Name des Alias, der dem Qualified Name Service (QNS) hinzugefügt werden soll.
-ConnectionName	String	✅	Keine	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.

Beispiele

Beispiel 1: Hinzufügen des Alias "MyAlias" für die Standardverbindung

Add-AESBAlias -Alias "MyAlias"

Beispiel 2: Hinzufügen des Alias "MyAlias" für die SICS-Verbindung "MyConnection"

Add-AESBAlias -Alias "MyAlias" -ConnectionName "MyConnection"

Add-AESBCallbackTarget

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.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	String	✅	Keine	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.
-VirtualRouter	String	❌	Keine	Der Name des Virtual Routers, dem das Callback-Target zugeordnet werden soll.
-TargetName	String	❌	Keine	Der Name des Callback-Targets, das hinzugefügt werden soll.
-RoutingKey	String	❌	Keine	Der Routing-Key, der verwendet wird, um Nachrichten an das Callback-Target zu routen.

Beispiele

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

Add-AESBCallbackTarget -VirtualRouter "Router1" -TargetName "CallbackTarget1" -RoutingKey "Key1"

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

Add-AESBCallbackTarget -ConnectionName "MyConnection" -VirtualRouter "Router1" -TargetName "CallbackTarget1" -RoutingKey "Key1"

Add-AESBQueueTarget

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.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	String	✅	Keine	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.
-VirtualRouter	String	❌	Keine	Der Name des Virtual Routers, dem das Queue-Target zugeordnet wird.
-TargetName	String	❌	Keine	Der Name des Queue-Targets, das hinzugefügt werden soll.
-RoutingKey	String	❌	Keine	Der Routing-Key, der verwendet wird, um Nachrichten an das Queue-Targets zu senden.

Beispiele

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

Add-AESBQueueTarget -VirtualRouter "Router1" -TargetName "QueueTarget1" -RoutingKey "Key1"

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

Add-AESBQueueTarget -ConnectionName "MyConnection" -VirtualRouter "Router1" -TargetName "QueueTarget1" -RoutingKey "Key1"

Add-AESBRoutingKey

Dieses Cmdlet wird verwendet, um Routing-Informationen für ein AESB-Target zu konfigurieren. Dabei wird ein RoutingKey zu einem Target in einem VirtualRouter hinzugefügt.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der SICS-Verbindung, für die der Routing Key hinzugefügt werden soll.
-VirtualRouter	string	❌	VR	Der Name des Virtual Router, zu dem der Routing Key gehört.
-TargetName	string	❌	TName	Der Name des Targets, für das der Routing Key hinzugefügt wird.
-RoutingKey	string	❌	RK	Der Name des Routing Keys, der hinzugefügt werden soll.

Beispiele

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

Add-AESBQueueTarget -VirtualRouter "Router1" -TargetName "QueueTarget1" -RoutingKey "Key1"

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

Add-AESBRoutingKey -ConnectionName "MyConnection" -VirtualRouter "AnotherRouter" -TargetName "AnotherTarget" -RoutingKey "AnotherKey"

Add-AESBRoutingToAlias

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.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Alias	string	❌	A	Der Alias, zu dem das Routing-Paar im QNS hinzugefügt werden soll.
-ConnectionName	string	✅	C	Der Name der SICS-Verbindung, für die das Routing-Paar hinzugefügt werden soll.
-RoutingKey	string	❌	RK	Der Name des Routing Keys, der zusammen mit dem Virtual Router hinzugefügt werden soll.
-VirtualRouter	string	❌	VR	Der Name des Virtual Router, der zusammen mit dem Routing Key hinzugefügt werden soll.

Beispiele

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.

Add-AESBRoutingToAlias -Alias "MyAlias" -VirtualRouter "MyRouter" -RoutingKey "MyKey" -ConnectionName "MyConnection"

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.

Add-AESBRoutingToAlias -Alias "AnotherAlias" -VirtualRouter "AnotherRouter" -RoutingKey "AnotherKey" -ConnectionName "MyConnection"

Add-AESBTarget

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.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der SICS-Verbindung, für die das Target hinzugefügt werden soll.
-RoutingKey	string	❌	RK	Der Routing Key, der dem Target zugewiesen wird.
-TargetName	string	❌	TName	Der Name des Targets, das hinzugefügt werden soll.
-TargetType	string	❌	TType	Der Typ des Targets, das hinzugefügt werden soll.
-VirtualRouter	string	❌	VR	Der Name des Virtual Routers, zu dem das Target hinzugefügt wird.

Beispiele

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

Add-AESBTarget -VirtualRouter "MyRouter" -TargetType "Queue" -TargetName "MyTarget" -RoutingKey "MyKey"

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

Add-AESBTarget -VirtualRouter "AnotherRouter" -TargetType "Queue" -TargetName "AnotherTarget" -RoutingKey "AnotherKey" -ConnectionName "MyConnection"

Add-AESBVirtualRouter

Dieses Cmdlet wird verwendet, um einen neuen Virtual Router innerhalb der angegebenen SICS-Verbindung zu konfigurieren.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der Verbindung, in der der VirtualRouter hinzugefügt werden soll.
-VirtualRouter	string	❌	VR	Der Name des VirtualRouter, der hinzugefügt werden soll.

Beispiele

Beispiel 1: Hinzufügen eines Virtual Routers "MyRouter" in der Standardverbindung

Add-AESBVirtualRouter -VirtualRouter "MyRouter"

Beispiel 2: Hinzufügen eines Virtual Routers "AnotherRouter" in der SICS-Verbindung "MyConnection"

Add-AESBVirtualRouter -VirtualRouter "AnotherRouter" -ConnectionName "MyConnection"

ConvertFrom-AESBBase64

Dieses Cmdlet wird verwendet, um eine Base64-kodierte Zeichenfolge zurück in ihre unkodierte Form zu dekodieren.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Input	string	❌	In	Die Base64-kodierte Zeichenfolge, die dekodiert werden soll.

Beispiele

Beispiel 1: Dekodieren einer Base64-kodierten Zeichenfolge. Zurückgegeben wird der ursprüngliche Text "Hello World!"

ConvertFrom-AESBBase64 -Input "SGVsbG8gV29ybGQh"

Beispiel 2: Dekodieren einer Base64-Zeichenfolge aus der Variable $base64string. Zurückgegeben wird der ursprüngliche Text "Some base64 text"

$base64String = "U29tZSBiYXNlNjQgdGV4dA=="
ConvertFrom-AESBBase64 -Input $base64String

ConvertFrom-AESBBase64ToFile

Dieses Cmdlet wird verwendet, um eine Base64-kodierte Zeichenfolge zu dekodieren und in einer Datei zu speichern.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Input	string	❌	In	Die Base64-kodierte Zeichenfolge, die dekodiert werden soll.
-OutputPath	string	❌	None	Der Pfad inklusive Dateinamen, unter dem die dekodierten Daten gespeichert werden sollen.
-Force	switch	✅	F	Überschreibt die Datei am OutputPath, falls bereits eine Datei mit diesem Namen existiert.

Beispiele

Beispiel 1: Dekodieren einer Base64-Zeichenfolge und Speichern vom ursprünglichen Text "Hello World!" in der Datei "output.txt" im angegebenen Pfad

ConvertFrom-AESBBase64ToFile -Input "SGVsbG8gV29ybGQh" -OutputPath "C:\path\to\output.txt"

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

ConvertFrom-AESBBase64ToFile -Input "U29tZSBiYXNlNjQgdGV4dA==" -OutputPath "C:\path\to\output.txt" -Force

ConvertFrom-AESBIcql

Dieses Cmdlet wird verwendet, um eine AESB Icql-Zeichenfolge zurück in ein PowerShell-Objekt zu dekodieren.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Icql	string	❌	None	Die AESB Icql-Zeichenfolge, die dekodiert werden soll.

Beispiele

Beispiel 1: Dekodieren einer AESB Icql-Zeichenfolge aus der Variable $icqlString

$icqlString = "<ICQL><POWERSHELL><MESSAGE><TargetName>MyTarget</TargetName><TargetType>Queue</TargetType><RoutingKey>MyRoutingKey</RoutingKey><VirtualRouter>MyRouter</VirtualRouter><ConnectionName>MyConnection</ConnectionName></MESSAGE></POWERSHELL></ICQL>"
ConvertFrom-AESBIcql -Icql $icqlString

Dabei wird das PSCustomObject mit folgenden Daten zurückgegeben:

1
2
3
4
5

TargetName     : MyTarget
TargetType     : Queue
RoutingKey     : MyRoutingKey
VirtualRouter : MyRouter
ConnectionName : MyConnection

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# Erstellen eines PSCustomObject mit Beispieldaten
$exampleObject = [PSCustomObject]@{
    TargetName    = "MyTarget"
    TargetType    = "Queue"
    RoutingKey    = "MyRoutingKey"
    VirtualRouter = "MyRouter"
    ConnectionName = "MyConnection"
}

# Konvertieren des Objekts in eine Icql-Zeichenfolge
$x = ConvertTo-AESBIcql -InputObject $exampleObject

# Zurückkonvertieren der Icql-Zeichenfolge in ein PSCustomObject
$decodedObject = ConvertFrom-AESBIcql -Icql $x

# Anzeigen des dekodierten Objekts
$decodedObjectConvertFrom-AESBIcql -Icql $icqlString

ConvertTo-AESBBase64

Dieses Cmdlet wird verwendet, um eine Zeichenfolge in das Base64-Format zu konvertieren.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Input	string	❌	In	Die Zeichenfolge, die in Base64 kodiert werden soll.

Beispiele

Beispiel 1: Kodieren der Zeichenfolge "Hello World!" in Base64. Zurückgegeben wird die Base64-kodierte Version

ConvertTo-AESBBase64 -Input "Hello World!"
ConvertFrom-AESBIcql -Icql $icqlString

Beispiel 2: Kodieren der Zeichenfolge aus der Variable $string in Base64. Zurückgegeben wird die Base64-kodierte Zeichenfolge in der Variable $base64String

$string = "Base64 encoding example"
$base64String = ConvertTo-AESBBase64 -Input $string
$base64StringConvertFrom-AESBIcql -Icql $icqlString

ConvertTo-AESBBase64FromFile

Dieses Cmdlet wird verwendet, um den Inhalt einer Datei in eine Base64-kodierte Zeichenfolge zu konvertieren.

Parameter	Datentyp	Optional	Alias	Beschreibung
-InputPath	string	❌	InPath	Der Pfad zur Datei, deren Inhalt in Base64 kodiert werden soll.

Beispiele

Beispiel 1: Kodieren des Inhalts der Datei "file.txt" unter dem angegebenen Pfad in Base64. Zurückgegeben wird die Base64-kodierte Zeichenfolge

ConvertTo-AESBBase64FromFile -InputPath "C:\path\to\file.txt"

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

$filePath = "C:\path\to\anotherfile.txt"
$base64String = ConvertTo-AESBBase64FromFile -InputPath $filePath
$base64String

ConvertTo-AESBIcql

Dieses Cmdlet wird verwendet, um ein PowerShell-Objekt in das Icql-Format zu kodieren, das vom AESB verwendet wird.

Parameter	Datentyp	Optional	Alias	Beschreibung
-InputObject	psobject	❌	InObj	Das PSCustomObject, das in eine AESB Icql-Zeichenfolge konvertiert werden soll.

Beispiele

Beispiel 1: Konvertiert das PSCustomObject in eine AESB Icql-Zeichenfolge und gibt die resultierende Icql-Zeichenfolge zurück.

1
2
3
4
5
6
7
8
9
10
11
12

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.

1
2
3
4
5
6
7
8
9
10
11
12

Get-AESBActivityLogItemById

Gibt den ActivityLog-Eintrag anhand einer ID zurück.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Id	string	❌		Die ID des Logeintrags

Beispiele

Beispiel 1: Abruf eines Log-Eintrags anhand einer ID

Get-AESBActivityLogItemById -Id "ItemID"

Get-AESBAliasList

Dieses Cmdlet wird verwendet, um eine Übersicht der im AESB gespeicherten Aliase zu erhalten.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der Verbindung, für die die Alias-Liste abgerufen werden soll.

Beispiele

Beispiel 1: Abrufen einer Liste aller Aliase im AESB, ohne Angabe einer speziellen Verbindung

Get-AESBAliasList

Beispiel 2: Abrufen einer Liste aller Aliase im AESB für die angegebene Verbindung "MyConnection"

Get-AESBAliasList -ConnectionName "MyConnection"

Get-AESBVirtualRouters

Gibt eine Liste aller VirtualRouter zurück.

Beispiele

Beispiel 1: Abrufen einer Liste aller VirtualRouter

Get-AESBVirtualRouters

Get-AESBAlias

Gibt alle Informationen zu einer Verbindung mit einem bestimmten Alias wieder.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Alias	string	❌		Gibt die Informationen zum angegebenen Alias wieder.

Beispiele

Beispiel 1: Abrufen der Informationen zur Verbindung mit dem Alias "AliasName"

Get-AESBAlias -Alias "AliasName"

Get-AESBConnectionInfo

Dieses Cmdlet wird verwendet, um Details über die Konfiguration und den Status einer Verbindung zu erhalten.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der Verbindung, für die Informationen abgerufen werden sollen.

Beispiele

Beispiel 1: Abrufen von Informationen zu allen verfügbaren Verbindungen im AESB

1
2
3
4
5
6
7

Get-AESBConnectionInfo

#Beispiel-Output:

EndPoint             VirtualRouter RoutingKey
--------             ------------- ----------
wss://localhost:3950 SHELL         SICS.Aagon.Shell.local.a9857af7-bf81-44cd-8047-628956aad668

Beispiel 2: Abrufen der Informationen zur Verbindung "MyConnection"

Get-AESBAliasList -ConnectionName "MyConnection"

Get-AESBTargetMessageCount

Dieses Cmdlet wird verwendet, um die Anzahl der Nachrichten zu ermitteln, die sich derzeit im angegebenen Target befinden.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der Verbindung, für die die Zielnachrichtenzahl abgerufen werden soll.
-TargetName	string	❌	TName	Der Name des Targets, für das die Nachrichtenzahl abgerufen werden soll.
-VirtualRouter	string	❌	VR	Der Name des VirtualRouters, unter dem das Target läuft.

Beispiele

Beispiel 1: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem VirtualRouter "MyRouter"

Get-AESBTargetMessageCount -VirtualRouter "MyRouter" -TargetName "MyTarget"

Beispiel 2: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem VirtualRouter "MyRouter" und der Verbindung "MyConnection"

Get-AESBTargetMessageCount -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"

Get-AESBTargets

Dieses Cmdlet wird verwendet, um eine Übersicht der im AESB definierten Targets zu erhalten.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der Verbindung, für die die Liste der Targets abgerufen werden soll.
-VirtualRouter	string	❌	VR	Der Name des VirtualRouters, für den die Liste der Targets abgerufen werden soll.

Beispiele

Beispiel 1: Abrufen der Liste aller Targets unter dem VirtualRouter "MyRouter"

Get-AESBTargets -VirtualRouter "MyRouter"

Beispiel 2: Abrufen der Liste aller Targets für den VirtualRouter "MyRouter" und die Verbindung "MyConnection"

Get-AESBTargets -ConnectionName "MyConnection" -VirtualRouter "MyRouter"

Publish-AESBMessage

Dieses Cmdlet wird verwendet, um Nachrichten an die angegebenen Ziele oder Aliase zu senden.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Alias	string	❌	A	Der Name des Alias, an den die Nachricht veröffentlicht werden soll.
-ConnectionName	string	✅	C	Der Name der Verbindung, über die die Nachricht gesendet werden soll.
-Force	switch	✅	F	Zwingt die Veröffentlichung der Nachricht, auch wenn dies normalerweise nicht zulässig wäre.
-Message	Object	❌	M	Die Nachricht, die veröffentlicht werden soll.
-RoutingKey	string	❌	RK	Der RoutingKey, der für das Routing der Nachricht verwendet wird.
-VirtualRouter	string	❌	VR	Der Name des VirtualRouters, über den die Nachricht veröffentlicht werden soll.

Für die Parameter dieses Cmdlets wurden eigene Parameter-Sets definiert, die Sie verwenden können:

RoutingParameterSet - Message, VirtualRouter, RoutingKey
AliasParameterSet - Message, Alias

Beispiele

Beispiel 1: Senden der Nachricht "This is a test message" an den Alias "MyAlias"

Publish-AESBMessage -Alias "MyAlias" -Message "This is a test message"

Beispiel 2: Senden der Nachricht "This is a test message" über den VirtualRouter "MyRouter" mit dem RoutingKey "MyRoutingKey"

Publish-AESBMessage -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey" -Message "This is a test message"

Beispiel 3: Konvertieren eines PowerShell-Objekts in das ICQL-Format und senden des Objekts an den Alias "MyAlias".

ConvertTo-AESBIcql $exampleObject | Publish-AESBMessage -Alias "MyAlias"

Publish-AESBMessageAndAwait

Sendet eine Nachricht an ein bestimmtes Target oder einen Alias im AESB und wartet auf eine Bestätigung oder Antwort innerhalb des angegebenen Zeitlimits.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Alias	string	❌	A	Der Name des Alias, an den die Nachricht veröffentlicht werden soll.
-ConnectionName	string	✅	C	Der Name der Verbindung, über die die Nachricht gesendet werden soll.
-Force	switch	✅	F	Zwingt die Veröffentlichung der Nachricht, auch wenn dies normalerweise nicht zulässig wäre.
-Message	Object	❌	M	Die Nachricht, die veröffentlicht werden soll.
-RoutingKey	string	❌	RK	Der RoutingKey, der für das Routing der Nachricht verwendet wird.
-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.
-VirtualRouter	string	❌	VR	Der Name des VirtualRouters, über den die Nachricht veröffentlicht werden soll.

Arbeiten in AESB verwendet werden können.

Add-AESBAlias

Parameter	Datentyp	Optional	Alias	Beschreibung
-Alias	String	❌	Keine	Der Name des Alias, der dem Qualified Name Service (QNS) hinzugefügt werden soll.
-ConnectionName	String	✅	Keine	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.

Beispiele

Beispiel 1: Hinzufügen des Alias "MyAlias" für die Standardverbindung

Add-AESBAlias -Alias "MyAlias"

Beispiel 2: Hinzufügen des Alias "MyAlias" für die SICS-Verbindung "MyConnection"

Add-AESBAlias -Alias "MyAlias" -ConnectionName "MyConnection"

Add-AESBCallbackTarget

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	String	✅	Keine	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.
-VirtualRouter	String	❌	Keine	Der Name des Virtual Routers, dem das Callback-Target zugeordnet werden soll.
-TargetName	String	❌	Keine	Der Name des Callback-Targets, das hinzugefügt werden soll.
-RoutingKey	String	❌	Keine	Der Routing-Key, der verwendet wird, um Nachrichten an das Callback-Target zu routen.

Beispiele

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

Add-AESBCallbackTarget -VirtualRouter "Router1" -TargetName "CallbackTarget1" -RoutingKey "Key1"

Add-AESBCallbackTarget -ConnectionName "MyConnection" -VirtualRouter "Router1" -TargetName "CallbackTarget1" -RoutingKey "Key1"

Add-AESBQueueTarget

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	String	✅	Keine	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.
-VirtualRouter	String	❌	Keine	Der Name des Virtual Routers, dem das Queue-Target zugeordnet wird.
-TargetName	String	❌	Keine	Der Name des Queue-Targets, das hinzugefügt werden soll.
-RoutingKey	String	❌	Keine	Der Routing-Key, der verwendet wird, um Nachrichten an das Queue-Targets zu senden.

Beispiele

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

Add-AESBQueueTarget -VirtualRouter "Router1" -TargetName "QueueTarget1" -RoutingKey "Key1"

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

Add-AESBQueueTarget -ConnectionName "MyConnection" -VirtualRouter "Router1" -TargetName "QueueTarget1" -RoutingKey "Key1"

Add-AESBRoutingKey

Dieses Cmdlet wird verwendet, um Routing-Informationen für ein AESB-Target zu konfigurieren. Dabei wird ein RoutingKey zu einem Target in einem VirtualRouter hinzugefügt.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der SICS-Verbindung, für die der Routing Key hinzugefügt werden soll.
-VirtualRouter	string	❌	VR	Der Name des Virtual Router, zu dem der Routing Key gehört.
-TargetName	string	❌	TName	Der Name des Targets, für das der Routing Key hinzugefügt wird.
-RoutingKey	string	❌	RK	Der Name des Routing Keys, der hinzugefügt werden soll.

Beispiele

Add-AESBQueueTarget -VirtualRouter "Router1" -TargetName "QueueTarget1" -RoutingKey "Key1"

Add-AESBRoutingKey -ConnectionName "MyConnection" -VirtualRouter "AnotherRouter" -TargetName "AnotherTarget" -RoutingKey "AnotherKey"

Add-AESBRoutingToAlias

Parameter	Datentyp	Optional	Alias	Beschreibung
-Alias	string	❌	A	Der Alias, zu dem das Routing-Paar im QNS hinzugefügt werden soll.
-ConnectionName	string	✅	C	Der Name der SICS-Verbindung, für die das Routing-Paar hinzugefügt werden soll.
-RoutingKey	string	❌	RK	Der Name des Routing Keys, der zusammen mit dem Virtual Router hinzugefügt werden soll.
-VirtualRouter	string	❌	VR	Der Name des Virtual Router, der zusammen mit dem Routing Key hinzugefügt werden soll.

Beispiele

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.

Add-AESBRoutingToAlias -Alias "MyAlias" -VirtualRouter "MyRouter" -RoutingKey "MyKey" -ConnectionName "MyConnection"

Add-AESBRoutingToAlias -Alias "AnotherAlias" -VirtualRouter "AnotherRouter" -RoutingKey "AnotherKey" -ConnectionName "MyConnection"

Add-AESBTarget

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.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der SICS-Verbindung, für die das Target hinzugefügt werden soll.
-RoutingKey	string	❌	RK	Der Routing Key, der dem Target zugewiesen wird.
-TargetName	string	❌	TName	Der Name des Targets, das hinzugefügt werden soll.
-TargetType	string	❌	TType	Der Typ des Targets, das hinzugefügt werden soll.
-VirtualRouter	string	❌	VR	Der Name des Virtual Routers, zu dem das Target hinzugefügt wird.

Beispiele

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

Add-AESBTarget -VirtualRouter "MyRouter" -TargetType "Queue" -TargetName "MyTarget" -RoutingKey "MyKey"

Add-AESBTarget -VirtualRouter "AnotherRouter" -TargetType "Queue" -TargetName "AnotherTarget" -RoutingKey "AnotherKey" -ConnectionName "MyConnection"

Add-AESBVirtualRouter

Dieses Cmdlet wird verwendet, um einen neuen Virtual Router innerhalb der angegebenen SICS-Verbindung zu konfigurieren.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der Verbindung, in der der VirtualRouter hinzugefügt werden soll.
-VirtualRouter	string	❌	VR	Der Name des VirtualRouter, der hinzugefügt werden soll.

Beispiele

Beispiel 1: Hinzufügen eines Virtual Routers "MyRouter" in der Standardverbindung

Add-AESBVirtualRouter -VirtualRouter "MyRouter"

Beispiel 2: Hinzufügen eines Virtual Routers "AnotherRouter" in der SICS-Verbindung "MyConnection"

Add-AESBVirtualRouter -VirtualRouter "AnotherRouter" -ConnectionName "MyConnection"

ConvertFrom-AESBBase64

Dieses Cmdlet wird verwendet, um eine Base64-kodierte Zeichenfolge zurück in ihre unkodierte Form zu dekodieren.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Input	string	❌	In	Die Base64-kodierte Zeichenfolge, die dekodiert werden soll.

Beispiele

Beispiel 1: Dekodieren einer Base64-kodierten Zeichenfolge. Zurückgegeben wird der ursprüngliche Text "Hello World!"

ConvertFrom-AESBBase64 -Input "SGVsbG8gV29ybGQh"

Beispiel 2: Dekodieren einer Base64-Zeichenfolge aus der Variable $base64string. Zurückgegeben wird der ursprüngliche Text "Some base64 text"

$base64String = "U29tZSBiYXNlNjQgdGV4dA=="
ConvertFrom-AESBBase64 -Input $base64String

ConvertFrom-AESBBase64ToFile

Dieses Cmdlet wird verwendet, um eine Base64-kodierte Zeichenfolge zu dekodieren und in einer Datei zu speichern.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Input	string	❌	In	Die Base64-kodierte Zeichenfolge, die dekodiert werden soll.
-OutputPath	string	❌	None	Der Pfad inklusive Dateinamen, unter dem die dekodierten Daten gespeichert werden sollen.
-Force	switch	✅	F	Überschreibt die Datei am OutputPath, falls bereits eine Datei mit diesem Namen existiert.

Beispiele

Beispiel 1: Dekodieren einer Base64-Zeichenfolge und Speichern vom ursprünglichen Text "Hello World!" in der Datei "output.txt" im angegebenen Pfad

ConvertFrom-AESBBase64ToFile -Input "SGVsbG8gV29ybGQh" -OutputPath "C:\path\to\output.txt"

ConvertFrom-AESBBase64ToFile -Input "U29tZSBiYXNlNjQgdGV4dA==" -OutputPath "C:\path\to\output.txt" -Force

ConvertFrom-AESBIcql

Dieses Cmdlet wird verwendet, um eine AESB Icql-Zeichenfolge zurück in ein PowerShell-Objekt zu dekodieren.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Icql	string	❌	None	Die AESB Icql-Zeichenfolge, die dekodiert werden soll.

Beispiele

Beispiel 1: Dekodieren einer AESB Icql-Zeichenfolge aus der Variable $icqlString

Dabei wird das PSCustomObject mit folgenden Daten zurückgegeben:

1
2
3
4
5

TargetName     : MyTarget
TargetType     : Queue
RoutingKey     : MyRoutingKey
VirtualRouter : MyRouter
ConnectionName : MyConnection

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

ConvertTo-AESBBase64

Dieses Cmdlet wird verwendet, um eine Zeichenfolge in das Base64-Format zu konvertieren.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Input	string	❌	In	Die Zeichenfolge, die in Base64 kodiert werden soll.

Beispiele

Beispiel 1: Kodieren der Zeichenfolge "Hello World!" in Base64. Zurückgegeben wird die Base64-kodierte Version

ConvertTo-AESBBase64 -Input "Hello World!"
ConvertFrom-AESBIcql -Icql $icqlString

Beispiel 2: Kodieren der Zeichenfolge aus der Variable $string in Base64. Zurückgegeben wird die Base64-kodierte Zeichenfolge in der Variable $base64String

$string = "Base64 encoding example"
$base64String = ConvertTo-AESBBase64 -Input $string
$base64StringConvertFrom-AESBIcql -Icql $icqlString

ConvertTo-AESBBase64FromFile

Dieses Cmdlet wird verwendet, um den Inhalt einer Datei in eine Base64-kodierte Zeichenfolge zu konvertieren.

Parameter	Datentyp	Optional	Alias	Beschreibung
-InputPath	string	❌	InPath	Der Pfad zur Datei, deren Inhalt in Base64 kodiert werden soll.

Beispiele

Beispiel 1: Kodieren des Inhalts der Datei "file.txt" unter dem angegebenen Pfad in Base64. Zurückgegeben wird die Base64-kodierte Zeichenfolge

ConvertTo-AESBBase64FromFile -InputPath "C:\path\to\file.txt"

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

$filePath = "C:\path\to\anotherfile.txt"
$base64String = ConvertTo-AESBBase64FromFile -InputPath $filePath
$base64String

ConvertTo-AESBIcql

Dieses Cmdlet wird verwendet, um ein PowerShell-Objekt in das Icql-Format zu kodieren, das vom AESB verwendet wird.

Parameter	Datentyp	Optional	Alias	Beschreibung
-InputObject	psobject	❌	InObj	Das PSCustomObject, das in eine AESB Icql-Zeichenfolge konvertiert werden soll.

Beispiele

Beispiel 1: Konvertiert das PSCustomObject in eine AESB Icql-Zeichenfolge und gibt die resultierende Icql-Zeichenfolge zurück.

1
2
3
4
5
6
7
8
9
10
11
12

Get-AESBActivityLogItemById

Gibt den ActivityLog-Eintrag anhand einer ID zurück.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Id	string	❌		Die ID des Logeintrags

Beispiele

Beispiel 1: Abruf eines Log-Eintrags anhand einer ID

Get-AESBActivityLogItemById -Id "ItemID"

Get-AESBAliasList

Dieses Cmdlet wird verwendet, um eine Übersicht der im AESB gespeicherten Aliase zu erhalten.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der Verbindung, für die die Alias-Liste abgerufen werden soll.

Beispiele

Beispiel 1: Abrufen einer Liste aller Aliase im AESB, ohne Angabe einer speziellen Verbindung

Get-AESBAliasList

Beispiel 2: Abrufen einer Liste aller Aliase im AESB für die angegebene Verbindung "MyConnection"

Get-AESBAliasList -ConnectionName "MyConnection"

Get-AESBVirtualRouters

Gibt eine Liste aller VirtualRouter zurück.

Beispiele

Beispiel 1: Abrufen einer Liste aller VirtualRouter

Get-AESBVirtualRouters

Get-AESBAlias

Gibt alle Informationen zu einer Verbindung mit einem bestimmten Alias wieder.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Alias	string	❌		Gibt die Informationen zum angegebenen Alias wieder.

Beispiele

Beispiel 1: Abrufen der Informationen zur Verbindung mit dem Alias "AliasName"

Get-AESBAlias -Alias "AliasName"

Get-AESBConnectionInfo

Dieses Cmdlet wird verwendet, um Details über die Konfiguration und den Status einer Verbindung zu erhalten.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der Verbindung, für die Informationen abgerufen werden sollen.

Beispiele

Beispiel 1: Abrufen von Informationen zu allen verfügbaren Verbindungen im AESB

1
2
3
4
5
6
7

Beispiel 2: Abrufen der Informationen zur Verbindung "MyConnection"

Get-AESBAliasList -ConnectionName "MyConnection"

Get-AESBTargetMessageCount

Dieses Cmdlet wird verwendet, um die Anzahl der Nachrichten zu ermitteln, die sich derzeit im angegebenen Target befinden.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der Verbindung, für die die Zielnachrichtenzahl abgerufen werden soll.
-TargetName	string	❌	TName	Der Name des Targets, für das die Nachrichtenzahl abgerufen werden soll.
-VirtualRouter	string	❌	VR	Der Name des VirtualRouters, unter dem das Target läuft.

Beispiele

Beispiel 1: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem VirtualRouter "MyRouter"

Get-AESBTargetMessageCount -VirtualRouter "MyRouter" -TargetName "MyTarget"

Beispiel 2: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem VirtualRouter "MyRouter" und der Verbindung "MyConnection"

Get-AESBTargetMessageCount -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"

Get-AESBTargets

Dieses Cmdlet wird verwendet, um eine Übersicht der im AESB definierten Targets zu erhalten.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der Verbindung, für die die Liste der Targets abgerufen werden soll.
-VirtualRouter	string	❌	VR	Der Name des VirtualRouters, für den die Liste der Targets abgerufen werden soll.

Beispiele

Beispiel 1: Abrufen der Liste aller Targets unter dem VirtualRouter "MyRouter"

Get-AESBTargets -VirtualRouter "MyRouter"

Beispiel 2: Abrufen der Liste aller Targets für den VirtualRouter "MyRouter" und die Verbindung "MyConnection"

Get-AESBTargets -ConnectionName "MyConnection" -VirtualRouter "MyRouter"

Publish-AESBMessage

Dieses Cmdlet wird verwendet, um Nachrichten an die angegebenen Ziele oder Aliase zu senden.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Alias	string	❌	A	Der Name des Alias, an den die Nachricht veröffentlicht werden soll.
-ConnectionName	string	✅	C	Der Name der Verbindung, über die die Nachricht gesendet werden soll.
-Force	switch	✅	F	Zwingt die Veröffentlichung der Nachricht, auch wenn dies normalerweise nicht zulässig wäre.
-Message	Object	❌	M	Die Nachricht, die veröffentlicht werden soll.
-RoutingKey	string	❌	RK	Der RoutingKey, der für das Routing der Nachricht verwendet wird.
-VirtualRouter	string	❌	VR	Der Name des VirtualRouters, über den die Nachricht veröffentlicht werden soll.

Für die Parameter dieses Cmdlets wurden eigene Parameter-Sets definiert, die Sie verwenden können:

RoutingParameterSet - Message, VirtualRouter, RoutingKey
AliasParameterSet - Message, Alias

Beispiele

Beispiel 1: Senden der Nachricht "This is a test message" an den Alias "MyAlias" und wartet bis zu 5 Minuten auf eine Bestätigung

Publish-AESBMessageAndAwait -Alias "MyAlias" -Message "This is a test message" -Timeout "5m"

Beispiel 2: Senden der Nachricht "This is a test message" über den VirtualRouter "MyRouter" mit dem RoutingKey "MyRoutingKey" und wartet bis zu 1 Stunde auf eine Bestätigung

Publish-AESBMessageAndAwait -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey" -Message "This is a test message" -Timeout "1h"

Receive-AESBTargetMessages

Mit diesem Cmdlet werden Nachrichten von einem Ziel im AESB empfangen.

Parameter	Datentyp	Optional	Alias	Beschreibung
-ConnectionName	string	✅	C	Der Name der Verbindung zum AESB.
-MessageCount	int	✅	MC	Die Anzahl der Nachrichten, die empfangen werden sollen.
-TargetName	string	❌	TName	Der Name des Ziels, von dem die Nachrichten empfangen werden.
-VirtualRouter	string	❌	VR	Der Name des VirtualRouters, der für das Ziel verwendet wird.

Beispiele

Beispiel 1: Senden der Nachricht "This is a test message" an den Alias "MyAlias" und wartet bis zu 5 Minuten auf eine Bestätigung

Publish-AESBMessageAndAwait -Alias "MyAlias" -Message "This is a test message" -Timeout "5m"

Beispiel 2: Senden der Nachricht "This is a test message" über den VirtualRouter "MyRouter" mit dem RoutingKey "MyRoutingKey" und wartet bis zu 1 Stunde auf eine Bestätigung

Publish-AESBMessageAndAwait -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey" -Message "This is a test message" -Timeout "1h"

Remove-AESBAlias

Mit diesem Cmdlet wird ein Alias aus dem AESB entfernt.

Parameter	Datentyp	Optional	Alias	Beschreibung
-Alias	string	❌	A	Der Name des zu entfernenden Alias.
-ConnectionName	string	✅	C	Der Name der Verbindung zum AESB.

Beispiele

Beispiel 1: Entfernen vom Alias "MyAlias" aus dem AESB

Remove-AESBAlias -Alias "MyAlias"

Beispiel 2: Entfernen vom Alias "MyAlias" aus dem AESB über die angegebene Verbindung