Changes for page Operative Cmdlets

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

From 14.1 to 15.1 From 18.3 to 18.4

From version 15.1

edited by jklein
on 2024/12/04 15:21

Change comment: There is no comment for this version

To version 18.3

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -206,30 +206,326 @@
  = ConvertFrom-AESBBase64ToFile =
++Dieses Cmdlet wird verwendet, um eine Base64-kodierte Zeichenfolge zu dekodieren und in einer Datei zu speichern.
++
++|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)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
++
++{{code language="powershell"}}
++ConvertFrom-AESBBase64ToFile -Input "SGVsbG8gV29ybGQh" -OutputPath "C:\path\to\output.txt"
++
++{{/code}}
++
++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
++
++{{code language="powershell"}}
++ConvertFrom-AESBBase64ToFile -Input "U29tZSBiYXNlNjQgdGV4dA==" -OutputPath "C:\path\to\output.txt" -Force
++{{/code}}
++
  = ConvertFrom-AESBIcql =
++Dieses Cmdlet wird verwendet, um eine AESB Icql-Zeichenfolge zurück in ein PowerShell-Objekt zu dekodieren.
++
++|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
++|-Icql|string|❌|None|Die AESB Icql-Zeichenfolge, die dekodiert werden soll.
++
++=== **Beispiele** ===
++
++Beispiel 1: Dekodieren einer AESB Icql-Zeichenfolge aus der Variable $icqlString
++
++{{code language="powershell"}}
++$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
++{{/code}}
++
++Dabei wird das PSCustomObject mit folgenden Daten zurückgegeben:
++
++{{code language="none" layout="LINENUMBERS"}}
++TargetName     : MyTarget
++TargetType     : Queue
++RoutingKey     : MyRoutingKey
++VirtualRouter  : MyRouter
++ConnectionName : MyConnection
++{{/code}}
++
++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
++
++{{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
++$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
++{{/code}}
++
  = ConvertTo-AESBBase64 =
++Dieses Cmdlet wird verwendet, um eine Zeichenfolge in das Base64-Format zu konvertieren.
++
++|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)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
++
++{{code language="powershell"}}
++ConvertTo-AESBBase64 -Input "Hello World!"
++ConvertFrom-AESBIcql -Icql $icqlString
++{{/code}}
++
++Beispiel 2: Kodieren der Zeichenfolge aus der Variable $string in Base64. Zurückgegeben wird die Base64-kodierte Zeichenfolge in der Variable $base64String
++
++{{code language="powershell"}}
++$string = "Base64 encoding example"
++$base64String = ConvertTo-AESBBase64 -Input $string
++$base64StringConvertFrom-AESBIcql -Icql $icqlString
++{{/code}}
++
  = ConvertTo-AESBBase64FromFile =
++Dieses Cmdlet wird verwendet, um den Inhalt einer Datei in eine Base64-kodierte Zeichenfolge zu konvertieren.
++
++|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)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
++
++{{code language="powershell"}}
++ConvertTo-AESBBase64FromFile -InputPath "C:\path\to\file.txt"
++
++{{/code}}
++
++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
++
++{{code language="powershell"}}
++$filePath = "C:\path\to\anotherfile.txt"
++$base64String = ConvertTo-AESBBase64FromFile -InputPath $filePath
++$base64String
++{{/code}}
++
  = 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 =