Changes for page Operative Cmdlets

Last modified by jklein on 2025/01/10 07:49

From 21.1 to 20.1 From 25.1 to 24.1

From version 24.1

edited by jklein
on 2024/12/18 10:34

Change comment: There is no comment for this version

To version 21.1

edited by jklein
on 2024/12/16 15:00

Change comment: Zurück zur Version 18.3

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -330,8 +330,6 @@
  |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
  |-InputObject|psobject|❌|InObj|Das PSCustomObject, das in eine AESB Icql-Zeichenfolge konvertiert werden soll.
--|-Sequence|string|✅| |Setzt die Sequence einer ICQL Message
--|-Action|string|✅| |Setzt die Action einer ICQL Message
  === **Beispiele** ===
@@ -352,9 +352,26 @@
  $icqlString
  {{/code}}
++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.
++
++{{code language="powershell" layout="LINENUMBERS"}}
++# 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
++{{/code}}
++
  = Get-AESBActivityLogItemById =
--Gibt den Activity Log-Eintrag anhand einer ID zurück.
++Gibt den ActivityLog-Eintrag anhand einer ID zurück.
  |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
  |-Id|string|❌| |Die ID des Logeintrags
@@ -393,11 +393,11 @@
  = Get-AESBVirtualRouters =
--Gibt eine Liste aller Virtual Router zurück.
++Gibt eine Liste aller VirtualRouter zurück.
  === **Beispiele** ===
--Beispiel 1: Abrufen einer Liste aller Virtual Router
++Beispiel 1: Abrufen einer Liste aller VirtualRouter
  {{code language="powershell"}}
  Get-AESBVirtualRouters
@@ -455,17 +455,17 @@
  |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)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 Virtual Routers, unter dem das Target läuft.
++|-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 Virtual Router "MyRouter"
++Beispiel 1: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem VirtualRouter "MyRouter"
  {{code language="powershell"}}
  Get-AESBTargetMessageCount -VirtualRouter "MyRouter" -TargetName "MyTarget"
  {{/code}}
--Beispiel 2: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem Virtual Router "MyRouter" und der Verbindung "MyConnection"
++Beispiel 2: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem VirtualRouter "MyRouter" und der Verbindung "MyConnection"
  {{code language="powershell"}}
  Get-AESBTargetMessageCount -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"
@@ -482,7 +482,7 @@
  === **Beispiele** ===
--Beispiel 1: Abrufen der Liste aller Targets unter dem Virtual Router "MyRouter"
++Beispiel 1: Abrufen der Liste aller Targets unter dem VirtualRouter "MyRouter"
  {{code language="powershell"}}
  Get-AESBTargets -VirtualRouter "MyRouter"
@@ -489,7 +489,7 @@
  {{/code}}
--Beispiel 2: Abrufen der Liste aller Targets für den Virtual Router "MyRouter" und die Verbindung "MyConnection"
++Beispiel 2: Abrufen der Liste aller Targets für den VirtualRouter "MyRouter" und die Verbindung "MyConnection"
  {{code language="powershell"}}
  Get-AESBTargets -ConnectionName "MyConnection" -VirtualRouter "MyRouter"
@@ -508,302 +508,27 @@
  |-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.
--=== 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"
--
--{{code language="powershell"}}
--Publish-AESBMessage -Alias "MyAlias" -Message "This is a test message"
--
--{{/code}}
--
--Beispiel 2: Senden der Nachricht "This is a test message" über den Virtual Router "MyRouter" mit dem Routing Key "MyRoutingKey"
--
--{{code language="powershell"}}
--Publish-AESBMessage -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey" -Message "This is a test message"
--
--{{/code}}
--
--Beispiel 3: Konvertieren eines PSCustomObject in das ICQL-Format und senden der Nachricht an den Alias "MyAlias"
--
--{{code language="powershell"}}
--ConvertTo-AESBIcql $exampleObject | Publish-AESBMessage -Alias "MyAlias"
--
--{{/code}}
--
  = 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.
--
--|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)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 Routing Key, 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 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
--
--{{code language="powershell"}}
--Publish-AESBMessageAndAwait -Alias "MyAlias" -Message "This is a test message" -Timeout "5m"
--
--{{/code}}
--
--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.
--
--{{code language="powershell"}}
--Publish-AESBMessageAndAwait -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey" -Message "This is a test message" -Timeout "1h"
--
--{{/code}}
--
  = Receive-AESBTargetMessages =
--Mit diesem Cmdlet können Sie Nachrichten von einem Ziel im AESB empfangen.
--
--|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)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 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
--
--{{code language="powershell"}}
--Receive-AESBTargetMessages -VirtualRouter "MyRouter" -TargetName "MyTarget"
--
--{{/code}}
--
--Beispiel 2: Empfangen von bis zu 10 Nachrichten vom Ziel mit dem Namen "MyTarget", das dem Virtual Router "MyRouter" zugeordnet ist
--
--{{code language="powershell"}}
--Receive-AESBTargetMessages -VirtualRouter "MyRouter" -TargetName "MyTarget" -MessageCount 10
--
--{{/code}}
--
  = Remove-AESBAlias =
--Mit diesem Cmdlet können Sie einen Alias aus dem AESB entfernen.
--
--|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)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
--
--{{code language="powershell"}}
--Remove-AESBAlias -Alias "MyAlias"
--
--{{/code}}
--
--Beispiel 2: Entfernen vom Alias "MyAlias" aus dem AESB über die angegebene Verbindung
--
--{{code language="powershell"}}
--Remove-AESBAlias -ConnectionName "MyConnection" -Alias "MyAlias"
--
--{{/code}}
--
  = 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.
--
--|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
--|-Alias|string|❌|A|Der Name des Alias, von dem das Routing-Paar entfernt werden soll.
--|-ConnectionName|string|✅|C|Der Name der Verbindung, die verwendet wird.
--|-RoutingKey|string|❌|RK|Der Routing Key, der aus dem Alias entfernt werden soll.
--|-VirtualRouter|string|❌|VR|Der 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"
--
--{{code language="powershell"}}
--Remove-AESBRoutingFromAlias -Alias "MyAlias" -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey"
--
--{{/code}}
--
--Beispiel 2: Entfernen vom Routing-Paar mit Virtual Router "MyRouter" und Routing Key "MyRoutingKey" vom Alias "MyAlias" unter Verwendung der Verbindung "MyConnection"
--
--{{code language="powershell"}}
--Remove-AESBRoutingFromAlias -Alias "MyAlias" -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey"
--
--{{/code}}
--
  = 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.
--
--|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
--|-ConnectionName|string|✅|C|Der Name der Verbindung, die verwendet werden soll.
--|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, von dem der Routing Key entfernt werden soll.
--|-TargetName|string|❌|TName|Der Name des Ziels, von dem der Routing Key entfernt werden soll.
--|-RoutingKey|string|❌|RK|Der Routing Key, der entfernt werden soll.
--
--=== **Beispiele** ===
--
--Beispiel 1: Entfernen vom Routing Key "MyRoutingKey" vom Ziel "MyTarget" im Virtual Router "MyRouter"
--
--{{code language="powershell"}}
--Remove-AESBRoutingKey -VirtualRouter "MyRouter" -TargetName "MyTarget" -RoutingKey "MyRoutingKey"
--
--{{/code}}
--
--Beispiel 2: Entfernen vom Routing Key "MyRoutingKey" vom Ziel "MyTarget" im Virtual Router "MyRouter" unter Verwendung der Verbindung "MyConnection"
--
--{{code language="powershell"}}
--Remove-AESBRoutingKey -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget" -RoutingKey "MyRoutingKey"
--
--{{/code}}
--
  = Remove-AESBTarget =
--Mit diesem Cmdlet können Sie ein Ziel aus dem Virtual Router des AESB entfernen.
--
--|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
--|-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
--|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, von dem das Ziel entfernt werden soll.
--|-TargetName|string|❌|TName|Der Name des Ziels, das entfernt werden soll.
--
--=== **Beispiele** ===
--
--Beispiel 1: Entfernen vom Ziel "MyTarget" vom Virtual Router "MyRouter"
--
--{{code language="powershell"}}
--Remove-AESBTarget -VirtualRouter "MyRouter" -TargetName "MyTarget"
--{{/code}}
--
--Beispiel 2: Entfernen vom Ziel "MyTarget" vom Virtual Router "MyRouter" unter Verwendung der Verbindung "MyConnection"
--
--{{code language="powershell"}}
--Remove-AESBTarget -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"
--{{/code}}
--
  = Remove-AESBVirtualRouter =
--Mit diesem Cmdlet können Sie einen angegebenen Virtual Router entfernen.
--
--|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
--|ConnectionName|string|✅|C|Gibt den Namen der Verbindung an.
--|VirtualRouter|string|❌|VR|Gibt den Namen des zu entfernenden Virtual Router an.
--
--=== **Beispiele** ===
--
--Beispiel 1: Entfernen vom Virtual Router mit dem Namen "MyRouter"
--
--{{code language="powershell"}}
--Remove-AESBVirtualRouter -VirtualRouter "MyRouter"
--
--{{/code}}
--
--Beispiel 2: Entfernen vom Virtual Router mit dem Namen "MyRouter" unter der Verbindung "MyConnection"
--
--{{code language="powershell"}}
--Remove-AESBVirtualRouter -ConnectionName "MyConnection" -VirtualRouter "MyRouter"
--{{/code}}
--
  = 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.
--
--{{aagon.warnungsbox}}
--Die Parameter RemoveExistingAlias und AddToExistingAlias dürfen nicht gleichzeitig verwendet werden!
--{{/aagon.warnungsbox}}
--
--**Parameter**
--
--|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
--|-Alias|string|❌| |Gibt den Namen vom Alias an
--|-RemoveExistingAlias|bool|✅| |Der bestehende Alias wird ersetzt.
--|-AddToExistingAlias|bool|✅| |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
--
--{{code language="powershell"}}
--Set-AESBSelfAsAlias -Alias "AliasName" -RemoveExistingAlias $true
--
--{{/code}}
--
--Beispiel 2: Hinzufügen der Virtual Router und Routing Keys vom Alias „AliasName“ zum angegebenen Alias "SelfAliasTest".
--
--{{code language="powershell"}}
--Set-AESBSelfAsAlias -Alias "AliasName" -AddToExistingAlias "SelfAliasTest"
--{{/code}}
--
  = 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**
--
--|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
--|-ConnectionName|string|✅|C|Der Name der Verbindung, die für das Abrufen der Routing-Tabelle verwendet wird.
--|-ExchangeType|ExchangeTypes|✅|ET|Der Typ des Exchanges, der angezeigt werden soll. Mögliche Werte sind DIRECT oder ROUTING.
--|-VirtualRouter|string|❌|VR|Der 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“
--
--{{code language="powershell"}}
--Show-AESBRoutingTable -VirtualRouter "MyRouter"
--
--{{/code}}
--
--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.
--
--{{code language="powershell"}}
--Show-AESBRoutingTable -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -ExchangeType DIRECT
--
--{{/code}}
--
  = 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**
--
--|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
--|-ConnectionName|string|✅|C|Der Name der Verbindung, die für die Kommunikation verwendet wird.
--|-Id|string|✅|None|Die ID des Log-Eintrags, der aktualisiert werden soll. Wird ein neuer Eintrag erstellt, kann dieser Parameter weggelassen werden.
--|-Name|string|❌|N|Der Name des Log-Eintrags.
--|-Description|string|❌|D|Die Beschreibung des Log-Eintrags.
--|-Status|JobFeedbackResultCode|❌|ST|Der Status des Logs, z.B. "Warning", "Created", "Started", "Running", "Stopping", "Stopped", "Failed" oder "Finished".
--|-ComponentName|string|✅|ComName|Der 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.
--
--{{code language="powershell"}}
--Write-AESBActivityLog -Name "ProcessStart" -Description "Der Prozess wurde gestartet." -Status Started
--{{/code}}
--
--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.
--
--{{code language="powershell"}}
--Write-AESBActivityLog -Id "12345" -Name "ProcessUpdate" -Description "Der Prozessstatus wurde aktualisiert." -Status Running
--
--{{/code}}
--
  = Write-AESBBusinessLog =