Changes for page Operative Cmdlets

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

From version 27.1
edited by jklein
on 2025/06/11 09:52
Change comment: There is no comment for this version
To version 22.1
edited by jklein
on 2024/12/16 15:22
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -AESB.111.AESB Shell.Cmdlet-Dokumentation.WebHome
1 +AESB.110.AESB Shell.Cmdlet-Dokumentation.WebHome
Content
... ... @@ -3,10 +3,6 @@
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 -
10 10  = Add-AESBAlias =
11 11  
12 12  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 @@
258 258  ConnectionName : MyConnection
259 259  {{/code}}
260 260  
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
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
262 262  
263 263  {{code language="powershell" layout="LINENUMBERS"}}
264 264  # Erstellen eines PSCustomObject mit Beispieldaten
... ... @@ -334,8 +334,6 @@
334 334  
335 335  |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
336 336  |-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
339 339  
340 340  === **Beispiele** ===
341 341  
... ... @@ -356,9 +356,26 @@
356 356  $icqlString
357 357  {{/code}}
358 358  
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 +
359 359  = Get-AESBActivityLogItemById =
360 360  
361 -Gibt den Activity Log-Eintrag anhand einer ID zurück.
372 +Gibt den ActivityLog-Eintrag anhand einer ID zurück.
362 362  
363 363  |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
364 364  |-Id|string|❌| |Die ID des Logeintrags
... ... @@ -397,11 +397,11 @@
397 397  
398 398  = Get-AESBVirtualRouters =
399 399  
400 -Gibt eine Liste aller Virtual Router zurück.
411 +Gibt eine Liste aller VirtualRouter zurück.
401 401  
402 402  === **Beispiele** ===
403 403  
404 -Beispiel 1: Abrufen einer Liste aller Virtual Router
415 +Beispiel 1: Abrufen einer Liste aller VirtualRouter
405 405  
406 406  {{code language="powershell"}}
407 407  Get-AESBVirtualRouters
... ... @@ -459,17 +459,17 @@
459 459  |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
460 460  |-ConnectionName|string|✅|C|Der Name der Verbindung, für die die Zielnachrichtenzahl abgerufen werden soll.
461 461  |-TargetName|string|❌|TName|Der Name des Targets, für das die Nachrichtenzahl abgerufen werden soll.
462 -|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, unter dem das Target läuft.
473 +|-VirtualRouter|string|❌|VR|Der Name des VirtualRouters, unter dem das Target läuft.
463 463  
464 464  === **Beispiele** ===
465 465  
466 -Beispiel 1: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem Virtual Router "MyRouter"
477 +Beispiel 1: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem VirtualRouter "MyRouter"
467 467  
468 468  {{code language="powershell"}}
469 469  Get-AESBTargetMessageCount -VirtualRouter "MyRouter" -TargetName "MyTarget"
470 470  {{/code}}
471 471  
472 -Beispiel 2: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem Virtual Router "MyRouter" und der Verbindung "MyConnection"
483 +Beispiel 2: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem VirtualRouter "MyRouter" und der Verbindung "MyConnection"
473 473  
474 474  {{code language="powershell"}}
475 475  Get-AESBTargetMessageCount -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"
... ... @@ -486,7 +486,7 @@
486 486  
487 487  === **Beispiele** ===
488 488  
489 -Beispiel 1: Abrufen der Liste aller Targets unter dem Virtual Router "MyRouter"
500 +Beispiel 1: Abrufen der Liste aller Targets unter dem VirtualRouter "MyRouter"
490 490  
491 491  {{code language="powershell"}}
492 492  Get-AESBTargets -VirtualRouter "MyRouter"
... ... @@ -493,7 +493,7 @@
493 493  
494 494  {{/code}}
495 495  
496 -Beispiel 2: Abrufen der Liste aller Targets für den Virtual Router "MyRouter" und die Verbindung "MyConnection"
507 +Beispiel 2: Abrufen der Liste aller Targets für den VirtualRouter "MyRouter" und die Verbindung "MyConnection"
497 497  
498 498  {{code language="powershell"}}
499 499  Get-AESBTargets -ConnectionName "MyConnection" -VirtualRouter "MyRouter"
... ... @@ -532,7 +532,7 @@
532 532  
533 533  {{/code}}
534 534  
535 -Beispiel 2: Senden der Nachricht "This is a test message" über den Virtual Router "MyRouter" mit dem Routing Key "MyRoutingKey"
546 +Beispiel 2: Senden der Nachricht "This is a test message" über den VirtualRouter "MyRouter" mit dem RoutingKey "MyRoutingKey"
536 536  
537 537  {{code language="powershell"}}
538 538  Publish-AESBMessage -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey" -Message "This is a test message"
... ... @@ -550,14 +550,15 @@
550 550  
551 551  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.
552 552  
564 +
553 553  |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
554 554  |-Alias|string|❌|A|Der Name des Alias, an den die Nachricht veröffentlicht werden soll.
555 555  |-ConnectionName|string|✅|C|Der Name der Verbindung, über die die Nachricht gesendet werden soll.
556 556  |-Force|switch|✅|F|Zwingt die Veröffentlichung der Nachricht, auch wenn dies normalerweise nicht zulässig wäre.
557 557  |-Message|Object|❌|M|Die Nachricht, die veröffentlicht werden soll.
558 -|-RoutingKey|string|❌|RK|Der Routing Key, der für das Routing der Nachricht verwendet wird.
570 +|-RoutingKey|string|❌|RK|Der RoutingKey, der für das Routing der Nachricht verwendet wird.
559 559  |-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.
560 -|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, über den die Nachricht veröffentlicht werden soll.
572 +|-VirtualRouter|string|❌|VR|Der Name des VirtualRouters, über den die Nachricht veröffentlicht werden soll.
561 561  
562 562  === **Beispiele** ===
563 563  
... ... @@ -568,7 +568,7 @@
568 568  
569 569  {{/code}}
570 570  
571 -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.
583 +Beispiel 2: Senden der Nachricht "This is a test message" über den VirtualRouter "MyRouter" mit dem RoutingKey "MyRoutingKey" und wartet bis zu 1 Stunde auf eine Bestätigung.
572 572  
573 573  {{code language="powershell"}}
574 574  Publish-AESBMessageAndAwait -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey" -Message "This is a test message" -Timeout "1h"
... ... @@ -577,268 +577,20 @@
577 577  
578 578  = Receive-AESBTargetMessages =
579 579  
580 -Mit diesem Cmdlet können Sie Nachrichten von einem Ziel im AESB empfangen.
581 -
582 -|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
583 -|-ConnectionName|//string//|✅|C|Der Name der Verbindung zum AESB.
584 -|-MessageCount|//int//|✅|MC|Die Anzahl der Nachrichten, die empfangen werden sollen.
585 -|-TargetName|//string//|❌|TName|Der Name des Ziels, von dem die Nachrichten empfangen werden.
586 -|-VirtualRouter|//string//|❌|VR|Der Name des Virtual Routers, der für das Ziel verwendet wird.
587 -
588 -=== **Beispiele** ===
589 -
590 -Beispiel 1: Empfangen von Nachrichten vom Ziel mit dem Namen "MyTarget", das dem Virtual Router "MyRouter" zugeordnet ist
591 -
592 -{{code language="powershell"}}
593 -Receive-AESBTargetMessages -VirtualRouter "MyRouter" -TargetName "MyTarget"
594 -
595 -{{/code}}
596 -
597 -Beispiel 2: Empfangen von bis zu 10 Nachrichten vom Ziel mit dem Namen "MyTarget", das dem Virtual Router "MyRouter" zugeordnet ist
598 -
599 -{{code language="powershell"}}
600 -Receive-AESBTargetMessages -VirtualRouter "MyRouter" -TargetName "MyTarget" -MessageCount 10
601 -
602 -{{/code}}
603 -
604 604  = Remove-AESBAlias =
605 605  
606 -Mit diesem Cmdlet können Sie einen Alias aus dem AESB entfernen.
607 -
608 -|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
609 -|-Alias|string|❌|A|Der Name des zu entfernenden Alias.
610 -|-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
611 -
612 -=== **Beispiele** ===
613 -
614 -Beispiel 1: Entfernen vom Alias "MyAlias" aus dem AESB
615 -
616 -{{code language="powershell"}}
617 -Remove-AESBAlias -Alias "MyAlias"
618 -
619 -{{/code}}
620 -
621 -Beispiel 2: Entfernen vom Alias "MyAlias" aus dem AESB über die angegebene Verbindung
622 -
623 -{{code language="powershell"}}
624 -Remove-AESBAlias -ConnectionName "MyConnection" -Alias "MyAlias"
625 -
626 -{{/code}}
627 -
628 628  = Remove-AESBRoutingFromAlias =
629 629  
630 -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.
631 -
632 -|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
633 -|-Alias|string|❌|A|Der Name des Alias, von dem das Routing-Paar entfernt werden soll.
634 -|-ConnectionName|string|✅|C|Der Name der Verbindung, die verwendet wird.
635 -|-RoutingKey|string|❌|RK|Der Routing Key, der aus dem Alias entfernt werden soll.
636 -|-VirtualRouter|string|❌|VR|Der Virtual Router, der zusammen mit dem Routing Key entfernt werden soll.
637 -
638 -=== **Beispiele** ===
639 -
640 -Beispiel 1: Entfernen vom Routing-Paar mit Virtual Router "MyRouter" und Routing Key "MyRoutingKey" vom Alias "MyAlias"
641 -
642 -{{code language="powershell"}}
643 -Remove-AESBRoutingFromAlias -Alias "MyAlias" -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey"
644 -
645 -{{/code}}
646 -
647 -Beispiel 2: Entfernen vom Routing-Paar mit Virtual Router "MyRouter" und Routing Key "MyRoutingKey" vom Alias "MyAlias" unter Verwendung der Verbindung "MyConnection"
648 -
649 -{{code language="powershell"}}
650 -Remove-AESBRoutingFromAlias -Alias "MyAlias" -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey"
651 -
652 -{{/code}}
653 -
654 654  = Remove-AESBRoutingKey =
655 655  
656 -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.
657 -
658 -|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
659 -|-ConnectionName|string|✅|C|Der Name der Verbindung, die verwendet werden soll.
660 -|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, von dem der Routing Key entfernt werden soll.
661 -|-TargetName|string|❌|TName|Der Name des Ziels, von dem der Routing Key entfernt werden soll.
662 -|-RoutingKey|string|❌|RK|Der Routing Key, der entfernt werden soll.
663 -
664 -=== **Beispiele** ===
665 -
666 -Beispiel 1: Entfernen vom Routing Key "MyRoutingKey" vom Ziel "MyTarget" im Virtual Router "MyRouter"
667 -
668 -{{code language="powershell"}}
669 -Remove-AESBRoutingKey -VirtualRouter "MyRouter" -TargetName "MyTarget" -RoutingKey "MyRoutingKey"
670 -
671 -{{/code}}
672 -
673 -Beispiel 2: Entfernen vom Routing Key "MyRoutingKey" vom Ziel "MyTarget" im Virtual Router "MyRouter" unter Verwendung der Verbindung "MyConnection"
674 -
675 -{{code language="powershell"}}
676 -Remove-AESBRoutingKey -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget" -RoutingKey "MyRoutingKey"
677 -
678 -{{/code}}
679 -
680 680  = Remove-AESBTarget =
681 681  
682 -Mit diesem Cmdlet können Sie ein Ziel aus dem Virtual Router des AESB entfernen.
683 -
684 -|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
685 -|-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
686 -|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, von dem das Ziel entfernt werden soll.
687 -|-TargetName|string|❌|TName|Der Name des Ziels, das entfernt werden soll.
688 -
689 -=== **Beispiele** ===
690 -
691 -Beispiel 1: Entfernen vom Ziel "MyTarget" vom Virtual Router "MyRouter"
692 -
693 -{{code language="powershell"}}
694 -Remove-AESBTarget -VirtualRouter "MyRouter" -TargetName "MyTarget"
695 -{{/code}}
696 -
697 -Beispiel 2: Entfernen vom Ziel "MyTarget" vom Virtual Router "MyRouter" unter Verwendung der Verbindung "MyConnection"
698 -
699 -{{code language="powershell"}}
700 -Remove-AESBTarget -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"
701 -{{/code}}
702 -
703 703  = Remove-AESBVirtualRouter =
704 704  
705 -Mit diesem Cmdlet können Sie einen angegebenen Virtual Router entfernen.
706 -
707 -|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
708 -|ConnectionName|string|✅|C|Gibt den Namen der Verbindung an.
709 -|VirtualRouter|string|❌|VR|Gibt den Namen des zu entfernenden Virtual Router an.
710 -
711 -=== **Beispiele** ===
712 -
713 -Beispiel 1: Entfernen vom Virtual Router mit dem Namen "MyRouter"
714 -
715 -{{code language="powershell"}}
716 -Remove-AESBVirtualRouter -VirtualRouter "MyRouter"
717 -
718 -{{/code}}
719 -
720 -Beispiel 2: Entfernen vom Virtual Router mit dem Namen "MyRouter" unter der Verbindung "MyConnection"
721 -
722 -{{code language="powershell"}}
723 -Remove-AESBVirtualRouter -ConnectionName "MyConnection" -VirtualRouter "MyRouter"
724 -{{/code}}
725 -
726 726  = Set-AESBBSelfAsAlias =
727 727  
728 -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.
729 -
730 -{{aagon.warnungsbox}}
731 -Die Parameter RemoveExistingAlias und AddToExistingAlias dürfen nicht gleichzeitig verwendet werden!
732 -{{/aagon.warnungsbox}}
733 -
734 -**Parameter**
735 -
736 -|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
737 -|-Alias|string|❌| |Gibt den Namen vom Alias an
738 -|-RemoveExistingAlias|bool|✅| |Der bestehende Alias wird ersetzt.
739 -|-AddToExistingAlias|bool|✅| |Der Virtual Router und Routing Key wird zu dem angegebenen Alias hinzugefügt
740 -
741 -=== **Beispiele** ===
742 -
743 -Beispiel 1: Überschreiben vom existierenden Alias „AliasName“. Wenn z.B. der vorherige Alias mehrere Virtual Router und Routing Keys hatte, werden diese gelöscht
744 -
745 -{{code language="powershell"}}
746 -Set-AESBSelfAsAlias -Alias "AliasName" -RemoveExistingAlias $true
747 -
748 -{{/code}}
749 -
750 -Beispiel 2: Hinzufügen der Virtual Router und Routing Keys vom Alias „AliasName“ zum angegebenen Alias "SelfAliasTest".
751 -
752 -{{code language="powershell"}}
753 -Set-AESBSelfAsAlias -Alias "AliasName" -AddToExistingAlias "SelfAliasTest"
754 -{{/code}}
755 -
756 756  = Show-AESBRoutingTable =
757 757  
758 -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.
759 -
760 -**Parameter**
761 -
762 -|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
763 -|-ConnectionName|string|✅|C|Der Name der Verbindung, die für das Abrufen der Routing-Tabelle verwendet wird.
764 -|-ExchangeType|ExchangeTypes|✅|ET|Der Typ des Exchanges, der angezeigt werden soll. Mögliche Werte sind DIRECT oder ROUTING.
765 -|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, für den die Routing-Tabelle angezeigt wird.
766 -
767 -=== **Beispiele** ===
768 -
769 -Beispiel 1: Anzeigen der Routing-Tabelle für den Virtual Router „MyRouter“
770 -
771 -{{code language="powershell"}}
772 -Show-AESBRoutingTable -VirtualRouter "MyRouter"
773 -
774 -{{/code}}
775 -
776 -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.
777 -
778 -{{code language="powershell"}}
779 -Show-AESBRoutingTable -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -ExchangeType DIRECT
780 -
781 -{{/code}}
782 -
783 783  = Write-AESBActivityLog =
784 784  
785 -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.
786 -
787 -**Parameter**
788 -
789 -|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
790 -|-ConnectionName|string|✅|C|Der Name der Verbindung, die für die Kommunikation verwendet wird.
791 -|-Id|string|✅|None|Die ID des Log-Eintrags, der aktualisiert werden soll. Wird ein neuer Eintrag erstellt, kann dieser Parameter weggelassen werden.
792 -|-Name|string|❌|N|Der Name des Log-Eintrags.
793 -|-Description|string|❌|D|Die Beschreibung des Log-Eintrags.
794 -|-Status|JobFeedbackResultCode|❌|ST|Der Status des Logs, z.B. "Warning", "Created", "Started", "Running", "Stopping", "Stopped", "Failed" oder "Finished".
795 -|-ComponentName|string|✅|ComName|Der Name der Komponente, die den Log-Eintrag erstellt hat.
796 -
797 -=== **Beispiele** ===
798 -
799 -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.
800 -
801 -{{code language="powershell"}}
802 -Write-AESBActivityLog -Name "ProcessStart" -Description "Der Prozess wurde gestartet." -Status Started
803 -{{/code}}
804 -
805 -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.
806 -
807 -{{code language="powershell"}}
808 -Write-AESBActivityLog -Id "12345" -Name "ProcessUpdate" -Description "Der Prozessstatus wurde aktualisiert." -Status Running
809 -
810 -{{/code}}
811 -
812 812  = 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 -**Parameter**
817 -
818 -|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
819 -|-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
820 -|-IsError|bool|✅|IsErr|Gibt an, ob die Nachricht als Fehler protokolliert wird.
821 -|-Message|string|❌|M|Die zu protokollierende Nachricht.
822 -|-ComponentId|string|✅|CId|Die ID des Komponenten.
823 -|-ComponentName|string|✅|ComName|Der Name des Komponenten.
824 -|-ComponentPart|string|✅|ComPart|Der Teil des Komponenten.
825 -|-HostId|string|✅|HId|Die ID des Hosts.
826 -|-HostName|string|✅|HN|Der Name des Hosts.
827 -|-Context|string|✅|CT|Der Kontext der Nachricht.
828 -
829 -=== **Beispiele** ===
830 -
831 -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.
832 -
833 -{{code language="powershell"}}
834 -Write-AESBBusinessLog -Message "System started successfully" -ComponentName "MyComponent" -Context "Initialization"
835 -
836 -{{/code}}
837 -
838 -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.
839 -
840 -{{code language="powershell"}}
841 -Write-AESBBusinessLog -IsError $true -Message "Error connecting to database" -ComponentId "DBComponent" -HostName "Server01"
842 -{{/code}}
843 -
844 -
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community