Changes for page Operative Cmdlets

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

From version 18.2
edited by jklein
on 2024/12/16 13:15
Change comment: There is no comment for this version
To version 25.1
edited by jklein
on 2024/12/18 10:49
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -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.
333 +|-Sequence|string|✅| |Setzt die Sequence einer ICQL Message
334 +|-Action|string|✅| |Setzt die Action einer ICQL Message
333 333  
334 334  === **Beispiele** ===
335 335  
... ... @@ -350,26 +350,9 @@
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 -Gibt den ActivityLog-Eintrag anhand einer ID zurück.
357 +Gibt den Activity Log-Eintrag anhand einer ID zurück.
373 373  
374 374  |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
375 375  |-Id|string|❌| |Die ID des Logeintrags
... ... @@ -408,11 +408,11 @@
408 408  
409 409  = Get-AESBVirtualRouters =
410 410  
411 -Gibt eine Liste aller VirtualRouter zurück.
396 +Gibt eine Liste aller Virtual Router zurück.
412 412  
413 413  === **Beispiele** ===
414 414  
415 -Beispiel 1: Abrufen einer Liste aller VirtualRouter
400 +Beispiel 1: Abrufen einer Liste aller Virtual Router
416 416  
417 417  {{code language="powershell"}}
418 418  Get-AESBVirtualRouters
... ... @@ -467,21 +467,20 @@
467 467  
468 468  Dieses Cmdlet wird verwendet, um die Anzahl der Nachrichten zu ermitteln, die sich derzeit im angegebenen Target befinden.
469 469  
470 -
471 471  |=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
472 472  |-ConnectionName|string|✅|C|Der Name der Verbindung, für die die Zielnachrichtenzahl abgerufen werden soll.
473 473  |-TargetName|string|❌|TName|Der Name des Targets, für das die Nachrichtenzahl abgerufen werden soll.
474 -|-VirtualRouter|string|❌|VR|Der Name des VirtualRouters, unter dem das Target läuft.
458 +|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, unter dem das Target läuft.
475 475  
476 476  === **Beispiele** ===
477 477  
478 -Beispiel 1: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem VirtualRouter "MyRouter"
462 +Beispiel 1: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem Virtual Router "MyRouter"
479 479  
480 -{{code language="powershell" layout="LINENUMBERS"}}
464 +{{code language="powershell"}}
481 481  Get-AESBTargetMessageCount -VirtualRouter "MyRouter" -TargetName "MyTarget"
482 482  {{/code}}
483 483  
484 -Beispiel 2: Anzahl der Nachrichten für das Target "MyTarget" unter dem VirtualRouter "MyRouter" und der Verbindung "MyConnection"
468 +Beispiel 2: Abrufen der Anzahl der Nachrichten für das Target "MyTarget" unter dem Virtual Router "MyRouter" und der Verbindung "MyConnection"
485 485  
486 486  {{code language="powershell"}}
487 487  Get-AESBTargetMessageCount -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"
... ... @@ -490,26 +490,367 @@
490 490  
491 491  = Get-AESBTargets =
492 492  
477 +Dieses Cmdlet wird verwendet, um eine Übersicht der im AESB definierten Targets zu erhalten.
478 +
479 +|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
480 +|-ConnectionName|string|✅|C|Der Name der Verbindung, für die die Liste der Targets abgerufen werden soll.
481 +|-VirtualRouter|string|❌|VR|Der Name des VirtualRouters, für den die Liste der Targets abgerufen werden soll.
482 +
483 +=== **Beispiele** ===
484 +
485 +Beispiel 1: Abrufen der Liste aller Targets unter dem Virtual Router "MyRouter"
486 +
487 +{{code language="powershell"}}
488 +Get-AESBTargets -VirtualRouter "MyRouter"
489 +
490 +{{/code}}
491 +
492 +Beispiel 2: Abrufen der Liste aller Targets für den Virtual Router "MyRouter" und die Verbindung "MyConnection"
493 +
494 +{{code language="powershell"}}
495 +Get-AESBTargets -ConnectionName "MyConnection" -VirtualRouter "MyRouter"
496 +
497 +{{/code}}
498 +
493 493  = Publish-AESBMessage =
494 494  
501 + Dieses Cmdlet wird verwendet, um Nachrichten an die angegebenen Ziele oder Aliase zu senden.
502 +
503 +|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
504 +|-Alias|string|❌|A|Der Name des Alias, an den die Nachricht veröffentlicht werden soll.
505 +|-ConnectionName|string|✅|C|Der Name der Verbindung, über die die Nachricht gesendet werden soll.
506 +|-Force|switch|✅|F|Zwingt die Veröffentlichung der Nachricht, auch wenn dies normalerweise nicht zulässig wäre.
507 +|-Message|Object|❌|M|Die Nachricht, die veröffentlicht werden soll.
508 +|-RoutingKey|string|❌|RK|Der RoutingKey, der für das Routing der Nachricht verwendet wird.
509 +|-VirtualRouter|string|❌|VR|Der Name des VirtualRouters, über den die Nachricht veröffentlicht werden soll.
510 +
511 +=== Parameter-Sets ===
512 +
513 +Für die Parameter dieses Cmdlets wurden eigene Parameter-Sets definiert, die Sie verwenden können:
514 +
515 +* (((
516 +RoutingParameterSet - Message, VirtualRouter, RoutingKey
517 +)))
518 +* (((
519 +AliasParameterSet - Message, Alias
520 +)))
521 +
522 +=== **Beispiele** ===
523 +
524 +Beispiel 1: Senden der Nachricht "This is a test message" an den Alias "MyAlias"
525 +
526 +{{code language="powershell"}}
527 +Publish-AESBMessage -Alias "MyAlias" -Message "This is a test message"
528 +
529 +{{/code}}
530 +
531 +Beispiel 2: Senden der Nachricht "This is a test message" über den Virtual Router "MyRouter" mit dem Routing Key "MyRoutingKey"
532 +
533 +{{code language="powershell"}}
534 +Publish-AESBMessage -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey" -Message "This is a test message"
535 +
536 +{{/code}}
537 +
538 +Beispiel 3: Konvertieren eines PSCustomObject in das ICQL-Format und senden der Nachricht an den Alias "MyAlias"
539 +
540 +{{code language="powershell"}}
541 +ConvertTo-AESBIcql $exampleObject | Publish-AESBMessage -Alias "MyAlias"
542 +
543 +{{/code}}
544 +
495 495  = Publish-AESBMessageAndAwait =
496 496  
547 +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.
548 +
549 +|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
550 +|-Alias|string|❌|A|Der Name des Alias, an den die Nachricht veröffentlicht werden soll.
551 +|-ConnectionName|string|✅|C|Der Name der Verbindung, über die die Nachricht gesendet werden soll.
552 +|-Force|switch|✅|F|Zwingt die Veröffentlichung der Nachricht, auch wenn dies normalerweise nicht zulässig wäre.
553 +|-Message|Object|❌|M|Die Nachricht, die veröffentlicht werden soll.
554 +|-RoutingKey|string|❌|RK|Der Routing Key, der für das Routing der Nachricht verwendet wird.
555 +|-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.
556 +|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, über den die Nachricht veröffentlicht werden soll.
557 +
558 +=== **Beispiele** ===
559 +
560 +Beispiel 1: Senden der Nachricht "This is a test message" an den Alias "MyAlias" und wartet bis zu 5 Minuten auf eine Bestätigung
561 +
562 +{{code language="powershell"}}
563 +Publish-AESBMessageAndAwait -Alias "MyAlias" -Message "This is a test message" -Timeout "5m"
564 +
565 +{{/code}}
566 +
567 +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.
568 +
569 +{{code language="powershell"}}
570 +Publish-AESBMessageAndAwait -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey" -Message "This is a test message" -Timeout "1h"
571 +
572 +{{/code}}
573 +
497 497  = Receive-AESBTargetMessages =
498 498  
576 +Mit diesem Cmdlet können Sie Nachrichten von einem Ziel im AESB empfangen.
577 +
578 +|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
579 +|-ConnectionName|//string//|✅|C|Der Name der Verbindung zum AESB.
580 +|-MessageCount|//int//|✅|MC|Die Anzahl der Nachrichten, die empfangen werden sollen.
581 +|-TargetName|//string//|❌|TName|Der Name des Ziels, von dem die Nachrichten empfangen werden.
582 +|-VirtualRouter|//string//|❌|VR|Der Name des Virtual Routers, der für das Ziel verwendet wird.
583 +
584 +=== **Beispiele** ===
585 +
586 +Beispiel 1: Empfangen von Nachrichten vom Ziel mit dem Namen "MyTarget", das dem Virtual Router "MyRouter" zugeordnet ist
587 +
588 +{{code language="powershell"}}
589 +Receive-AESBTargetMessages -VirtualRouter "MyRouter" -TargetName "MyTarget"
590 +
591 +{{/code}}
592 +
593 +Beispiel 2: Empfangen von bis zu 10 Nachrichten vom Ziel mit dem Namen "MyTarget", das dem Virtual Router "MyRouter" zugeordnet ist
594 +
595 +{{code language="powershell"}}
596 +Receive-AESBTargetMessages -VirtualRouter "MyRouter" -TargetName "MyTarget" -MessageCount 10
597 +
598 +{{/code}}
599 +
499 499  = Remove-AESBAlias =
500 500  
602 +Mit diesem Cmdlet können Sie einen Alias aus dem AESB entfernen.
603 +
604 +|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
605 +|-Alias|string|❌|A|Der Name des zu entfernenden Alias.
606 +|-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
607 +
608 +=== **Beispiele** ===
609 +
610 +Beispiel 1: Entfernen vom Alias "MyAlias" aus dem AESB
611 +
612 +{{code language="powershell"}}
613 +Remove-AESBAlias -Alias "MyAlias"
614 +
615 +{{/code}}
616 +
617 +Beispiel 2: Entfernen vom Alias "MyAlias" aus dem AESB über die angegebene Verbindung
618 +
619 +{{code language="powershell"}}
620 +Remove-AESBAlias -ConnectionName "MyConnection" -Alias "MyAlias"
621 +
622 +{{/code}}
623 +
501 501  = Remove-AESBRoutingFromAlias =
502 502  
626 +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.
627 +
628 +|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
629 +|-Alias|string|❌|A|Der Name des Alias, von dem das Routing-Paar entfernt werden soll.
630 +|-ConnectionName|string|✅|C|Der Name der Verbindung, die verwendet wird.
631 +|-RoutingKey|string|❌|RK|Der Routing Key, der aus dem Alias entfernt werden soll.
632 +|-VirtualRouter|string|❌|VR|Der Virtual Router, der zusammen mit dem Routing Key entfernt werden soll.
633 +
634 +=== **Beispiele** ===
635 +
636 +Beispiel 1: Entfernen vom Routing-Paar mit Virtual Router "MyRouter" und Routing Key "MyRoutingKey" vom Alias "MyAlias"
637 +
638 +{{code language="powershell"}}
639 +Remove-AESBRoutingFromAlias -Alias "MyAlias" -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey"
640 +
641 +{{/code}}
642 +
643 +Beispiel 2: Entfernen vom Routing-Paar mit Virtual Router "MyRouter" und Routing Key "MyRoutingKey" vom Alias "MyAlias" unter Verwendung der Verbindung "MyConnection"
644 +
645 +{{code language="powershell"}}
646 +Remove-AESBRoutingFromAlias -Alias "MyAlias" -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -RoutingKey "MyRoutingKey"
647 +
648 +{{/code}}
649 +
503 503  = Remove-AESBRoutingKey =
504 504  
652 +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.
653 +
654 +|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
655 +|-ConnectionName|string|✅|C|Der Name der Verbindung, die verwendet werden soll.
656 +|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, von dem der Routing Key entfernt werden soll.
657 +|-TargetName|string|❌|TName|Der Name des Ziels, von dem der Routing Key entfernt werden soll.
658 +|-RoutingKey|string|❌|RK|Der Routing Key, der entfernt werden soll.
659 +
660 +=== **Beispiele** ===
661 +
662 +Beispiel 1: Entfernen vom Routing Key "MyRoutingKey" vom Ziel "MyTarget" im Virtual Router "MyRouter"
663 +
664 +{{code language="powershell"}}
665 +Remove-AESBRoutingKey -VirtualRouter "MyRouter" -TargetName "MyTarget" -RoutingKey "MyRoutingKey"
666 +
667 +{{/code}}
668 +
669 +Beispiel 2: Entfernen vom Routing Key "MyRoutingKey" vom Ziel "MyTarget" im Virtual Router "MyRouter" unter Verwendung der Verbindung "MyConnection"
670 +
671 +{{code language="powershell"}}
672 +Remove-AESBRoutingKey -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget" -RoutingKey "MyRoutingKey"
673 +
674 +{{/code}}
675 +
505 505  = Remove-AESBTarget =
506 506  
678 +Mit diesem Cmdlet können Sie ein Ziel aus dem Virtual Router des AESB entfernen.
679 +
680 +|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
681 +|-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
682 +|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, von dem das Ziel entfernt werden soll.
683 +|-TargetName|string|❌|TName|Der Name des Ziels, das entfernt werden soll.
684 +
685 +=== **Beispiele** ===
686 +
687 +Beispiel 1: Entfernen vom Ziel "MyTarget" vom Virtual Router "MyRouter"
688 +
689 +{{code language="powershell"}}
690 +Remove-AESBTarget -VirtualRouter "MyRouter" -TargetName "MyTarget"
691 +{{/code}}
692 +
693 +Beispiel 2: Entfernen vom Ziel "MyTarget" vom Virtual Router "MyRouter" unter Verwendung der Verbindung "MyConnection"
694 +
695 +{{code language="powershell"}}
696 +Remove-AESBTarget -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"
697 +{{/code}}
698 +
507 507  = Remove-AESBVirtualRouter =
508 508  
701 +Mit diesem Cmdlet können Sie einen angegebenen Virtual Router entfernen.
702 +
703 +|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
704 +|ConnectionName|string|✅|C|Gibt den Namen der Verbindung an.
705 +|VirtualRouter|string|❌|VR|Gibt den Namen des zu entfernenden Virtual Router an.
706 +
707 +=== **Beispiele** ===
708 +
709 +Beispiel 1: Entfernen vom Virtual Router mit dem Namen "MyRouter"
710 +
711 +{{code language="powershell"}}
712 +Remove-AESBVirtualRouter -VirtualRouter "MyRouter"
713 +
714 +{{/code}}
715 +
716 +Beispiel 2: Entfernen vom Virtual Router mit dem Namen "MyRouter" unter der Verbindung "MyConnection"
717 +
718 +{{code language="powershell"}}
719 +Remove-AESBVirtualRouter -ConnectionName "MyConnection" -VirtualRouter "MyRouter"
720 +{{/code}}
721 +
509 509  = Set-AESBBSelfAsAlias =
510 510  
724 +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.
725 +
726 +{{aagon.warnungsbox}}
727 +Die Parameter RemoveExistingAlias und AddToExistingAlias dürfen nicht gleichzeitig verwendet werden!
728 +{{/aagon.warnungsbox}}
729 +
730 +**Parameter**
731 +
732 +|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
733 +|-Alias|string|❌| |Gibt den Namen vom Alias an
734 +|-RemoveExistingAlias|bool|✅| |Der bestehende Alias wird ersetzt.
735 +|-AddToExistingAlias|bool|✅| |Der Virtual Router und Routing Key wird zu dem angegebenen Alias hinzugefügt
736 +
737 +=== **Beispiele** ===
738 +
739 +Beispiel 1: Überschreiben vom existierenden Alias „AliasName“. Wenn z.B. der vorherige Alias mehrere Virtual Router und Routing Keys hatte, werden diese gelöscht
740 +
741 +{{code language="powershell"}}
742 +Set-AESBSelfAsAlias -Alias "AliasName" -RemoveExistingAlias $true
743 +
744 +{{/code}}
745 +
746 +Beispiel 2: Hinzufügen der Virtual Router und Routing Keys vom Alias „AliasName“ zum angegebenen Alias "SelfAliasTest".
747 +
748 +{{code language="powershell"}}
749 +Set-AESBSelfAsAlias -Alias "AliasName" -AddToExistingAlias "SelfAliasTest"
750 +{{/code}}
751 +
511 511  = Show-AESBRoutingTable =
512 512  
754 +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.
755 +
756 +**Parameter**
757 +
758 +|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
759 +|-ConnectionName|string|✅|C|Der Name der Verbindung, die für das Abrufen der Routing-Tabelle verwendet wird.
760 +|-ExchangeType|ExchangeTypes|✅|ET|Der Typ des Exchanges, der angezeigt werden soll. Mögliche Werte sind DIRECT oder ROUTING.
761 +|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, für den die Routing-Tabelle angezeigt wird.
762 +
763 +=== **Beispiele** ===
764 +
765 +Beispiel 1: Anzeigen der Routing-Tabelle für den Virtual Router „MyRouter“
766 +
767 +{{code language="powershell"}}
768 +Show-AESBRoutingTable -VirtualRouter "MyRouter"
769 +
770 +{{/code}}
771 +
772 +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.
773 +
774 +{{code language="powershell"}}
775 +Show-AESBRoutingTable -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -ExchangeType DIRECT
776 +
777 +{{/code}}
778 +
513 513  = Write-AESBActivityLog =
514 514  
781 +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.
782 +
783 +**Parameter**
784 +
785 +|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
786 +|-ConnectionName|string|✅|C|Der Name der Verbindung, die für die Kommunikation verwendet wird.
787 +|-Id|string|✅|None|Die ID des Log-Eintrags, der aktualisiert werden soll. Wird ein neuer Eintrag erstellt, kann dieser Parameter weggelassen werden.
788 +|-Name|string|❌|N|Der Name des Log-Eintrags.
789 +|-Description|string|❌|D|Die Beschreibung des Log-Eintrags.
790 +|-Status|JobFeedbackResultCode|❌|ST|Der Status des Logs, z.B. "Warning", "Created", "Started", "Running", "Stopping", "Stopped", "Failed" oder "Finished".
791 +|-ComponentName|string|✅|ComName|Der Name der Komponente, die den Log-Eintrag erstellt hat.
792 +
793 +=== **Beispiele** ===
794 +
795 +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.
796 +
797 +{{code language="powershell"}}
798 +Write-AESBActivityLog -Name "ProcessStart" -Description "Der Prozess wurde gestartet." -Status Started
799 +{{/code}}
800 +
801 +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.
802 +
803 +{{code language="powershell"}}
804 +Write-AESBActivityLog -Id "12345" -Name "ProcessUpdate" -Description "Der Prozessstatus wurde aktualisiert." -Status Running
805 +
806 +{{/code}}
807 +
515 515  = Write-AESBBusinessLog =
809 +
810 +Mit diesem Cmdlet wird eine Nachricht in das Business-Log des AESB geschrieben. Jeder Aufruf des Cmdlets erzeugt immer einen neuen Log-Eintrag
811 +
812 +**Parameter**
813 +
814 +|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
815 +|-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
816 +|-IsError|bool|✅|IsErr|Gibt an, ob die Nachricht als Fehler protokolliert wird.
817 +|-Message|string|❌|M|Die zu protokollierende Nachricht.
818 +|-ComponentId|string|✅|CId|Die ID des Komponenten.
819 +|-ComponentName|string|✅|ComName|Der Name des Komponenten.
820 +|-ComponentPart|string|✅|ComPart|Der Teil des Komponenten.
821 +|-HostId|string|✅|HId|Die ID des Hosts.
822 +|-HostName|string|✅|HN|Der Name des Hosts.
823 +|-Context|string|✅|CT|Der Kontext der Nachricht.
824 +
825 +=== **Beispiele** ===
826 +
827 +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.
828 +
829 +{{code language="powershell"}}
830 +Write-AESBBusinessLog -Message "System started successfully" -ComponentName "MyComponent" -Context "Initialization"
831 +
832 +{{/code}}
833 +
834 +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.
835 +
836 +{{code language="powershell"}}
837 +Write-AESBBusinessLog -IsError $true -Message "Error connecting to database" -ComponentId "DBComponent" -HostName "Server01"
838 +{{/code}}
839 +
840 +
© Aagon GmbH 2025
Besuchen Sie unsere neue Aagon-Community