Changes for page Operative Cmdlets

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

From 17.1 to 16.1 From 18.4 to 18.3

From version 18.3

edited by jklein
on 2024/12/16 14:02

Change comment: There is no comment for this version

To version 17.1

edited by jklein
on 2024/12/06 08:00

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -326,206 +326,22 @@
  = ConvertTo-AESBIcql =
--Dieses Cmdlet wird verwendet, um ein PowerShell-Objekt in das Icql-Format zu kodieren, das vom AESB verwendet wird.
--
--|=(% 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.
--
--=== **Beispiele** ===
--
--Beispiel 1: Konvertiert das PSCustomObject in eine AESB Icql-Zeichenfolge und gibt die resultierende Icql-Zeichenfolge 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}}
--
--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 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
--
--=== **Beispiele** ===
--
--Beispiel 1: Abruf eines Log-Eintrags anhand einer ID
--
--{{code language="powershell"}}
--Get-AESBActivityLogItemById -Id "ItemID"
--
--{{/code}}
--
  = Get-AESBAliasList =
--Dieses Cmdlet wird verwendet, um eine Übersicht der im AESB gespeicherten Aliase zu erhalten.
--
--|=(% 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 Alias-Liste abgerufen werden soll.
--
--=== **Beispiele** ===
--
--Beispiel 1: Abrufen einer Liste aller Aliase im AESB, ohne Angabe einer speziellen Verbindung
--
--{{code language="powershell"}}
--Get-AESBAliasList
--
--{{/code}}
--
--Beispiel 2: Abrufen einer Liste aller Aliase im AESB für die angegebene Verbindung "MyConnection"
--
--{{code language="powershell"}}
--Get-AESBAliasList -ConnectionName "MyConnection"
--
--{{/code}}
--
  = Get-AESBVirtualRouters =
--Gibt eine Liste aller VirtualRouter zurück.
--
--=== **Beispiele** ===
--
--Beispiel 1: Abrufen einer Liste aller VirtualRouter
--
--{{code language="powershell"}}
--Get-AESBVirtualRouters
--
--{{/code}}
--
  = Get-AESBAlias =
--Gibt alle Informationen zu einer Verbindung mit einem bestimmten Alias wieder.
--
--|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
--|-Alias|string|❌| |Gibt die Informationen zum angegebenen Alias wieder.
--
--=== **Beispiele** ===
--
--Beispiel 1: Abrufen der Informationen zur Verbindung mit dem Alias "AliasName"
--
--{{code language="powershell"}}
--Get-AESBAlias -Alias "AliasName"
--
--{{/code}}
--
  = Get-AESBConnectionInfo =
--Dieses Cmdlet wird verwendet, um Details über die Konfiguration und den Status einer Verbindung zu erhalten.
--
--|=(% 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 Informationen abgerufen werden sollen.
--
--=== **Beispiele** ===
--
--Beispiel 1: Abrufen von Informationen zu allen verfügbaren Verbindungen im AESB
--
--{{code language="powershell" layout="LINENUMBERS"}}
--Get-AESBConnectionInfo
--
--#Beispiel-Output:
--
-- EndPoint             VirtualRouter RoutingKey
----------             ------------- ----------
--wss://localhost:3950 SHELL         SICS.Aagon.Shell.local.a9857af7-bf81-44cd-8047-628956aad668
--{{/code}}
--
--Beispiel 2: Abrufen der Informationen zur Verbindung "MyConnection"
--
--{{code language="powershell"}}
--Get-AESBAliasList -ConnectionName "MyConnection"
--
--{{/code}}
--
  = Get-AESBTargetMessageCount =
--Dieses Cmdlet wird verwendet, um die Anzahl der Nachrichten zu ermitteln, die sich derzeit im angegebenen Target befinden.
--
--|=(% 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 VirtualRouters, unter dem das Target läuft.
--
--=== **Beispiele** ===
--
--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 VirtualRouter "MyRouter" und der Verbindung "MyConnection"
--
--{{code language="powershell"}}
--Get-AESBTargetMessageCount -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"
--
--{{/code}}
--
  = Get-AESBTargets =
--Dieses Cmdlet wird verwendet, um eine Übersicht der im AESB definierten Targets zu erhalten.
--
--|=(% 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 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"
--
--{{code language="powershell"}}
--Get-AESBTargets -VirtualRouter "MyRouter"
--
--{{/code}}
--
--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"
--
--{{/code}}
--
  = Publish-AESBMessage =
-- Dieses Cmdlet wird verwendet, um Nachrichten an die angegebenen Ziele oder Aliase zu senden.
--
--|=(% 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 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.
--
--
--
--
  = Publish-AESBMessageAndAwait =
  = Receive-AESBTargetMessages =