Changes for page Microservice Cmdlets

Last modified by jklein on 2025/08/15 09:48
From version 4.3
edited by jklein
on 2025/06/24 10:54
Change comment: There is no comment for this version
To version 6.3
edited by jklein
on 2025/07/16 08:30
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -155,7 +155,7 @@
155 155  * **CpuUsage**: Die aktuelle CPU-Auslastung des Microservices in Prozent.
156 156  * **MemoryUsage**: Die aktuelle Speicherauslastung des Microservices in Bytes.
157 157  
158 -== Edit-AESBMicroservices ==
158 +== Edit-AESBMicroservice ==
159 159  
160 160  Dieses Cmdlet ermöglicht die Bearbeitung der Konfiguration eines spezifischen Microservice. Derzeit unterstützt es die Änderung des Starttyps (StartupType) und optional die Konfiguration von Anmeldeinformationen (Credentials) für den Microservice. Dies ist besonders nützlich, um das Startverhalten von Microservices zu steuern oder SICS-Anmeldeinformationen zu aktualisieren.
161 161  
... ... @@ -621,8 +621,8 @@
621 621  
622 622  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
623 623  |-ConnectionName|String|✅|C|Der Name der Verbindung, über die eine Vorlage hinzugefügt werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
624 -|-TemplateName|String|❌|Keine|Der Name für die Vorlage
625 -|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration der Vorlage
624 +|-TemplateName|String|❌|Keine|Der Name für die Vorlage.
625 +|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration der Vorlage.
626 626  
627 627  === **Beispiele** ===
628 628  
... ... @@ -635,16 +635,57 @@
635 635  Dieses Beispiel fügt eine neue Templatekonfiguration mit dem Namen "Test" auf Basis des $templateConfig-Objekts hinzu. Die Standardverbindung wird verwendet.
636 636  
637 637  {{apimacro title="Beispiel der Funktion in PowerShell"}}
638 +{{code language="PowerShell" layout="LINENUMBERS"}}
639 +function Add-MicroserviceTemplate {
640 + param (
641 + [string]$Name
642 + )
638 638  
644 + $packages = Get-AESBMicroservicePackages
645 +
646 + $microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packages[0].PackageName -PackageVersion $packages[0].PackageVersions[0]
647 +
648 + $addMicroserviceResult = Add-AESBMicroserviceTemplate -TemplateName $Name -TemplateConfig $microserviceTemplateConfig
649 +
650 + return $addMicroserviceResult
651 +}
652 +{{/code}}
639 639  {{/apimacro}}
640 640  
641 641  {{apimacro title="Beispiel der Template-Konfiguration"}}
642 -
656 +{{code language="PowerShell" layout="LINENUMBERS"}}
657 +$templateConfig = "<MicroserviceConfiguration Version=`"1.11.0.895`" Type=`"SnmpConnector`" SessionKey=`"bcafdb4e94f2572eed78525430ad0e0275229f98`">
658 + <SnmpConnectorConfiguration>
659 + <SnmpReader>
660 + <ParallelRequests>10</ParallelRequests>
661 + <SchedulingConfig>
662 + <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
663 + <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
664 + <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
665 + </SchedulingConfig>
666 + <Groups />
667 + <GlobalCredentialLists>
668 + <GlobalCredentials />
669 + <GlobalCredentialsNoPriv />
670 + <GlobalCredentialsNoAuthNoPriv />
671 + </GlobalCredentialLists>
672 + </SnmpReader>
673 + <SnmpWriters>
674 + <DescriptionWriteMode>Keep</DescriptionWriteMode>
675 + <LocationWriteMode>Ignore</LocationWriteMode>
676 + <ContactWriteMode>Ignore</ContactWriteMode>
677 + <ProcessorWriter />
678 + <DispatcherStarter />
679 + <FileDumper />
680 + </SnmpWriters>
681 + </SnmpConnectorConfiguration>
682 +</MicroserviceConfiguration>"
683 +{{/code}}
643 643  {{/apimacro}}
644 644  
645 645  === **Rückgabewerte** ===
646 646  
647 -Bei erfolgreicher Anwendung bekommt man zwei Objekte zurück.
688 +Bei erfolgreicher Anwendung erhalten Sie zwei Objekte zurück.
648 648  
649 649  * String
650 650  ** Erfolgreiche Statusmeldung
... ... @@ -660,81 +660,260 @@
660 660  ** Version
661 661  *** Die Versionierung des Templates
662 662  
663 -{{apimacro title="Rcükgabewerte der Template-Konfiguration"}}
704 +{{apimacro title="Rückgabewerte der Template-Konfiguration"}}
705 +{{code language="PowerShell" layout="LINENUMBERS"}}
706 +Successfully added template 'Test'.
664 664  
708 +TemplateId : 119398aa-8108-43bd-811b-bd3e703e7f5c
709 +Configuration : <SnmpConnectorConfiguration><SnmpReader><ParallelRequests>10</ParallelRequests><SchedulingConfig><Sched
710 + ulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling><SchedulingConfig_Interval>P1D</Scheduling
711 + Config_Interval><SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTi
712 + me></SchedulingConfig><Groups /><GlobalCredentialLists><GlobalCredentials /><GlobalCredentialsNoPriv
713 + /><GlobalCredentialsNoAuthNoPriv /></GlobalCredentialLists></SnmpReader><SnmpWriters><DescriptionWriteM
714 + ode>Keep</DescriptionWriteMode><LocationWriteMode>Ignore</LocationWriteMode><ContactWriteMode>Ignore</C
715 + ontactWriteMode><ProcessorWriter /><DispatcherStarter /><FileDumper
716 + /></SnmpWriters></SnmpConnectorConfiguration>
717 +Name : Test
718 +Type : SnmpConnector
719 +Version : 1.11.0.895
720 +{{/code}}
665 665  {{/apimacro}}
666 666  
667 -**Beispiel Template Konfiguration**
723 +== Export-MicroserviceTemplateConfig ==
668 668  
669 -|(((
670 -1
725 +Dieses Cmdlet ermöglicht es, die Konfiguration einer Microservice-Vorlagen zu exportieren.
671 671  
672 -2
727 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
728 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
729 +|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration, die exportiert werden soll.
730 +|-Path|String|❌|Keine|Der Pfad, unter dem die Microservice-Vorlagen-Konfiguration gespeichert werden soll.
673 673  
674 -3
732 +=== **Beispiele** ===
675 675  
676 -4
734 +Beispiel 1: MicroserviceTemplate exportieren
677 677  
678 -5
736 +{{code language="PowerShell"}}
737 +Export-AESBMicroserviceTemplateConfig -TemplateConfig $templateConfig -Path $path
679 679  
680 -6
739 +{{/code}}
681 681  
682 -7
741 +In diesem Beispiel wird die $templateConfig am Speicherort "C:\Test.xml" exportiert.
683 683  
684 -8
743 +{{code language="PowerShell" layout="LINENUMBERS"}}
744 +function Export-MicroserviceTemplateConfig {
745 + param (
746 + [string]$Path
747 + )
748 +
749 + $microserviceTemplates = Get-AESBMicroserviceTemplates
750 +
751 + $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $microserviceTemplates[0].Name
752 +
753 + $exportMicroserviceTemplateConfigResult = Export-AESBMicroserviceTemplateConfig -TemplateConfig $microserviceTemplateConfig -Path $Path
754 +
755 + return $exportMicroserviceTemplateConfigResult
756 +}
757 +{{/code}}
685 685  
686 -9
759 +{{apimacro title="Beispielhafte XML-Datei nach dem Exportieren"}}
760 +{{code language="XML" layout="LINENUMBERS"}}
761 +<MicroserviceConfiguration Version="1.11.0.895" Type="SnmpConnector" SessionKey="bcafdb4e94f2572eed78525430ad0e0275229f98">
762 + <SnmpConnectorConfiguration>
763 + <SnmpReader>
764 + <ParallelRequests>10</ParallelRequests>
765 + <SchedulingConfig>
766 + <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
767 + <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
768 + <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
769 + </SchedulingConfig>
770 + <Groups />
771 + <GlobalCredentialLists>
772 + <GlobalCredentials />
773 + <GlobalCredentialsNoPriv />
774 + <GlobalCredentialsNoAuthNoPriv />
775 + </GlobalCredentialLists>
776 + </SnmpReader>
777 + <SnmpWriters>
778 + <DescriptionWriteMode>Keep</DescriptionWriteMode>
779 + <LocationWriteMode>Ignore</LocationWriteMode>
780 + <ContactWriteMode>Ignore</ContactWriteMode>
781 + <ProcessorWriter />
782 + <DispatcherStarter />
783 + <FileDumper />
784 + </SnmpWriters>
785 + </SnmpConnectorConfiguration>
786 +</MicroserviceConfiguration>
787 +{{/code}}
788 +{{/apimacro}}
687 687  
688 -10
790 +=== Rückgabewerte ===
689 689  
690 -11
792 +Nach erfolgreichem Exportieren erhalten Sie eine Statusmeldung zurück.
691 691  
692 -12
794 +{{code language="none"}}
795 +Writing the file was successful.
693 693  
694 -13
797 +{{/code}}
695 695  
696 -14
697 -)))|(((
698 -Successfully added template 'Test'.
799 +== Get-AESBMicroserviceTemplateConfig ==
699 699  
801 +Dieses Cmdlet fragt die TemplateConfig einer bestimmten Microservice-Vorlage ab.
700 700  
701 -TemplateId    : 119398aa-8108-43bd-811b-bd3e703e7f5c
803 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
804 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
805 +|-TemplateName|String|❌|Keine|Der Name der Vorlage für die gewünschte Konfiguration.
702 702  
703 -Configuration : <SnmpConnectorConfiguration><SnmpReader><ParallelRequests>10</ParallelRequests><SchedulingConfig><Sched
807 +=== Beispiele ===
704 704  
705 - ulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling><SchedulingConfig_Interval>P1D</Scheduling
809 +Beispiel 1: MicroserviceTemplateConfig von $templateName anfragen
706 706  
707 - Config_Interval><SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTi
811 +{{code language="PowerShell"}}
812 +Get-AESBMicroserviceTemplateConfig -TemplateName $templateName
813 +{{/code}}
708 708  
709 - me></SchedulingConfig><Groups /><GlobalCredentialLists><GlobalCredentials /><GlobalCredentialsNoPriv
815 +Dieses Beispiel fragt die Templatekonfiguration mit dem Namen $templateName an. Die Standardverbindung wird verwendet.
710 710  
711 - /><GlobalCredentialsNoAuthNoPriv /></GlobalCredentialLists></SnmpReader><SnmpWriters><DescriptionWriteM
817 +{{code language="PowerShell" layout="LINENUMBERS"}}
818 +function Get-MicroserviceTemplateConfig {
819 +
820 + $aesbMicroserviceTemplates = Get-AESBMicroserviceTemplates
821 +
822 + $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $aesbMicroserviceTemplates[0].Name
823 +
824 + return $microserviceTemplateConfig
825 +}
826 +{{/code}}
712 712  
713 - ode>Keep</DescriptionWriteMode><LocationWriteMode>Ignore</LocationWriteMode><ContactWriteMode>Ignore</C
828 +=== Rückgabewerte ===
714 714  
715 - ontactWriteMode><ProcessorWriter /><DispatcherStarter /><FileDumper
830 +Bei erfolgreicher Anwendung erhalten Sie die gewünschte Microservice-Konfiguration zurück:
716 716  
717 - /></SnmpWriters></SnmpConnectorConfiguration>
832 +* MicroserviceConfiguration
833 +** Version
834 +*** Die jeweilige Versionierung des Microservices
835 +** Type
836 +*** Der Typ des Microservices
837 +** TypeConfiguration
838 +*** Die jeweilige Typ-Konfiguration des Microservices
718 718  
719 -Name          : Test
840 +{{code language="PowerShell"}}
841 +$microserviceTemplateConfig
842 +
843 +MicroserviceConfiguration
844 +-------------------------
845 +MicroserviceConfiguration
846 +
847 +$microserviceTemplateConfig.MicroserviceConfiguration
848 +
849 +Version Type SnmpConnectorConfiguration
850 +------- ---- --------------------------
851 +1.11.0.895 SnmpConnector SnmpConnectorConfiguration
852 +{{/code}}
720 720  
721 -Type          : SnmpConnector
854 +== Import-AESBMicroserviceTemplateConfig ==
722 722  
723 -Version       : 1.11.0.895
724 -)))
856 +Dieses Cmdlet importiert die Templatekonfiguration vom angegebenen Pfad.
725 725  
858 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
859 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservices-Vorlagen-Konfiguration importiert werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
860 +|-Path|String|❌|Keine|Der Pfad, von dem die Konfiguration importiert werden soll.
726 726  
862 +=== Beispiele ===
727 727  
728 -== Export-MicroserviceTemplateConfig ==
864 +Beispiel 1: Templatekonfiguration von $path laden
729 729  
730 -== Get-AESBMicroserviceTemplateConfig ==
866 +{{code language="PowerShell"}}
867 +Import-AESBMicroserviceTemplateConfig -Path $path
731 731  
732 -== Import-AESBMicroserviceTemplateConfig ==
869 +{{/code}}
733 733  
871 +Dieses Beispiel importiert die Templatekonfiguration beim hinterlegten Pfad. Die Standardverbindung wird verwendet.
872 +
873 +=== Rückgabewerte ===
874 +
875 +Bei erfolgreicher Anwendung erhalten Sie die gewünschte MicroserviceConfiguration zurück:
876 +
877 +* MicroserviceConfiguration
878 +** Version
879 +*** Die jeweilige Versionierung des Microservices
880 +** Type
881 +*** Der Typ des Microservices
882 +** TypeConfiguration
883 +*** Die jeweilige Typ-Konfiguration des Microservices
884 +
885 +{{code language="PowerShell"}}
886 +$microserviceTemplateConfig
887 +
888 +MicroserviceConfiguration
889 +-------------------------
890 +MicroserviceConfiguration
891 +
892 +$microserviceTemplateConfig.MicroserviceConfiguration
893 +
894 +Version Type SnmpConnectorConfiguration
895 +------- ---- --------------------------
896 +1.11.0.895 SnmpConnector SnmpConnectorConfiguration
897 +{{/code}}
898 +
734 734  == Migrate-AESBMicroserviceTemplate ==
735 735  
901 +Mit diesem Cmdlet werden bestehende Vorlagen auf die gewünschte Zielversion übertragen.
902 +
903 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
904 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Vorlagen migriert werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
905 +|-TemplateNames|String[]|❌|Keine|Hier sind die Namen der Vorlagen, die übertragen werden sollen.
906 +|-TargetVersion|String|❌|Keine|Die Zielversion, auf die die Vorlagen migriert werden sollen.
907 +|-KeepTemplateIds|SwitchParameter|✅|Keine|Hier wird festgelegt, ob die bestehenden Template-IDs gleich bleiben oder beim Migrieren neu erstellt werden sollen.
908 +
909 +=== Beispiele ===
910 +
911 +Beispiel 1: Mehrere Templates auf Version $templateVersion migrieren
912 +
913 +{{code language="PowerShell"}}
914 +Migrate-AESBMicroserviceTemplates -TemplateNames $templateNames -TargetVersion $templateVersion
915 +
916 +{{/code}}
917 +
918 +Dieses Beispiel migriert alle Templates die in $templateNames stehen auf die Version $templateVersion
919 +
920 +=== Rückgabewerte ===
921 +
922 +Bei erfolgreicher Anwendung erhalten Sie eine Liste von Template-Informationen mit den neuen Daten der erfolgreich migrierten Templates:
923 +
924 +* TemplateInfo
925 +** TemplateId
926 +*** Die neu erstellte / gleichbleibende Id des Templates
927 +** Configuration
928 +*** Die aktuelle Konfiguration des Templates
929 +** Name
930 +*** Der neue Name des Template
931 +** Type
932 +*** Der Typ des Templates
933 +** Version
934 +*** Die neue Version des Templates
935 +
936 +{{code language="PowerShell"}}
937 +TemplateId : ffffffff-ffff-ffff-ffff-ffffffffffff"
938 +Configuration : <Configuration>
939 + <SchedulingConfig>
940 + <SchedulingConfig_Scheduling>Disabled</SchedulingConfig_Scheduling>
941 + </SchedulingConfig>
942 + </Configuration>
943 +Name : TestTest_1_0_0_1
944 +Type : Test
945 +Version : 1.0.0.1
946 +{{/code}}
947 +
736 736  == New-AESBMicroserviceTemplateConfig ==
737 737  
950 +
951 +
952 +
953 +
954 +
955 +
956 +
957 +
738 738  == Remove-AESBMicroserviceTemplate ==
739 739  
740 740  == Update-AESBMicroserviceTemplate ==
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community