Skip to Content

Operative Cmdlets

Last modified by jklein on 2025/08/06 13:00
Content

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.

Hinweis  Note:  

Falls bei der AusfĂŒhrung eines Cmdlets mit ausschließlich optionalen Parametern keine Parameter angegeben werden, wird immer die Standardverbindung mit dem standardmĂ€ĂŸigen Parameter-Set genutzt.

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 DatentypErforderlichAliasBeschreibung
-AliasString✅KeineDer Name des Alias, der dem Qualified Name Service (QNS) hinzugefĂŒgt werden soll.
-ConnectionNameString❌KeineDer 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 DatentypErforderlichAliasBeschreibung
-ConnectionNameString❌KeineDer 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.
-VirtualRouterString✅KeineDer Name des Virtual Routers, dem das Callback-Target zugeordnet werden soll.
-TargetNameString✅KeineDer Name des Callback-Targets, das hinzugefĂŒgt werden soll.
-RoutingKeyString✅KeineDer 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 DatentypErforderlichAliasBeschreibung
-ConnectionNameString❌KeineDer 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.
-VirtualRouterString✅KeineDer Name des Virtual Routers, dem das Queue-Target zugeordnet wird.
-TargetNameString✅KeineDer Name des Queue-Targets, das hinzugefĂŒgt werden soll.
-RoutingKeyString✅KeineDer 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 DatentypErforderlichAliasBeschreibung
-ConnectionNamestring❌CDer Name der SICS-Verbindung, fĂŒr die der Routing Key hinzugefĂŒgt werden soll.
-VirtualRouterstring✅VRDer Name des Virtual Router, zu dem der Routing Key gehört.
-TargetNamestring✅TNameDer Name des Targets, fĂŒr das der Routing Key hinzugefĂŒgt wird.
-RoutingKeystring✅RKDer 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 DatentypErforderlichAliasBeschreibung
-Aliasstring✅ADer Alias, zu dem das Routing-Paar im QNS hinzugefĂŒgt werden soll.
-ConnectionNamestring❌CDer Name der SICS-Verbindung, fĂŒr die das Routing-Paar hinzugefĂŒgt werden soll.
-RoutingKeystring✅RKDer Name des Routing Keys, der zusammen mit dem Virtual Router hinzugefĂŒgt werden soll.
-VirtualRouterstring✅VRDer 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 DatentypErforderlichAliasBeschreibung
-ConnectionNamestring❌CDer Name der SICS-Verbindung, fĂŒr die das Target hinzugefĂŒgt werden soll.
-RoutingKeystring✅RKDer Routing Key, der dem Target zugewiesen wird.
-TargetNamestring✅TNameDer Name des Targets, das hinzugefĂŒgt werden soll.
-TargetTypestring✅TTypeDer Typ des Targets, das hinzugefĂŒgt werden soll.
-VirtualRouterstring✅VRDer 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 DatentypErforderlichAliasBeschreibung
-ConnectionNamestring❌CDer Name der Verbindung, in der der VirtualRouter hinzugefĂŒgt werden soll.
-VirtualRouterstring✅VRDer 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 DatentypErforderlichAliasBeschreibung
-Inputstring✅InDie 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 DatentypErforderlichAliasBeschreibung
-Inputstring✅InDie Base64-kodierte Zeichenfolge, die dekodiert werden soll.
-OutputPathstring✅NoneDer Pfad inklusive Dateinamen, unter dem die dekodierten Daten gespeichert werden sollen.
-Forceswitch❌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 DatentypErforderlichAliasBeschreibung
-Icqlstring✅NoneDie 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 DatentypErforderlichAliasBeschreibung
-Inputstring✅InDie 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 DatentypErforderlichAliasBeschreibung
-InputPathstring✅InPathDer 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 DatentypErforderlichAliasBeschreibung
-InputObjectpsobject✅InObjDas PSCustomObject, das in eine AESB Icql-Zeichenfolge konvertiert werden soll.
-Sequencestring❌ Setzt die Sequence einer ICQL Message
-Actionstring❌ Setzt die Action einer ICQL Message

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
# Erstellen eines PSCustomObject mit Beispieldaten
$exampleObject = [PSCustomObject]@{
    TargetName    = "MyTarget"
    TargetType    = "Queue"
    RoutingKey    = "MyRoutingKey"
    VirtualRouter = "MyRouter"
    ConnectionName = "MyConnection"
}

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

Get-AESBActivityLogItemById

Gibt den Activity Log-Eintrag anhand einer ID zurĂŒck.

Parameter DatentypErforderlichAliasBeschreibung
-Idstring✅ 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 DatentypErforderlichAliasBeschreibung
-ConnectionNamestring❌CDer 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 Virtual Router zurĂŒck.

Beispiele

Beispiel 1: Abrufen einer Liste aller Virtual Router

Get-AESBVirtualRouters

Get-AESBAlias

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

Parameter DatentypErforderlichAliasBeschreibung
-Aliasstring✅ 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 DatentypErforderlichAliasBeschreibung
-ConnectionNamestring❌CDer 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 DatentypErforderlichAliasBeschreibung
-ConnectionNamestring❌CDer Name der Verbindung, fĂŒr die die Zielnachrichtenzahl abgerufen werden soll.
-TargetNamestring✅TNameDer Name des Targets, fĂŒr das die Nachrichtenzahl abgerufen werden soll.
-VirtualRouterstring✅VRDer Name des Virtual Routers, unter dem das Target lĂ€uft.

Beispiele

Beispiel 1: Abrufen der Anzahl der Nachrichten fĂŒr das Target "MyTarget" unter dem Virtual Router "MyRouter"

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

Beispiel 2: Abrufen der Anzahl der Nachrichten fĂŒr das Target "MyTarget" unter dem Virtual Router "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 DatentypErforderlichAliasBeschreibung
-ConnectionNamestring❌CDer Name der Verbindung, fĂŒr die die Liste der Targets abgerufen werden soll.
-VirtualRouterstring✅VRDer Name des VirtualRouters, fĂŒr den die Liste der Targets abgerufen werden soll.

Beispiele

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

Get-AESBTargets -VirtualRouter "MyRouter"

Beispiel 2: Abrufen der Liste aller Targets fĂŒr den Virtual Router "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 DatentypErforderlichAliasBeschreibung
-Aliasstring✅ADer Name des Alias, an den die Nachricht veröffentlicht werden soll.
-ConnectionNamestring❌CDer Name der Verbindung, ĂŒber die die Nachricht gesendet werden soll.
-Forceswitch❌FZwingt die Veröffentlichung der Nachricht, auch wenn dies normalerweise nicht zulĂ€ssig wĂ€re.
-MessageObject✅MDie Nachricht, die veröffentlicht werden soll.
-RoutingKeystring✅RKDer RoutingKey, der fĂŒr das Routing der Nachricht verwendet wird.
-VirtualRouterstring✅VRDer Name des VirtualRouters, ĂŒber den die Nachricht veröffentlicht werden soll.

Parameter-Sets

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 Virtual Router "MyRouter" mit dem Routing Key "MyRoutingKey"

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

Beispiel 3: Konvertieren eines PSCustomObject in das ICQL-Format und senden der Nachricht an den Alias "MyAlias"

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

Publish-AESBMessageAndAwait

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.

Parameter DatentypErforderlichAliasBeschreibung
-Aliasstring✅ADer Name des Alias, an den die Nachricht veröffentlicht werden soll.
-ConnectionNamestring❌CDer Name der Verbindung, ĂŒber die die Nachricht gesendet werden soll.
-Forceswitch❌FZwingt die Veröffentlichung der Nachricht, auch wenn dies normalerweise nicht zulĂ€ssig wĂ€re.
-MessageObject✅MDie Nachricht, die veröffentlicht werden soll.
-RoutingKeystring✅RKDer Routing Key, der fĂŒr das Routing der Nachricht verwendet wird.
-Timeoutstring❌TDie 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.
-VirtualRouterstring✅VRDer Name des Virtual Routers, ĂŒber den die Nachricht veröffentlicht werden soll.

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 Virtual Router "MyRouter" mit dem Routing Key "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 können Sie Nachrichten von einem Ziel im AESB empfangen.

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNamestring❌CDer Name der Verbindung zum AESB.
-MessageCountint❌MCDie Anzahl der Nachrichten, die empfangen werden sollen.
-TargetNamestring✅TNameDer Name des Ziels, von dem die Nachrichten empfangen werden.
-VirtualRouterstring✅VRDer Name des Virtual Routers, der fĂŒr das Ziel verwendet wird.

Beispiele

Beispiel 1: Empfangen von Nachrichten vom Ziel mit dem Namen "MyTarget", das dem Virtual Router "MyRouter" zugeordnet ist

Receive-AESBTargetMessages -VirtualRouter "MyRouter" -TargetName "MyTarget"

Beispiel 2: Empfangen von bis zu 10 Nachrichten vom Ziel mit dem Namen "MyTarget", das dem Virtual Router "MyRouter" zugeordnet ist

Receive-AESBTargetMessages -VirtualRouter "MyRouter" -TargetName "MyTarget" -MessageCount 10

Remove-AESBAlias

Mit diesem Cmdlet können Sie einen Alias aus dem AESB entfernen.

Parameter DatentypErforderlichAliasBeschreibung
-Aliasstring✅ADer Name des zu entfernenden Alias.
-ConnectionNamestring❌CDer 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

Remove-AESBAlias -ConnectionName "MyConnection" -Alias "MyAlias"

Remove-AESBRoutingFromAlias

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.

Parameter DatentypErforderlichAliasBeschreibung
-Aliasstring✅ADer Name des Alias, von dem das Routing-Paar entfernt werden soll.
-ConnectionNamestring❌CDer Name der Verbindung, die verwendet wird.
-RoutingKeystring✅RKDer Routing Key, der aus dem Alias entfernt werden soll.
-VirtualRouterstring✅VRDer Virtual Router, der zusammen mit dem Routing Key entfernt werden soll.

Beispiele

Beispiel 1: Entfernen vom Routing-Paar mit Virtual Router "MyRouter" und Routing Key "MyRoutingKey" vom Alias "MyAlias"

Remove-AESBRoutingFromAlias -Alias "MyAlias" -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey"

Beispiel 2: Entfernen vom Routing-Paar mit Virtual Router "MyRouter" und Routing Key "MyRoutingKey" vom Alias "MyAlias" unter Verwendung der Verbindung "MyConnection"

Remove-AESBRoutingFromAlias -Alias "MyAlias" -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey"

Remove-AESBRoutingKey

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.

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNamestring❌CDer Name der Verbindung, die verwendet werden soll.
-VirtualRouterstring✅VRDer Name des Virtual Routers, von dem der Routing Key entfernt werden soll.
-TargetNamestring✅TNameDer Name des Ziels, von dem der Routing Key entfernt werden soll.
-RoutingKeystring✅RKDer Routing Key, der entfernt werden soll.

Beispiele

Beispiel 1: Entfernen vom Routing Key "MyRoutingKey" vom Ziel "MyTarget" im Virtual Router "MyRouter"

Remove-AESBRoutingKey -VirtualRouter "MyRouter" -TargetName "MyTarget" -RoutingKey "MyRoutingKey"

Beispiel 2: Entfernen vom Routing Key "MyRoutingKey" vom Ziel "MyTarget" im Virtual Router "MyRouter" unter Verwendung der Verbindung "MyConnection"

Remove-AESBRoutingKey -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget" -RoutingKey "MyRoutingKey"

Remove-AESBTarget

Mit diesem Cmdlet können Sie ein Ziel aus dem Virtual Router des AESB entfernen.

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNamestring❌CDer Name der Verbindung zum AESB.
-VirtualRouterstring✅VRDer Name des Virtual Routers, von dem das Ziel entfernt werden soll.
-TargetNamestring✅TNameDer Name des Ziels, das entfernt werden soll.

Beispiele

Beispiel 1: Entfernen vom Ziel "MyTarget" vom Virtual Router "MyRouter"

Remove-AESBTarget -VirtualRouter "MyRouter" -TargetName "MyTarget"

Beispiel 2: Entfernen vom Ziel "MyTarget" vom Virtual Router "MyRouter" unter Verwendung der Verbindung "MyConnection"

Remove-AESBTarget -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"

Remove-AESBVirtualRouter

Mit diesem Cmdlet können Sie einen angegebenen Virtual Router entfernen.

Parameter DatentypErforderlichAliasBeschreibung
ConnectionNamestring❌CGibt den Namen der Verbindung an.
VirtualRouterstring✅VRGibt den Namen des zu entfernenden Virtual Router an.

Beispiele

Beispiel 1: Entfernen vom Virtual Router mit dem Namen "MyRouter"

Remove-AESBVirtualRouter -VirtualRouter "MyRouter"

Beispiel 2: Entfernen vom Virtual Router mit dem Namen "MyRouter" unter der Verbindung "MyConnection"

Remove-AESBVirtualRouter -ConnectionName "MyConnection" -VirtualRouter "MyRouter"

Set-AESBBSelfAsAlias

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.

Warning  Warning:  

Die Parameter RemoveExistingAlias und AddToExistingAlias dĂŒrfen nicht gleichzeitig verwendet werden!

Parameter

Parameter DatentypErforderlichAliasBeschreibung
-Aliasstring✅ Gibt den Namen vom Alias an
-RemoveExistingAliasbool❌ Der bestehende Alias wird ersetzt.
-AddToExistingAliasbool❌ Der Virtual Router und Routing Key wird zu dem angegebenen Alias hinzugefĂŒgt

Beispiele

Beispiel 1: Überschreiben vom existierenden Alias „AliasName“. Wenn z.B. der vorherige Alias mehrere Virtual Router und Routing Keys hatte, werden diese gelöscht

Set-AESBSelfAsAlias -Alias "AliasName" -RemoveExistingAlias $true

Beispiel 2: HinzufĂŒgen der Virtual Router und Routing Keys vom Alias „AliasName“ zum angegebenen Alias "SelfAliasTest".

Set-AESBSelfAsAlias -Alias "AliasName" -AddToExistingAlias "SelfAliasTest"

Show-AESBRoutingTable

Dieses Cmdlet zeigt die Routing-Tabelle fĂŒr den angegebenen Virtual Router an. Mit den Parametern ist es möglich, die angezeigten Daten weiter einzuschrĂ€nken.

Parameter

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNamestring❌CDer Name der Verbindung, die fĂŒr das Abrufen der Routing-Tabelle verwendet wird.
-ExchangeTypeExchangeTypes❌ETDer Typ des Exchanges, der angezeigt werden soll. Mögliche Werte sind DIRECT oder ROUTING.
-VirtualRouterstring✅VRDer Name des Virtual Routers, fĂŒr den die Routing-Tabelle angezeigt wird.

Beispiele

Beispiel 1: Anzeigen der Routing-Tabelle fĂŒr den Virtual Router „MyRouter“

Show-AESBRoutingTable -VirtualRouter "MyRouter"

Beispiel 2: Anzeigen der Routing-Tabelle fĂŒr den Virtual Router „MyRouter“ an, wobei nur EintrĂ€ge vom Typ „DIRECT“ angezeigt werden. Die Verbindung „MyConnection“ wird verwendet.

Show-AESBRoutingTable -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -ExchangeType DIRECT

Write-AESBActivityLog

Mit diesem Cmdlet wird ein Eintrag in das ActivityLog des AESB geschrieben. Wenn keine ID angegeben wird, wird ein neuer Log-Eintrag erstellt. Falls eine ID angegeben wird, wird der vorhandene Log-Eintrag mit dieser ID aktualisiert.

Parameter

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNamestring❌CDer Name der Verbindung, die fĂŒr die Kommunikation verwendet wird.
-Idstring❌NoneDie ID des Log-Eintrags, der aktualisiert werden soll. Wird ein neuer Eintrag erstellt, kann dieser Parameter weggelassen werden.
-Namestring✅NDer Name des Log-Eintrags.
-Descriptionstring✅DDie Beschreibung des Log-Eintrags.
-StatusJobFeedbackResultCode✅STDer Status des Logs, z.B. "Warning", "Created", "Started", "Running", "Stopping", "Stopped", "Failed" oder "Finished".
-ComponentNamestring❌ComNameDer Name der Komponente, die den Log-Eintrag erstellt hat.

Beispiele

Beispiel 1: Erstellen eines neuen Log-Eintrags. Der Eintrag erhÀlt den Namen "ProcessStart", die Beschreibung "Der Prozess wurde gestartet" und den Status "Started". Da keine ID angegeben ist, wird ein neuer Log-Eintrag erstellt.

Write-AESBActivityLog -Name "ProcessStart" -Description "Der Prozess wurde gestartet." -Status Started

Beispiel 2: Aktualisieren eines vorhandenen Log-Eintrags mit der ID "12345". Der Log-Eintrag wird auf den Namen "ProcessUpdate", die Beschreibung "Der Prozessstatus wurde aktualisiert" und den Status "Running" gesetzt. Die ID wird verwendet, um den spezifischen Eintrag zu finden und zu aktualisieren.

Write-AESBActivityLog -Id "12345" -Name "ProcessUpdate" -Description "Der Prozessstatus wurde aktualisiert." -Status Running

Write-AESBBusinessLog

Mit diesem Cmdlet wird eine Nachricht in das Business-Log des AESB geschrieben. Jeder Aufruf des Cmdlets erzeugt immer einen neuen Log-Eintrag.

Hinweis  Note:  

Das BusinessLog dient zur Information ĂŒber ProzessablĂ€ufe und -ergebnisse durch aussagekrĂ€ftige Benachrichtigungen. Daher ist es nicht möglich, Objekte in der Nachricht des BusinessLogs auszugeben.

Parameter

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNamestring❌CDer Name der Verbindung zum AESB.
-IsErrorbool❌IsErrGibt an, ob die Nachricht als Fehler protokolliert wird.
-Messagestring✅MDie zu protokollierende Nachricht.
-ComponentIdstring❌CIdDie ID des Komponenten.
-ComponentNamestring❌ComNameDer Name des Komponenten.
-ComponentPartstring❌ComPartDer Teil des Komponenten.
-HostIdstring❌HIdDie ID des Hosts.
-HostNamestring❌HNDer Name des Hosts.
-Contextstring❌CTDer Kontext der Nachricht.

Beispiele

Beispiel 1: Erstellen eines neuen Log-Eintrags im Business-Log mit der Nachricht "System started successfully". Der Log-Eintrag wird dem Komponenten-Namen "MyComponent" und dem Kontext "Initialization" zugeordnet.

Write-AESBBusinessLog -Message "System started successfully" -ComponentName "MyComponent" -Context "Initialization"

Beispiel 2: Erstellen eines neuen Log-Eintrag im Business-Log, der als Fehler gekennzeichnet ist. Die Nachricht "Error connecting to database" wird dem Komponenten-ID "DBComponent" und dem Host-Namen "Server01" zugeordnet.

Write-AESBBusinessLog -IsError $true -Message "Error connecting to database" -ComponentId "DBComponent" -HostName "Server01"

 

© Aagon GmbH 2026
Besuchen Sie unsere aagon-Community