Changes for page Microservice Cmdlets
Last modified by jklein on 2025/08/15 09:48
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -7,7 +7,7 @@ 7 7 Mit diesem Cmdlet wird eine neue Microservice-Instanz nach der Vorlage eines Templates hinzugefügt. 8 8 9 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.10 +|-ConnectionName|Keine|String|✅|C|Der Name der Verbindung, über die die Microservice-Instanz hinzugefügt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet. 11 11 |-InstanceName|Keine|String|❌|Keine|Der Name der Instanz. 12 12 |-TemplateName|UseTemplateName|String|❌|Keine|Der Name des Templates für die Vorlage der Instanz. 13 13 |-TemplateId|UseTemplateId|String|❌|Keine|Die Id des Templates für die Vorlage der Instanz. ... ... @@ -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.80 +|-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-AESBMicroservice s==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 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.163 +|-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.206 +|-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.262 +|-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.376 +|-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.432 +|-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.480 +|-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.537 +|-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.596 +|-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,9 +620,9 @@ 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 623 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die eine Vorlage hinzugefügt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet. 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 ... ... @@ -634,262 +634,462 @@ 634 634 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 - 638 -**Beispiel Funktion in PowerShell** 639 - 640 -|((( 641 -1 642 - 643 -2 644 - 645 -3 646 - 647 -4 648 - 649 -5 650 - 651 -6 652 - 653 -7 654 - 655 -8 656 - 657 -9 658 - 659 -10 660 - 661 -11 662 - 663 -12 664 - 665 -13 666 -)))|((( 667 -function Add-MicroserviceTemplate { 668 - 637 +{{apimacro title="Beispiel der Funktion in PowerShell"}} 638 +{{code language="PowerShell" layout="LINENUMBERS"}} 639 +function Add-MicroserviceTemplate { 669 669 param ( 670 - 671 671 [string]$Name 672 - 673 673 ) 674 - 675 - 676 - $packages = Get-AESBMicroservicePackages 677 - 678 - 679 - $microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packages[0].PackageName -PackageVersion $packages[0].PackageVersions[0] 680 - 681 - 682 - $addMicroserviceResult = Add-AESBMicroserviceTemplate -TemplateName $Name -TemplateConfig $microserviceTemplateConfig 683 - 684 - 685 - return $addMicroserviceResult 686 - 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 687 687 } 688 -))) 652 +{{/code}} 653 +{{/apimacro}} 689 689 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}} 690 690 686 +=== **Rückgabewerte** === 691 691 692 - **BeispielTemplateKonfiguration**688 +Bei erfolgreicher Anwendung erhalten Sie zwei Objekte zurück. 693 693 694 -|((( 695 -1 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 696 696 697 -2 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}} 698 698 699 - 3723 +== Export-MicroserviceTemplateConfig == 700 700 701 - 4725 +Dieses Cmdlet ermöglicht es, die Konfiguration einer Microservice-Vorlagen zu exportieren. 702 702 703 -5 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. Wenn nicht angegeben, wird die Standardverbindung verwendet. 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. 704 704 705 - 6732 +=== **Beispiele** === 706 706 707 - 7734 +Beispiel 1: MicroserviceTemplate exportieren 708 708 709 -8 736 +{{code language="PowerShell"}} 737 +Export-AESBMicroserviceTemplateConfig -TemplateConfig $templateConfig -Path $path 710 710 711 - 9739 +{{/code}} 712 712 713 - 10741 +In diesem Beispiel wird die //$templateConfig// am Speicherort "C:\Test.xml" exportiert. 714 714 715 -11 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}} 716 716 717 -12 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}} 718 718 719 - 13790 +=== Rückgabewerte === 720 720 721 - 14792 +Nach erfolgreichem Exportieren erhalten Sie eine Statusmeldung zurück. 722 722 723 -15 794 +{{code language="none"}} 795 +Writing the file was successful. 724 724 725 - 16797 +{{/code}} 726 726 727 - 17799 +== Get-AESBMicroserviceTemplateConfig == 728 728 729 - 18801 +Dieses Cmdlet fragt die TemplateConfig einer bestimmten Microservice-Vorlage ab. 730 730 731 -19 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. Wenn nicht angegeben, wird die Standardverbindung verwendet. 805 +|-TemplateName|String|❌|Keine|Der Name der Vorlage für die gewünschte Konfiguration. 732 732 733 - 20807 +=== Beispiele === 734 734 735 - 21809 +Beispiel 1: MicroserviceTemplateConfig von //$templateName// anfragen 736 736 737 -22 811 +{{code language="PowerShell"}} 812 +Get-AESBMicroserviceTemplateConfig -TemplateName $templateName 813 +{{/code}} 738 738 739 - 23815 +Dieses Beispiel fragt die Templatekonfiguration mit dem Namen //$templateName// an. Die Standardverbindung wird verwendet. 740 740 741 -24 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}} 742 742 743 - 25828 +=== Rückgabewerte === 744 744 745 -26 746 -)))|((( 747 -$templateConfig = "<MicroserviceConfiguration Version=`"1.11.0.895`" Type=`"SnmpConnector`" SessionKey=`"bcafdb4e94f2572eed78525430ad0e0275229f98`"> 830 +Bei erfolgreicher Anwendung erhalten Sie die gewünschte Microservice-Konfiguration zurück: 748 748 749 - <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 750 750 751 - <SnmpReader> 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}} 752 752 753 - <ParallelRequests>10</ParallelRequests>854 +== Import-AESBMicroserviceTemplateConfig == 754 754 755 - <SchedulingConfig>856 +Dieses Cmdlet importiert die Templatekonfiguration vom angegebenen Pfad. 756 756 757 - <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling> 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. Wenn nicht angegeben, wird die Standardverbindung verwendet. 860 +|-Path|String|❌|Keine|Der Pfad, von dem die Konfiguration importiert werden soll. 758 758 759 - <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>862 +=== Beispiele === 760 760 761 - <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>864 +Beispiel 1: Templatekonfiguration von //$path// laden 762 762 763 - </SchedulingConfig> 866 +{{code language="PowerShell"}} 867 +Import-AESBMicroserviceTemplateConfig -Path $path 764 764 765 - <Groups/>869 +{{/code}} 766 766 767 - <GlobalCredentialLists>871 +Dieses Beispiel importiert die Templatekonfiguration beim hinterlegten Pfad. Die Standardverbindung wird verwendet. 768 768 769 - <GlobalCredentials/>873 +=== Rückgabewerte === 770 770 771 - <GlobalCredentialsNoPriv/>875 +Bei erfolgreicher Anwendung erhalten Sie die gewünschte MicroserviceConfiguration zurück: 772 772 773 - <GlobalCredentialsNoAuthNoPriv /> 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 774 774 775 - </GlobalCredentialLists> 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}} 776 776 777 - </SnmpReader>899 +== Migrate-AESBMicroserviceTemplate == 778 778 779 - <SnmpWriters>901 +Mit diesem Cmdlet werden bestehende Vorlagen auf die gewünschte Zielversion übertragen. 780 780 781 - <DescriptionWriteMode>Keep</DescriptionWriteMode> 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. Wenn nicht angegeben, wird die Standardverbindung verwendet. 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. 782 782 783 - <LocationWriteMode>Ignore</LocationWriteMode>909 +=== Beispiele === 784 784 785 - <ContactWriteMode>Ignore</ContactWriteMode>911 +Beispiel 1: Mehrere Templates auf Version //$templateVersion// migrieren 786 786 787 - <ProcessorWriter /> 913 +{{code language="PowerShell"}} 914 +Migrate-AESBMicroserviceTemplates -TemplateNames $templateNames -TargetVersion $templateVersion 788 788 789 - <DispatcherStarter />916 +{{/code}} 790 790 791 - <FileDumper/>918 +Dieses Beispiel migriert alle Templates die in //$templateNames// stehen auf die Version //$templateVersion//. 792 792 793 - </SnmpWriters>920 +=== Rückgabewerte === 794 794 795 - </SnmpConnectorConfiguration>922 +Bei erfolgreicher Anwendung erhalten Sie eine Liste von Template-Informationen mit den neuen Daten der erfolgreich migrierten Templates: 796 796 797 -</MicroserviceConfiguration>" 798 -))) 799 - 800 - 801 - 802 -==== 12.2. **Rückgabewerte** ==== 803 - 804 -Bei erfolgreicher Anwendung bekommt man zwei Objekte zurück. 805 - 806 -* String 807 -** Erfolgreiche Statusmeldung 808 808 * TemplateInfo 809 809 ** TemplateId 810 -*** ID des Templates926 +*** Die neu erstellte / gleichbleibende Id des Templates 811 811 ** Configuration 812 -*** Aktuelle Konfiguration des Templates928 +*** Die aktuelle Konfiguration des Templates 813 813 ** Name 814 -*** Name des Template s930 +*** Der neue Name des Template 815 815 ** Type 816 816 *** Der Typ des Templates 817 817 ** Version 818 -*** Die Version ierungdes Templates934 +*** Die neue Version des Templates 819 819 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}} 820 820 948 +== New-AESBMicroserviceTemplateConfig == 821 821 822 - **Beispiel Template Konfiguration**950 +Mit diesem Cmdlet wird eine neue Vorlagen-Konfiguration auf Basis des Pakets erstellt. 823 823 824 -|((( 825 -1 952 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung 953 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration erstellt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet. 954 +|-PackageName|String|❌|Keine|Der Name des Pakets. 955 +|-PackageVersion|String|❌|Keine|Die Version des Pakets. 826 826 827 - 2957 +=== Beispiele === 828 828 829 - 3959 +Beispiel 1: MicroserviceTemplateConfig erstellen 830 830 831 -4 961 +{{code language="PowerShell" layout="LINENUMBERS"}} 962 +$packageVersion = "1.0.0.0" 963 +$packageName = "Test" 964 + 965 +New-AESBMicroserviceTemplateConfig -PackageName $packageName -PackageVersion $packageVersion 966 +{{/code}} 832 832 833 - 5968 +Dieses Beispiel erstellt eine Template-Konfiguration auf Basis des angegebenen Microservicepackage. 834 834 835 - 6970 +=== Rückgabewerte === 836 836 837 -7 972 +* MicroserviceConfiguration 973 +** Version 974 +*** Die neue Version des Templates 975 +** Type 976 +*** Der Typ des Templates 977 +** Configuration 978 +*** Die aktuelle Konfiguration des Templates 838 838 839 -8 980 +{{code language="PowerShell" layout="LINENUMBERS"}} 981 +$microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packageName -PackageVersion $packageVersion 982 + 983 +MicroserviceConfiguration 984 +------------------------- 985 +MicroserviceConfiguration 986 + 987 +$microserviceTemplateConfig.MicroserviceConfiguration 988 + 989 +Version Type Configuration 990 +------- ---- ------------- 991 +1.0.0.0 Test Configuration 992 +{{/code}} 840 840 841 - 9994 +== Remove-AESBMicroserviceTemplate == 842 842 843 - 10996 +Mit diesem Cmdlet können Sie Microservice-Vorlagen löschen. 844 844 845 -11 846 846 847 -12 999 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung 1000 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen gelöscht werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet. 1001 +|-TemplateIds|String[]|❌|Keine|Die ID's der Vorlagen, die zu löschen sind. 1002 +|-RemoveReferences|SwitchParameter|✅|Keine|Gibt an ob alle erstellten Referenzen der Vorlagen mitgelöscht werden sollen. 848 848 849 - 131004 +=== Beispiele === 850 850 851 -14 852 -)))|((( 853 -Successfully added template 'Test'. 1006 +Beispiel 1: Template löschen 854 854 1008 +{{code language="PowerShell"}} 1009 +Remove-AESBMicroserviceTemplate -TemplateIds 4b016fd1-47fb-4f24-87dd-4e365fe870d3 855 855 856 - TemplateId: 119398aa-8108-43bd-811b-bd3e703e7f5c1011 +{{/code}} 857 857 858 - Configuration: <SnmpConnectorConfiguration><SnmpReader><ParallelRequests>10</ParallelRequests><SchedulingConfig><Sched1013 +Dieses Beispiel löscht ein Microservice Template auf Basis der angegebenen Id. 859 859 860 - ulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling><SchedulingConfig_Interval>P1D</Scheduling1015 +Beispiel 2: Templates löschen 861 861 862 - Config_Interval><SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTi 1017 +{{code language="PowerShell"}} 1018 +Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3", "D1936807-E1B0-4F8B-AB7F-98ECD202CF8F" 1019 +{{/code}} 863 863 864 - me></SchedulingConfig><Groups/><GlobalCredentialLists><GlobalCredentials/><GlobalCredentialsNoPriv1021 +Dieses Beispiel löscht mehrere Microservice Templates auf Basis der angegebenen Ids. 865 865 866 - /><GlobalCredentialsNoAuthNoPriv/></GlobalCredentialLists></SnmpReader><SnmpWriters><DescriptionWriteM1023 +Beispiel 3: Templates löschen mitsamt den Referenzen 867 867 868 - ode>Keep</DescriptionWriteMode><LocationWriteMode>Ignore</LocationWriteMode><ContactWriteMode>Ignore</C 1025 +{{code language="PowerShell"}} 1026 +Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3" -RemoveReferences 869 869 870 - ontactWriteMode><ProcessorWriter /><DispatcherStarter /><FileDumper1028 +{{/code}} 871 871 872 - /></SnmpWriters></SnmpConnectorConfiguration>1030 +Dieses Beispiel löscht ein Microservice Template misamt den erstellten Referenzen des Templates. 873 873 874 - Name: Test1032 +=== Rückgabewerte === 875 875 876 -Type : SnmpConnector 1034 +* RemoveMicroserviceTemplateStatusData 1035 +** StatusResult 1036 +*** Ergebnis des Resultats des Vorgangs 1037 +** TemplateId 1038 +*** Die erfolgreich gelöschte Id des Templates 1039 +** Message 1040 +*** Status Nachricht 877 877 878 -Version : 1.11.0.895 879 -))) 1042 +{{code language="PowerShell"}} 1043 +StatusResult TemplateId Message 1044 +------------ ---------- ------- 1045 + Success bde8016f-8557-4438-a165-ab05a4a78db4 The template was successfully removed. 1046 +{{/code}} 880 880 1048 +== Update-AESBMicroserviceTemplate == 881 881 1050 +Dieses Cmdlet aktualisiert die Microservice-Vorlage mittels der beigefügten Microservice-Vorlagen-Konfiguration. 882 882 883 -== Export-MicroserviceTemplateConfig == 1052 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung 1053 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlage aktualisiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet. 1054 +|-TemplateId|String|❌|Keine|Die ID der Vorlage, die aktualisiert werden soll. 1055 +|-TemplateConfig|XmlDocument|❌|Keine|Die neue Microservices-Vorlagen-Konfiguration, die die aktuelle Konfiguration überschreiben soll. 884 884 885 -== Get-AESBMicroserviceTemplateConfig==1057 +=== Beispiele === 886 886 887 - == Import-AESBMicroserviceTemplateConfig==1059 +Beispiel 1: Template updaten 888 888 889 -== Migrate-AESBMicroserviceTemplate == 1061 +{{code language="PowerShell" layout="LINENUMBERS"}} 1062 +$templateConfiguration = <MicroserviceConfiguration Version="1.0.0.0" Type="Test" SessionKey="72962557bb8bbd00b53dcb53d99cea685ed636bf"> 1063 + <Configuration> 1064 + <SchedulingConfig> 1065 + <SchedulingConfig_Scheduling>Enabled</SchedulingConfig_Scheduling> 1066 + </SchedulingConfig> 1067 + </Configuration> 1068 +</MicroserviceConfiguration> 1069 + 1070 + 1071 +Update-AESBMicroserviceTemplate -TemplateId "838fb7e2-e293-4004-9602-7223aaa3854a" -TemplateConfig $templateConfiguration 1072 +{{/code}} 890 890 891 - == New-AESBMicroserviceTemplateConfig==1074 +Dieses Beispiel updated das Template mit der beigefügten Konfiguration. 892 892 893 -== R emove-AESBMicroserviceTemplate ==1076 +=== Rückgabewerte === 894 894 895 -== Update-AESBMicroserviceTemplate == 1078 +* Templateinfo 1079 +** TemplateId 1080 +** Configuration 1081 +** Name 1082 +** Type 1083 +** Version 1084 + 1085 +{{code language="PowerShell"}} 1086 +TemplateId : 838fb7e2-e293-4004-9602-7223aaa3854a 1087 +Configuration : <Configuration> 1088 + <SchedulingConfig> 1089 + <SchedulingConfig_Scheduling>Enabled</SchedulingConfig_Scheduling> 1090 + </SchedulingConfig> 1091 + </Configuration> 1092 +Name : ASDASDASD 1093 +Type : ASD 1094 +Version : 1.0.0.0 1095 +{{/code}}

