Changes for page Operative Cmdlets

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

From version 23.1
edited by jklein
on 2024/12/18 10:33
Change comment: There is no comment for this version
To version 28.1
edited by jklein
on 2025/06/18 11:36
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -AESB.110.AESB Shell.Cmdlet-Dokumentation.WebHome
1 +AESB.111.AESB Shell.Cmdlet-Dokumentation.WebHome
Content
... ... @@ -3,6 +3,10 @@
3 3  (% class="wikigeneratedid" %)
4 4  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.
5 5  
6 +{{aagon.infobox}}
7 +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.
8 +{{/aagon.infobox}}
9 +
6 6  = Add-AESBAlias =
7 7  
8 8  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.
... ... @@ -254,7 +254,7 @@
254 254  ConnectionName : MyConnection
255 255  {{/code}}
256 256  
257 -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
261 +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
258 258  
259 259  {{code language="powershell" layout="LINENUMBERS"}}
260 260  # Erstellen eines PSCustomObject mit Beispieldaten
... ... @@ -330,6 +330,8 @@
330 330  
331 331  |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
332 332  |-InputObject|psobject|❌|InObj|Das PSCustomObject, das in eine AESB Icql-Zeichenfolge konvertiert werden soll.
337 +|-Sequence|string|✅| |Setzt die Sequence einer ICQL Message
338 +|-Action|string|✅| |Setzt die Action einer ICQL Message
333 333  
334 334  === **Beispiele** ===
335 335  
... ... @@ -350,23 +350,6 @@
350 350  $icqlString
351 351  {{/code}}
352 352  
353 -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.
354 -
355 -{{code language="powershell" layout="LINENUMBERS"}}
356 -# Erstellen eines PSCustomObject mit Beispieldaten
357 -$exampleObject = [PSCustomObject]@{
358 - TargetName = "MyTarget"
359 - TargetType = "Queue"
360 - RoutingKey = "MyRoutingKey"
361 - VirtualRouter = "MyRouter"
362 - ConnectionName = "MyConnection"
363 -}
364 -
365 -# Konvertieren des Objekts in eine Icql-Zeichenfolge
366 -$icqlString = ConvertTo-AESBIcql -InputObject $exampleObject
367 -$icqlString
368 -{{/code}}
369 -
370 370  = Get-AESBActivityLogItemById =
371 371  
372 372  Gibt den Activity Log-Eintrag anhand einer ID zurück.
... ... @@ -795,7 +795,6 @@
795 795  
796 796  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.
797 797  
798 -
799 799  **Parameter**
800 800  
801 801  |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
... ... @@ -822,3 +822,39 @@
822 822  {{/code}}
823 823  
824 824  = Write-AESBBusinessLog =
813 +
814 +Mit diesem Cmdlet wird eine Nachricht in das Business-Log des AESB geschrieben. Jeder Aufruf des Cmdlets erzeugt immer einen neuen Log-Eintrag.
815 +
816 +{{aagon.infobox}}
817 +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.
818 +{{/aagon.infobox}}
819 +
820 +**Parameter**
821 +
822 +|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
823 +|-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
824 +|-IsError|bool|✅|IsErr|Gibt an, ob die Nachricht als Fehler protokolliert wird.
825 +|-Message|string|❌|M|Die zu protokollierende Nachricht.
826 +|-ComponentId|string|✅|CId|Die ID des Komponenten.
827 +|-ComponentName|string|✅|ComName|Der Name des Komponenten.
828 +|-ComponentPart|string|✅|ComPart|Der Teil des Komponenten.
829 +|-HostId|string|✅|HId|Die ID des Hosts.
830 +|-HostName|string|✅|HN|Der Name des Hosts.
831 +|-Context|string|✅|CT|Der Kontext der Nachricht.
832 +
833 +=== **Beispiele** ===
834 +
835 +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.
836 +
837 +{{code language="powershell"}}
838 +Write-AESBBusinessLog -Message "System started successfully" -ComponentName "MyComponent" -Context "Initialization"
839 +
840 +{{/code}}
841 +
842 +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.
843 +
844 +{{code language="powershell"}}
845 +Write-AESBBusinessLog -IsError $true -Message "Error connecting to database" -ComponentId "DBComponent" -HostName "Server01"
846 +{{/code}}
847 +
848 +
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community