Operative Cmdlets

Version 16.1 von jklein am 2024/12/05 12:57
Inhalt

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 DatentypOptionalAliasBeschreibung
-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 DatentypOptionalAliasBeschreibung
-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 DatentypOptionalAliasBeschreibung
-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 DatentypOptionalAliasBeschreibung
-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 DatentypOptionalAliasBeschreibung
-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 DatentypOptionalAliasBeschreibung
-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 DatentypOptionalAliasBeschreibung
-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 DatentypOptionalAliasBeschreibung
-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 DatentypOptionalAliasBeschreibung
-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 DatentypOptionalAliasBeschreibung
-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 DatentypOptionalAliasBeschreibung
-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

ConvertTo-AESBIcql

Get-AESBActivityLogItemById

Get-AESBAliasList

Get-AESBVirtualRouters

Get-AESBAlias

Get-AESBConnectionInfo

Get-AESBTargetMessageCount

Get-AESBTargets

Publish-AESBMessage

Publish-AESBMessageAndAwait

Receive-AESBTargetMessages

Remove-AESBAlias

Remove-AESBRoutingFromAlias

Remove-AESBRoutingKey

Remove-AESBTarget

Remove-AESBVirtualRouter

Set-AESBBSelfAsAlias

Show-AESBRoutingTable

Write-AESBActivityLog

Write-AESBBusinessLog

© Aagon GmbH 2025
Besuchen Sie unsere neue Aagon-Community