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 9.1
edited by jklein
on 2025/07/21 08:12
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -6,14 +6,15 @@
6 6  
7 7  Mit diesem Cmdlet wird eine neue Microservice-Instanz nach der Vorlage eines Templates hinzugefügt.
8 8  
9 -|=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
10 -|-ConnectionName|Keine|String|✅|C|Der Name der Verbindung, über die die Microservice-Instanz hinzugefügt werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
11 -|-InstanceName|Keine|String|❌|Keine|Der Name der Instanz.
12 -|-TemplateName|UseTemplateName|String|❌|Keine|Der Name des Templates für die Vorlage der Instanz.
13 -|-TemplateId|UseTemplateId|String|❌|Keine|Die Id des Templates für die Vorlage der Instanz.
14 -|-SupervisorId|Keine|String|✅|Keine|Die Id des Supervisors zu der die Instanz hinzugefügt werden soll.
15 -|-StartupType|Keine|InstanceStartType|✅|Keine|Setzt die Art der Zeitplanung der Instanz.
16 -|-StoppedAfterCreation|Keine|Bool|✅|Keine|Setzt den Wert um die Instanz direkt nach der Erstellung zu starten.
9 +(% style="width:902px" %)
10 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 154px;" %)ParameterSetName|=(% style="width: 156px;" %)Datentyp|=(% style="width: 55px;" %)Optional|=(% style="width: 76px;" %)Alias|=(% style="width: 206px;" %)Beschreibung
11 +|-ConnectionName|(% style="width:154px" %)Keine|(% style="width:156px" %)String|(% style="width:55px" %)✅|(% style="width:76px" %)C|(% style="width:206px" %)Der Name der Verbindung, über die die Microservice-Instanz hinzugefügt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
12 +|-InstanceName|(% style="width:154px" %)Keine|(% style="width:156px" %)String|(% style="width:55px" %)❌|(% style="width:76px" %)Keine|(% style="width:206px" %)Der Name der Instanz.
13 +|-TemplateName|(% style="width:154px" %)UseTemplateName|(% style="width:156px" %)String|(% style="width:55px" %)❌|(% style="width:76px" %)Keine|(% style="width:206px" %)Der Name des Templates für die Vorlage der Instanz.
14 +|-TemplateId|(% style="width:154px" %)UseTemplateId|(% style="width:156px" %)String|(% style="width:55px" %)❌|(% style="width:76px" %)Keine|(% style="width:206px" %)Die Id des Templates für die Vorlage der Instanz.
15 +|-SupervisorId|(% style="width:154px" %)Keine|(% style="width:156px" %)String|(% style="width:55px" %)✅|(% style="width:76px" %)Keine|(% style="width:206px" %)Die Id des Supervisors zu der die Instanz hinzugefügt werden soll.
16 +|-StartupType|(% style="width:154px" %)Keine|(% style="width:156px" %)InstanceStartType|(% style="width:55px" %)✅|(% style="width:76px" %)Keine|(% style="width:206px" %)Setzt die Art der Zeitplanung der Instanz.
17 +|-StoppedAfterCreation|(% style="width:154px" %)Keine|(% style="width:156px" %)Bool|(% style="width:55px" %)✅|(% style="width:76px" %)Keine|(% style="width:206px" %)Setzt den Wert um die Instanz direkt nach der Erstellung zu starten.
17 17  
18 18  === **Beispiele** ===
19 19  
... ... @@ -77,7 +77,7 @@
77 77  Mit den optionalen Parametern können Sie die Ausgabe filtern und spezifische Microservices oder Instanzen abrufen.
78 78  
79 79  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
80 -|-ConnectionName|String|✅|C|Der Name der Verbindung, Informationen zu Microservice-Instanzen abgerufen werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
81 +|-ConnectionName|String|✅|C|Der Name der Verbindung, Informationen zu Microservice-Instanzen abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
81 81  |-InstanceNames|String[]|✅❌| |Gibt die Namen der Microservice-Instanzen an, die abgerufen werden sollen. Du kannst einen oder mehrere Instanznamen als String-Array übergeben.
82 82  |-SupervisorIds|String[]|✅❌| |Filtert Microservices basierend auf den IDs ihrer übergeordneten Supervisoren. Du musst eine oder mehrere Supervisor-IDs als String-Array übergeben.
83 83  |-ShowAllInstances|SwitchParameter|✅| |Wenn dieser Parameter angegeben wird, zeigt das Cmdlet alle Instanzen von Microservices an, einschließlich derer, die normalerweise ausgeblendet oder als inaktiv betrachtet werden könnten.
... ... @@ -155,12 +155,12 @@
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 ==
159 +== 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  
162 162  |=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=Datentyp|=Optional|=Beschreibung
163 -|-ConnectionName| |String|✅|Der Name der Verbindung, über die Microservice-Instanzen bearbeitet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
164 +|-ConnectionName| |String|✅|Der Name der Verbindung, über die Microservice-Instanzen bearbeitet werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
164 164  |-InstanceName|NoCredentialParameterSetName,
165 165  CredentialParameterSetName|String|❌|Gibt den eindeutigen Namen der Microservice-Instanz an, deren Konfiguration geändert werden soll. Dieser Parameter ist in beiden Parametersets obligatorisch.
166 166  |-UseCredentials|CredentialParameterSetName|SwitchParameter|✅❌|Gibt an, dass Anmeldeinformationen für den Microservice konfiguriert werden sollen. Dieser Parameter gehört zum CredentialParameterSetName und ist obligatorisch, wenn dieses Set verwendet wird.
... ... @@ -203,7 +203,7 @@
203 203  Mit diesem Cmdlet können Sie laufende Microservices gezielt beenden. Dies ist nützlich für die Wartung, Fehlerbehebung oder das Herunterfahren bestimmter Microservice-Instanzen. Das Cmdlet bietet zwei Methoden zum Ansprechen der zu beendenden Microservices: entweder direkt über deren Instanz-IDs oder indirekt über die ID ihres Supervisoren, wodurch alle zugehörigen Microservices beendet werden.
204 204  
205 205  |=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=Datentyp|=Optional|=Beschreibung
206 -|-ConnectionName| |String|✅|Der Name der Verbindung, über welche die Ausführung von Microservice-Instanzen abgebrochen werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
207 +|-ConnectionName| |String|✅|Der Name der Verbindung, über welche die Ausführung von Microservice-Instanzen abgebrochen werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
207 207  |-InstanceIds|UseMicroservicesIdListParameterSet|String[]|✅❌|Gibt eine Liste von eindeutigen Instanz-IDs (GUIDs als String) der Microservices an, die beendet werden sollen.
208 208  |-SupervisorId|UseSupervisorIdParameterSet|String|✅❌|Der **SupervisorId**-Parameter gibt die eindeutige ID (GUID als String) des Supervisors an. Alle Microservices, die von diesem spezifischen Supervisor verwaltet werden, werden beendet.
209 209  
... ... @@ -259,7 +259,7 @@
259 259  
260 260  
261 261  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
262 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen verschoben werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
263 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen verschoben werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
263 263  |-InstanceIds|String[]|❌| |Die IDs der zu verschiebenden Microservice-Instanzen (Pflichtfeld, unterstützt mehrere Werte)
264 264  |-SupervisorId|String|❌| |Die Ziel-SupervisorId, auf die die Instanzen verschoben werden sollen
265 265  |-Timeout|String|✅| |Optionales Timeout für die Operation (Standard: "30s")
... ... @@ -373,7 +373,7 @@
373 373  Mit diesem Cmdlet können Sie die angegebenen Microservice-Instanzen neu starten. Die neu zu startenden Microservices können entweder über ihre `InstanceIds` oder über eine `SupervisorId` (die alle zugehörigen Instanzen neu startet) identifiziert werden. Es muss einer der Parameter `-InstanceIds` oder `-SupervisorId` angegeben werden.
374 374  
375 375  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
376 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen neugestartet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
377 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen neugestartet werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
377 377  |-SupervisorId|String[]|❌|Keine|Gibt die Namen der Microservices an, die entfernt werden sollen. Es kann ein einzelner Name oder ein Array von Namen übergeben werden. Obligatorisch für Parametersatz ByInstanceName.
378 378  |-InstanceIds|String[]|❌|Keine|Gibt die eindeutigen Instanz-IDs (GUIDs) der Microservices an, die entfernt werden sollen. Es kann eine einzelne ID oder ein Array von IDs übergeben werden. Obligatorisch für Parametersatz ByInstanceId.
379 379  |-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Neustartvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
... ... @@ -429,7 +429,7 @@
429 429  Mit diesem Cmdlet können Sie die Logging-Einstellungen für die angegebenen Microservice-Instanzen konfigurieren. Es kann verwendet werden, um das Logging entweder zu aktivieren (mit `-Enable`) oder zu deaktivieren (mit `-Disable`). Dabei muss einer der Parameter `-Enable` oder `-Disable` zusammen mit `-InstanceIds` angegeben werden.
430 430  
431 431  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
432 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die das Logging von Microservice-Instanzen aktiviert / deaktiviert werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
433 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die das Logging von Microservice-Instanzen aktiviert / deaktiviert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
433 433  |-InstanceIds|String[]|❌|Keine|Gibt die eindeutigen Instanz-IDs (GUIDs) der Microservices an, die entfernt werden sollen. Es kann eine einzelne ID oder ein Array von IDs übergeben werden. Obligatorisch für Parametersatz ByInstanceId.
434 434  |-Enable|SwitchParameter|✅❌|Keine|Aktiviert das Logging für die angegebenen Microservices. Obligatorisch für Parametersatz `SwitchEnable`. Kann nicht zusammen mit `-Disable` verwendet werden.
435 435  |-Disable|SwitchParameter|✅❌|Keine|Deaktiviert das Logging für die angegebenen Microservices. Obligatorisch für Parametersatz `SwitchDisable`. Kann nicht zusammen mit `-Enable` verwendet werden.
... ... @@ -477,7 +477,7 @@
477 477  
478 478  
479 479  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
480 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestartet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
481 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestartet werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
481 481  |-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestartet werden sollen. Obligatorisch für Parametersatz `SupervisorParametersetName`.
482 482  |-InstanceIds|String[]|❌|Keine|Gibt die eindeutigen Instanz-IDs (GUIDs) der Microservices an, die gestartet werden sollen. Es kann eine einzelne ID oder ein Array von IDs übergeben werden. Obligatorisch für Parametersatz `InstanceIdsParametersetName`.
483 483  |-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Startvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
... ... @@ -534,7 +534,7 @@
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  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
537 -|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestoppt werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
538 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestoppt werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
538 538  |-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestoppt werden sollen. Obligatorisch für Parametersatz `UseSupervisorIdParameterSet`.
539 539  |-InstanceIds|String[]|❌|Keine|Gibt die eindeutigen Instanz-IDs (GUIDs) der Microservices an, die gestoppt werden sollen. Es kann eine einzelne ID oder ein Array von IDs übergeben werden. Obligatorisch für Parametersatz `UseMicroservicesIdListParameterSet`.
540 540  |-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Stoppvorgang an (z.B. "5s", "1m"). Standardwert: "5s".
... ... @@ -593,7 +593,7 @@
593 593  Dieses Cmdlet ruft eine Liste aller verfügbaren Microservice-Pakete und deren Versionen ab. Es sind keine spezifischen Parameter erforderlich.
594 594  
595 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 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Informationen zu Microservice-Paketen abgerufen werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
597 597  
598 598  === **Beispiele** ===
599 599  
... ... @@ -620,121 +620,528 @@
620 620  Dieses Cmdlet fügt eine Microservice-Vorlage auf Basis der beigefügten Vorlagen-Konfiguration hinzu.
621 621  
622 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
624 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die eine Vorlage hinzugefügt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
625 +|-TemplateName|String|❌|Keine|Der Name für die Vorlage.
626 +|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration der Vorlage.
626 626  
627 627  === **Beispiele** ===
628 628  
629 -Beispiel 1: Fügt ein neues Microservice-Template hinzu
630 +Beispiel 1: Fügt ein neue Microservice-Vorlage hinzu
630 630  
631 631  {{code language="PowerShell"}}
632 632  Add-AESBMicroserviceTemplate -TemplateName "Test" -TemplateConfig $templateConfig
633 633  {{/code}}
634 634  
635 -Dieses Beispiel fügt eine neue Templatekonfiguration mit dem Namen "Test" auf Basis des $templateConfig-Objekts hinzu. Die Standardverbindung wird verwendet.
636 +Dieses Beispiel fügt eine neue Vorlagen-konfiguration 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"}}
639 +{{code language="PowerShell" layout="LINENUMBERS"}}
640 +function Add-MicroserviceTemplate {
641 + param (
642 + [string]$Name
643 + )
638 638  
645 + $packages = Get-AESBMicroservicePackages
646 +
647 + $microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packages[0].PackageName -PackageVersion $packages[0].PackageVersions[0]
648 +
649 + $addMicroserviceResult = Add-AESBMicroserviceTemplate -TemplateName $Name -TemplateConfig $microserviceTemplateConfig
650 +
651 + return $addMicroserviceResult
652 +}
653 +{{/code}}
639 639  {{/apimacro}}
640 640  
641 -{{apimacro title="Beispiel der Template-Konfiguration"}}
642 -
656 +{{apimacro title="Beispiel der Vorlagen-Konfiguration"}}
657 +{{code language="PowerShell" layout="LINENUMBERS"}}
658 +$templateConfig = "<MicroserviceConfiguration Version=`"1.11.0.895`" Type=`"SnmpConnector`" SessionKey=`"bcafdb4e94f2572eed78525430ad0e0275229f98`">
659 + <SnmpConnectorConfiguration>
660 + <SnmpReader>
661 + <ParallelRequests>10</ParallelRequests>
662 + <SchedulingConfig>
663 + <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
664 + <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
665 + <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
666 + </SchedulingConfig>
667 + <Groups />
668 + <GlobalCredentialLists>
669 + <GlobalCredentials />
670 + <GlobalCredentialsNoPriv />
671 + <GlobalCredentialsNoAuthNoPriv />
672 + </GlobalCredentialLists>
673 + </SnmpReader>
674 + <SnmpWriters>
675 + <DescriptionWriteMode>Keep</DescriptionWriteMode>
676 + <LocationWriteMode>Ignore</LocationWriteMode>
677 + <ContactWriteMode>Ignore</ContactWriteMode>
678 + <ProcessorWriter />
679 + <DispatcherStarter />
680 + <FileDumper />
681 + </SnmpWriters>
682 + </SnmpConnectorConfiguration>
683 +</MicroserviceConfiguration>"
684 +{{/code}}
643 643  {{/apimacro}}
644 644  
645 645  === **Rückgabewerte** ===
646 646  
647 -Bei erfolgreicher Anwendung bekommt man zwei Objekte zurück.
689 +Bei erfolgreicher Anwendung erhalten Sie zwei Objekte zurück.
648 648  
649 649  * String
650 650  ** Erfolgreiche Statusmeldung
651 651  * TemplateInfo
652 652  ** TemplateId
653 -*** ID des Templates
695 +*** ID der Vorlage
654 654  ** Configuration
655 -*** Aktuelle Konfiguration des Templates
697 +*** Aktuelle Konfiguration der Vorlage
656 656  ** Name
657 -*** Name des Templates
699 +*** Name der Vorlage
658 658  ** Type
659 -*** Der Typ des Templates
701 +*** Der Typ der Vorlage
660 660  ** Version
661 -*** Die Versionierung des Templates
703 +*** Die Versionierung der Vorlage
662 662  
663 -{{apimacro title="Rcükgabewerte der Template-Konfiguration"}}
705 +{{apimacro title="Rückgabewerte der Vorlagen-Konfiguration"}}
706 +{{code language="PowerShell" layout="LINENUMBERS"}}
707 +Successfully added template 'Test'.
664 664  
709 +TemplateId : 119398aa-8108-43bd-811b-bd3e703e7f5c
710 +Configuration : <SnmpConnectorConfiguration><SnmpReader><ParallelRequests>10</ParallelRequests><SchedulingConfig><Sched
711 + ulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling><SchedulingConfig_Interval>P1D</Scheduling
712 + Config_Interval><SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTi
713 + me></SchedulingConfig><Groups /><GlobalCredentialLists><GlobalCredentials /><GlobalCredentialsNoPriv
714 + /><GlobalCredentialsNoAuthNoPriv /></GlobalCredentialLists></SnmpReader><SnmpWriters><DescriptionWriteM
715 + ode>Keep</DescriptionWriteMode><LocationWriteMode>Ignore</LocationWriteMode><ContactWriteMode>Ignore</C
716 + ontactWriteMode><ProcessorWriter /><DispatcherStarter /><FileDumper
717 + /></SnmpWriters></SnmpConnectorConfiguration>
718 +Name : Test
719 +Type : SnmpConnector
720 +Version : 1.11.0.895
721 +{{/code}}
665 665  {{/apimacro}}
666 666  
667 -**Beispiel Template Konfiguration**
724 +== Export-MicroserviceTemplateConfig ==
668 668  
669 -|(((
670 -1
726 +Dieses Cmdlet ermöglicht es, die Konfiguration einer Microservice-Vorlagen zu exportieren.
671 671  
672 -2
728 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
729 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
730 +|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration, die exportiert werden soll.
731 +|-Path|String|❌|Keine|Der Pfad, unter dem die Microservice-Vorlagen-Konfiguration gespeichert werden soll.
673 673  
674 -3
733 +=== **Beispiele** ===
675 675  
676 -4
735 +Beispiel 1: MicroserviceTemplate exportieren
677 677  
678 -5
737 +{{code language="PowerShell"}}
738 +Export-AESBMicroserviceTemplateConfig -TemplateConfig $templateConfig -Path $path
679 679  
680 -6
740 +{{/code}}
681 681  
682 -7
742 +In diesem Beispiel wird die //$templateConfig// am Speicherort "C:\Test.xml" exportiert.
683 683  
684 -8
744 +{{code language="PowerShell" layout="LINENUMBERS"}}
745 +function Export-MicroserviceTemplateConfig {
746 + param (
747 + [string]$Path
748 + )
749 +
750 + $microserviceTemplates = Get-AESBMicroserviceTemplates
751 +
752 + $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $microserviceTemplates[0].Name
753 +
754 + $exportMicroserviceTemplateConfigResult = Export-AESBMicroserviceTemplateConfig -TemplateConfig $microserviceTemplateConfig -Path $Path
755 +
756 + return $exportMicroserviceTemplateConfigResult
757 +}
758 +{{/code}}
685 685  
686 -9
760 +{{apimacro title="Beispielhafte XML-Datei nach dem Exportieren"}}
761 +{{code language="XML" layout="LINENUMBERS"}}
762 +<MicroserviceConfiguration Version="1.11.0.895" Type="SnmpConnector" SessionKey="bcafdb4e94f2572eed78525430ad0e0275229f98">
763 + <SnmpConnectorConfiguration>
764 + <SnmpReader>
765 + <ParallelRequests>10</ParallelRequests>
766 + <SchedulingConfig>
767 + <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
768 + <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
769 + <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
770 + </SchedulingConfig>
771 + <Groups />
772 + <GlobalCredentialLists>
773 + <GlobalCredentials />
774 + <GlobalCredentialsNoPriv />
775 + <GlobalCredentialsNoAuthNoPriv />
776 + </GlobalCredentialLists>
777 + </SnmpReader>
778 + <SnmpWriters>
779 + <DescriptionWriteMode>Keep</DescriptionWriteMode>
780 + <LocationWriteMode>Ignore</LocationWriteMode>
781 + <ContactWriteMode>Ignore</ContactWriteMode>
782 + <ProcessorWriter />
783 + <DispatcherStarter />
784 + <FileDumper />
785 + </SnmpWriters>
786 + </SnmpConnectorConfiguration>
787 +</MicroserviceConfiguration>
788 +{{/code}}
789 +{{/apimacro}}
687 687  
688 -10
791 +=== Rückgabewerte ===
689 689  
690 -11
793 +Nach erfolgreichem Exportieren erhalten Sie eine Statusmeldung zurück.
691 691  
692 -12
795 +{{code language="none"}}
796 +Writing the file was successful.
693 693  
694 -13
798 +{{/code}}
695 695  
696 -14
697 -)))|(((
698 -Successfully added template 'Test'.
800 +== Get-AESBMicroserviceTemplateConfig ==
699 699  
802 +Dieses Cmdlet fragt die TemplateConfig einer bestimmten Microservice-Vorlage ab.
700 700  
701 -TemplateId    : 119398aa-8108-43bd-811b-bd3e703e7f5c
804 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
805 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
806 +|-TemplateName|String|❌|Keine|Der Name der Vorlage für die gewünschte Konfiguration.
702 702  
703 -Configuration : <SnmpConnectorConfiguration><SnmpReader><ParallelRequests>10</ParallelRequests><SchedulingConfig><Sched
808 +=== Beispiele ===
704 704  
705 - ulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling><SchedulingConfig_Interval>P1D</Scheduling
810 +Beispiel 1: MicroserviceTemplateConfig von //$templateName// anfragen
706 706  
707 - Config_Interval><SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTi
812 +{{code language="PowerShell"}}
813 +Get-AESBMicroserviceTemplateConfig -TemplateName $templateName
814 +{{/code}}
708 708  
709 - me></SchedulingConfig><Groups /><GlobalCredentialLists><GlobalCredentials /><GlobalCredentialsNoPriv
816 +Dieses Beispiel fragt die Templatekonfiguration mit dem Namen //$templateName// an. Die Standardverbindung wird verwendet.
710 710  
711 - /><GlobalCredentialsNoAuthNoPriv /></GlobalCredentialLists></SnmpReader><SnmpWriters><DescriptionWriteM
818 +{{code language="PowerShell" layout="LINENUMBERS"}}
819 +function Get-MicroserviceTemplateConfig {
820 +
821 + $aesbMicroserviceTemplates = Get-AESBMicroserviceTemplates
822 +
823 + $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $aesbMicroserviceTemplates[0].Name
824 +
825 + return $microserviceTemplateConfig
826 +}
827 +{{/code}}
712 712  
713 - ode>Keep</DescriptionWriteMode><LocationWriteMode>Ignore</LocationWriteMode><ContactWriteMode>Ignore</C
829 +=== ckgabewerte ===
714 714  
715 - ontactWriteMode><ProcessorWriter /><DispatcherStarter /><FileDumper
831 +Bei erfolgreicher Anwendung erhalten Sie die gewünschte Microservice-Konfiguration zurück:
716 716  
717 - /></SnmpWriters></SnmpConnectorConfiguration>
833 +* MicroserviceConfiguration
834 +** Version
835 +*** Die jeweilige Versionierung des Microservices
836 +** Type
837 +*** Der Typ des Microservices
838 +** TypeConfiguration
839 +*** Die jeweilige Typ-Konfiguration des Microservices
718 718  
719 -Name          : Test
841 +{{code language="PowerShell"}}
842 +$microserviceTemplateConfig
843 +
844 +MicroserviceConfiguration
845 +-------------------------
846 +MicroserviceConfiguration
847 +
848 +$microserviceTemplateConfig.MicroserviceConfiguration
849 +
850 +Version Type SnmpConnectorConfiguration
851 +------- ---- --------------------------
852 +1.11.0.895 SnmpConnector SnmpConnectorConfiguration
853 +{{/code}}
720 720  
721 -Type          : SnmpConnector
855 +== Get-AESBMicroserviceTemplates ==
722 722  
723 -Version       : 1.11.0.895
724 -)))
857 +Dieses Cmdlet fragt die vorhandenen Microservice-Vorlagen ab und listet sie auf.
725 725  
859 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
860 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservices-Vorlagen-Konfiguration importiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
861 +|-PackageName|String|✅| |Der Name des Microservice-Pakets, dessen Vorlagen geholt werden sollen
862 +|-PackageVersion|String|✅| |Die Version des Pakets, dessen Vorlagen geholt werden sollen
726 726  
864 +=== Beispiele ===
727 727  
728 -== Export-MicroserviceTemplateConfig ==
866 +Beispiel 1: Alle vorhandenen Microservice-Vorlagen anzeigen
729 729  
730 -== Get-AESBMicroserviceTemplateConfig ==
868 +{{code language="PowerShell"}}
869 +Get-AESBMicroserviceTemplates
870 +{{/code}}
731 731  
872 +Dieses Beispiel listet alle vorhandenen Microservice-Vorlagen auf. Die Standardverbindung wird verwendet. Falls keine Vorlagen vorhanden sind, wird ein Fehler angezeigt.
873 +
874 +Beispiel 2: Die Vorlagen eines bestimmten Microservice-Pakets einer bestimmten Version auflisten
875 +
876 +{{code language="PowerShell"}}
877 +Get-AESBMicroserviceTemplates -PackageName "SnmpConnector" -PackageVersion "1.11.0.895"
878 +
879 +{{/code}}
880 +
881 + Dieses Beispiel listet alle vorhandenen Microservice-Vorlagen des Pakets "SnmpConnector" in der Version "1.11.0.895" auf. Die Standardverbindung wird verwendet.
882 +
883 +=== Rückgabewerte ===
884 +
885 +Bei erfolgreicher Anwendung werden die gewünschten Microservice-Vorlagen als Objekte aufgelistet.
886 +
887 +* MicroserviceTemplate
888 +** Name
889 +*** Der Name des Templates
890 +** Id
891 +*** Die Id des Templates
892 +** PackageName
893 +*** Der Name des Microservice-Pakets
894 +** PackageVersion
895 +*** Die Version des Microservice-Pakets
896 +
897 +{{code language="PowerShell"}}
898 +Name Id PackageName PackageVersion
899 +
900 +---- -- ----------- --------------
901 +
902 +SnmpConnector a6e37f49-5a15-4213-96f5-e23cc03209a8 SnmpConnector 1.11.0.895
903 +
904 +PS_Microservice1 33618fc3-60f2-484b-b6c9-b9f19c5eb4fa PS_Microservice1 1.1.0.1
905 +{{/code}}
906 +
732 732  == Import-AESBMicroserviceTemplateConfig ==
733 733  
909 +Dieses Cmdlet importiert die Templatekonfiguration vom angegebenen Pfad.
910 +
911 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
912 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservices-Vorlagen-Konfiguration importiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
913 +|-Path|String|❌|Keine|Der Pfad, von dem die Konfiguration importiert werden soll.
914 +
915 +=== Beispiele ===
916 +
917 +Beispiel 1: Templatekonfiguration von //$path// laden
918 +
919 +{{code language="PowerShell"}}
920 +Import-AESBMicroserviceTemplateConfig -Path $path
921 +
922 +{{/code}}
923 +
924 +Dieses Beispiel importiert die Templatekonfiguration beim hinterlegten Pfad. Die Standardverbindung wird verwendet.
925 +
926 +=== Rückgabewerte ===
927 +
928 +Bei erfolgreicher Anwendung erhalten Sie die gewünschte MicroserviceConfiguration zurück:
929 +
930 +* MicroserviceConfiguration
931 +** Version
932 +*** Die jeweilige Versionierung des Microservices
933 +** Type
934 +*** Der Typ des Microservices
935 +** TypeConfiguration
936 +*** Die jeweilige Typ-Konfiguration des Microservices
937 +
938 +{{code language="PowerShell"}}
939 +$microserviceTemplateConfig
940 +
941 +MicroserviceConfiguration
942 +-------------------------
943 +MicroserviceConfiguration
944 +
945 +$microserviceTemplateConfig.MicroserviceConfiguration
946 +
947 +Version Type SnmpConnectorConfiguration
948 +------- ---- --------------------------
949 +1.11.0.895 SnmpConnector SnmpConnectorConfiguration
950 +{{/code}}
951 +
734 734  == Migrate-AESBMicroserviceTemplate ==
735 735  
954 +Mit diesem Cmdlet werden bestehende Vorlagen auf die gewünschte Zielversion übertragen.
955 +
956 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
957 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Vorlagen migriert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
958 +|-TemplateNames|String[]|❌|Keine|Hier sind die Namen der Vorlagen, die übertragen werden sollen.
959 +|-TargetVersion|String|❌|Keine|Die Zielversion, auf die die Vorlagen migriert werden sollen.
960 +|-KeepTemplateIds|SwitchParameter|✅|Keine|Hier wird festgelegt, ob die bestehenden Template-IDs gleich bleiben oder beim Migrieren neu erstellt werden sollen.
961 +
962 +=== Beispiele ===
963 +
964 +Beispiel 1: Mehrere Templates auf Version //$templateVersion// migrieren
965 +
966 +{{code language="PowerShell"}}
967 +Migrate-AESBMicroserviceTemplates -TemplateNames $templateNames -TargetVersion $templateVersion
968 +
969 +{{/code}}
970 +
971 +Dieses Beispiel migriert alle Templates die in //$templateNames// stehen auf die Version //$templateVersion//.
972 +
973 +=== Rückgabewerte ===
974 +
975 +Bei erfolgreicher Anwendung erhalten Sie eine Liste von Template-Informationen mit den neuen Daten der erfolgreich migrierten Templates:
976 +
977 +* TemplateInfo
978 +** TemplateId
979 +*** Die neu erstellte / gleichbleibende Id des Templates
980 +** Configuration
981 +*** Die aktuelle Konfiguration des Templates
982 +** Name
983 +*** Der neue Name des Template
984 +** Type
985 +*** Der Typ des Templates
986 +** Version
987 +*** Die neue Version des Templates
988 +
989 +{{code language="PowerShell"}}
990 +TemplateId : ffffffff-ffff-ffff-ffff-ffffffffffff"
991 +Configuration : <Configuration>
992 + <SchedulingConfig>
993 + <SchedulingConfig_Scheduling>Disabled</SchedulingConfig_Scheduling>
994 + </SchedulingConfig>
995 + </Configuration>
996 +Name : TestTest_1_0_0_1
997 +Type : Test
998 +Version : 1.0.0.1
999 +{{/code}}
1000 +
736 736  == New-AESBMicroserviceTemplateConfig ==
737 737  
1003 +Mit diesem Cmdlet wird eine neue Vorlagen-Konfiguration auf Basis des Pakets erstellt.
1004 +
1005 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
1006 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration erstellt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
1007 +|-PackageName|String|❌|Keine|Der Name des Pakets.
1008 +|-PackageVersion|String|❌|Keine|Die Version des Pakets.
1009 +
1010 +=== Beispiele ===
1011 +
1012 +Beispiel 1: MicroserviceTemplateConfig erstellen
1013 +
1014 +{{code language="PowerShell" layout="LINENUMBERS"}}
1015 +$packageVersion = "1.0.0.0"
1016 +$packageName = "Test"
1017 +
1018 +New-AESBMicroserviceTemplateConfig -PackageName $packageName -PackageVersion $packageVersion
1019 +{{/code}}
1020 +
1021 +Dieses Beispiel erstellt eine Template-Konfiguration auf Basis des angegebenen Microservicepackage.
1022 +
1023 +=== Rückgabewerte ===
1024 +
1025 +* MicroserviceConfiguration
1026 +** Version
1027 +*** Die neue Version des Templates
1028 +** Type
1029 +*** Der Typ des Templates
1030 +** Configuration
1031 +*** Die aktuelle Konfiguration des Templates
1032 +
1033 +{{code language="PowerShell" layout="LINENUMBERS"}}
1034 +$microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packageName -PackageVersion $packageVersion
1035 +
1036 +MicroserviceConfiguration
1037 +-------------------------
1038 +MicroserviceConfiguration
1039 +
1040 +$microserviceTemplateConfig.MicroserviceConfiguration
1041 +
1042 +Version Type Configuration
1043 +------- ---- -------------
1044 +1.0.0.0 Test Configuration
1045 +{{/code}}
1046 +
738 738  == Remove-AESBMicroserviceTemplate ==
739 739  
1049 +Mit diesem Cmdlet können Sie Microservice-Vorlagen löschen.
1050 +
1051 +
1052 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
1053 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen gelöscht werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
1054 +|-TemplateIds|String[]|❌|Keine|Die ID's der Vorlagen, die zu löschen sind.
1055 +|-RemoveReferences|SwitchParameter|✅|Keine|Gibt an ob alle erstellten Referenzen der Vorlagen mitgelöscht werden sollen.
1056 +
1057 +=== Beispiele ===
1058 +
1059 +Beispiel 1: Template löschen
1060 +
1061 +{{code language="PowerShell"}}
1062 +Remove-AESBMicroserviceTemplate -TemplateIds 4b016fd1-47fb-4f24-87dd-4e365fe870d3
1063 +
1064 +{{/code}}
1065 +
1066 +Dieses Beispiel löscht ein Microservice Template auf Basis der angegebenen Id.
1067 +
1068 +Beispiel 2: Templates löschen
1069 +
1070 +{{code language="PowerShell"}}
1071 +Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3", "D1936807-E1B0-4F8B-AB7F-98ECD202CF8F"
1072 +{{/code}}
1073 +
1074 +Dieses Beispiel löscht mehrere Microservice Templates auf Basis der angegebenen Ids.
1075 +
1076 +Beispiel 3: Templates löschen mitsamt den Referenzen
1077 +
1078 +{{code language="PowerShell"}}
1079 +Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3" -RemoveReferences
1080 +
1081 +{{/code}}
1082 +
1083 +Dieses Beispiel löscht ein Microservice Template misamt den erstellten Referenzen des Templates.
1084 +
1085 +=== Rückgabewerte ===
1086 +
1087 +* RemoveMicroserviceTemplateStatusData
1088 +** StatusResult
1089 +*** Ergebnis des Resultats des Vorgangs
1090 +** TemplateId
1091 +*** Die erfolgreich gelöschte Id des Templates
1092 +** Message
1093 +*** Status Nachricht
1094 +
1095 +{{code language="PowerShell"}}
1096 +StatusResult TemplateId Message
1097 +------------ ---------- -------
1098 + Success bde8016f-8557-4438-a165-ab05a4a78db4 The template was successfully removed.
1099 +{{/code}}
1100 +
740 740  == Update-AESBMicroserviceTemplate ==
1102 +
1103 +Dieses Cmdlet aktualisiert die Microservice-Vorlage mittels der beigefügten Microservice-Vorlagen-Konfiguration.
1104 +
1105 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
1106 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlage aktualisiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
1107 +|-TemplateId|String|❌|Keine|Die ID der Vorlage, die aktualisiert werden soll.
1108 +|-TemplateConfig|XmlDocument|❌|Keine|Die neue Microservices-Vorlagen-Konfiguration, die die aktuelle Konfiguration überschreiben soll. 
1109 +
1110 +=== Beispiele ===
1111 +
1112 +Beispiel 1: Template updaten
1113 +
1114 +{{code language="PowerShell" layout="LINENUMBERS"}}
1115 +$templateConfiguration = <MicroserviceConfiguration Version="1.0.0.0" Type="Test" SessionKey="72962557bb8bbd00b53dcb53d99cea685ed636bf">
1116 + <Configuration>
1117 + <SchedulingConfig>
1118 + <SchedulingConfig_Scheduling>Enabled</SchedulingConfig_Scheduling>
1119 + </SchedulingConfig>
1120 + </Configuration>
1121 +</MicroserviceConfiguration>
1122 +
1123 +
1124 +Update-AESBMicroserviceTemplate -TemplateId "838fb7e2-e293-4004-9602-7223aaa3854a" -TemplateConfig $templateConfiguration
1125 +{{/code}}
1126 +
1127 +Dieses Beispiel updated das Template mit der beigefügten Konfiguration.
1128 +
1129 +=== Rückgabewerte ===
1130 +
1131 +* Templateinfo
1132 +** TemplateId
1133 +** Configuration
1134 +** Name
1135 +** Type
1136 +** Version
1137 +
1138 +{{code language="PowerShell"}}
1139 +TemplateId : 838fb7e2-e293-4004-9602-7223aaa3854a
1140 +Configuration : <Configuration>
1141 + <SchedulingConfig>
1142 + <SchedulingConfig_Scheduling>Enabled</SchedulingConfig_Scheduling>
1143 + </SchedulingConfig>
1144 + </Configuration>
1145 +Name : ASDASDASD
1146 +Type : ASD
1147 +Version : 1.0.0.0
1148 +{{/code}}
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community