Changes for page Microservice Cmdlets

Last modified by jklein on 2025/08/15 09:48

From version 5.1
edited by jklein
on 2025/06/24 12:52
Change comment: There is no comment for this version
To version 4.1
edited by jklein
on 2025/06/23 10:40
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -533,6 +533,7 @@
533 533  
534 534  Mit diesem Cmdlet werden die angegebenen, laufenden Microservice-Instanzen gestoppt. Die zu stoppenden Microservices können entweder über ihre `InstanceIds` oder über eine `SupervisorId` (die alle zugehörigen Instanzen stoppt) identifiziert werden. Es muss einer der Parameter `-InstanceIds` oder `-SupervisorId` angegeben werden.
535 535  
536 +
536 536  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
537 537  |-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestoppt werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
538 538  |-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestoppt werden sollen. Obligatorisch für Parametersatz `UseSupervisorIdParameterSet`.
... ... @@ -590,141 +590,12 @@
590 590  
591 591  == Get-AESBMicroservicePackages ==
592 592  
593 -Dieses Cmdlet ruft eine Liste aller verfügbaren Microservice-Pakete und deren Versionen ab. Es sind keine spezifischen Parameter erforderlich.
594 -
595 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
596 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Informationen zu Microservice-Paketen abgerufen werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
597 -
598 -=== **Beispiele** ===
599 -
600 -Beispiel 1: Alle verfügbaren Microservice-Pakete auflisten
601 -
602 -{{code language="PowerShell"}}
603 -Get-AESBMicroservicePackages
604 -
605 -{{/code}}
606 -
607 -Dieser Befehl ruft alle verfügbaren Microservice-Pakete und die zugehörigen Versionen ab.
608 -
609 -=== **Rückgabewert** ===
610 -
611 -Das Cmdlet gibt für jedes gefundene Microservice-Paket ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
612 -
613 -* **PackageName**: Der Name des Microservice-Pakets.
614 -* **PackageVersions**: Eine Liste der verfügbaren Versionen für dieses Paket.
615 -
616 616  = Templates =
617 617  
618 618  == Add-AESBMicroserviceTemplate ==
619 619  
620 -Dieses Cmdlet fügt eine Microservice-Vorlage auf Basis der beigefügten Vorlagen-Konfiguration hinzu.
621 -
622 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
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
626 -
627 -=== **Beispiele** ===
628 -
629 -Beispiel 1: Fügt ein neues Microservice-Template hinzu
630 -
631 -{{code language="PowerShell"}}
632 -Add-AESBMicroserviceTemplate -TemplateName "Test" -TemplateConfig $templateConfig
633 -{{/code}}
634 -
635 -Dieses Beispiel fügt eine neue Templatekonfiguration mit dem Namen "Test" auf Basis des $templateConfig-Objekts hinzu. Die Standardverbindung wird verwendet.
636 -
637 -{{apimacro title="Beispiel der Funktion in PowerShell"}}
638 -{{code language="PowerShell" layout="LINENUMBERS"}}
639 -function Add-MicroserviceTemplate {
640 - param (
641 - [string]$Name
642 - )
643 -
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}}
653 -{{/apimacro}}
654 -
655 -{{apimacro title="Beispiel der Template-Konfiguration"}}
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}}
684 -{{/apimacro}}
685 -
686 -=== **Rückgabewerte** ===
687 -
688 -Bei erfolgreicher Anwendung bekommt man zwei Objekte zurück.
689 -
690 -* String
691 -** Erfolgreiche Statusmeldung
692 -* TemplateInfo
693 -** TemplateId
694 -*** ID des Templates
695 -** Configuration
696 -*** Aktuelle Konfiguration des Templates
697 -** Name
698 -*** Name des Templates
699 -** Type
700 -*** Der Typ des Templates
701 -** Version
702 -*** Die Versionierung des Templates
703 -
704 -{{apimacro title="Rückgabewerte der Template-Konfiguration"}}
705 -{{code language="PowerShell" layout="LINENUMBERS"}}
706 -Successfully added template 'Test'.
707 -
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}}
721 -{{/apimacro}}
722 -
723 723  == Export-MicroserviceTemplateConfig ==
724 724  
725 -Dieses Cmdlet ermöglicht es, die Konfiguration einer Microservice-Vorlagen zu exportieren.
726 -
727 -
728 728  == Get-AESBMicroserviceTemplateConfig ==
729 729  
730 730  == Import-AESBMicroserviceTemplateConfig ==
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community