Changes for page Operative Cmdlets

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

From 22.3 to 22.2 From 29.1 to 28.1

From version 28.1

edited by jklein
on 2025/06/18 11:36

Change comment: There is no comment for this version

To version 22.3

edited by jklein
on 2024/12/17 15:27

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Parent

@@ -1,1 +1,1 @@
--AESB.111.AESB Shell.Cmdlet-Dokumentation.WebHome
++AESB.110.AESB Shell.Cmdlet-Dokumentation.WebHome

Content

@@ -3,10 +3,6 @@
  (% class="wikigeneratedid" %)
  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.
--{{aagon.infobox}}
--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.
--{{/aagon.infobox}}
--
  = 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.
@@ -258,7 +258,7 @@
  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
++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
@@ -334,8 +334,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** ===
@@ -356,6 +356,23 @@
  $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.
@@ -725,124 +725,8 @@
  = 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 =
--
--Mit diesem Cmdlet wird eine Nachricht in das Business-Log des AESB geschrieben. Jeder Aufruf des Cmdlets erzeugt immer einen neuen Log-Eintrag.
--
--{{aagon.infobox}}
--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.
--{{/aagon.infobox}}
--
--**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 zum AESB.
--|-IsError|bool|✅|IsErr|Gibt an, ob die Nachricht als Fehler protokolliert wird.
--|-Message|string|❌|M|Die zu protokollierende Nachricht.
--|-ComponentId|string|✅|CId|Die ID des Komponenten.
--|-ComponentName|string|✅|ComName|Der Name des Komponenten.
--|-ComponentPart|string|✅|ComPart|Der Teil des Komponenten.
--|-HostId|string|✅|HId|Die ID des Hosts.
--|-HostName|string|✅|HN|Der Name des Hosts.
--|-Context|string|✅|CT|Der 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.
--
--{{code language="powershell"}}
--Write-AESBBusinessLog -Message "System started successfully" -ComponentName "MyComponent" -Context "Initialization"
--
--{{/code}}
--
--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.
--
--{{code language="powershell"}}
--Write-AESBBusinessLog -IsError $true -Message "Error connecting to database" -ComponentId "DBComponent" -HostName "Server01"
--{{/code}}
--
--