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
-
... ... @@ -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-AESBMicroservice s==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,19 +620,19 @@ 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 neue sMicroservice-Template hinzu630 +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"}} 638 638 {{code language="PowerShell" layout="LINENUMBERS"}} ... ... @@ -652,103 +652,495 @@ 652 652 {{/code}} 653 653 {{/apimacro}} 654 654 655 -{{apimacro title="Beispiel der Template-Konfiguration"}} 656 - 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}} 657 657 {{/apimacro}} 658 658 659 659 === **Rückgabewerte** === 660 660 661 -Bei erfolgreicher Anwendung bekommt man zwei Objekte zurück.689 +Bei erfolgreicher Anwendung erhalten Sie zwei Objekte zurück. 662 662 663 663 * String 664 664 ** Erfolgreiche Statusmeldung 665 665 * TemplateInfo 666 666 ** TemplateId 667 -*** ID de sTemplates695 +*** ID der Vorlage 668 668 ** Configuration 669 -*** Aktuelle Konfiguration de sTemplates697 +*** Aktuelle Konfiguration der Vorlage 670 670 ** Name 671 -*** Name de sTemplates699 +*** Name der Vorlage 672 672 ** Type 673 -*** Der Typ de sTemplates701 +*** Der Typ der Vorlage 674 674 ** Version 675 -*** Die Versionierung de sTemplates703 +*** Die Versionierung der Vorlage 676 676 677 -{{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'. 678 678 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}} 679 679 {{/apimacro}} 680 680 681 - **BeispielTemplateKonfiguration**724 +== Export-MicroserviceTemplateConfig == 682 682 683 -|((( 684 -1 726 +Dieses Cmdlet ermöglicht es, die Konfiguration einer Microservice-Vorlagen zu exportieren. 685 685 686 -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. 687 687 688 - 3733 +=== **Beispiele** === 689 689 690 - 4735 +Beispiel 1: Microservice-Vorlage exportieren 691 691 692 -5 737 +{{code language="PowerShell"}} 738 +Export-AESBMicroserviceTemplateConfig -TemplateConfig $templateConfig -Path $path 693 693 694 - 6740 +{{/code}} 695 695 696 - 7742 +In diesem Beispiel wird die //$templateConfig// am Speicherort "C:\Test.xml" exportiert. 697 697 698 -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}} 699 699 700 -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}} 701 701 702 - 10791 +=== Rückgabewerte === 703 703 704 - 11793 +Nach erfolgreichem Exportieren erhalten Sie eine Statusmeldung zurück. 705 705 706 -12 795 +{{code language="none"}} 796 +Writing the file was successful. 707 707 708 - 13798 +{{/code}} 709 709 710 -14 711 -)))|((( 712 -Successfully added template 'Test'. 800 +== Get-AESBMicroserviceTemplateConfig == 713 713 802 +Dieses Cmdlet fragt die TemplateConfig einer bestimmten Microservice-Vorlage ab. 714 714 715 -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. 716 716 717 - Configuration: <SnmpConnectorConfiguration><SnmpReader><ParallelRequests>10</ParallelRequests><SchedulingConfig><Sched808 +=== Beispiele === 718 718 719 - ulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling><SchedulingConfig_Interval>P1D</Scheduling810 +Beispiel 1: Konfiguration der Microservice-Vorlage von //$templateName// anfragen 720 720 721 - Config_Interval><SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTi 812 +{{code language="PowerShell"}} 813 +Get-AESBMicroserviceTemplateConfig -TemplateName $templateName 814 +{{/code}} 722 722 723 - me></SchedulingConfig><Groups/><GlobalCredentialLists><GlobalCredentials/><GlobalCredentialsNoPriv816 +Dieses Beispiel fragt die Vorlagen-Konfiguration mit dem Namen //$templateName// an. Die Standardverbindung wird verwendet. 724 724 725 - /><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}} 726 726 727 - ode>Keep</DescriptionWriteMode><LocationWriteMode>Ignore</LocationWriteMode><ContactWriteMode>Ignore</C829 +=== Rückgabewerte === 728 728 729 - ontactWriteMode><ProcessorWriter/><DispatcherStarter /><FileDumper831 +Bei erfolgreicher Anwendung erhalten Sie die gewünschte Microservice-Konfiguration zurück: 730 730 731 - /></SnmpWriters></SnmpConnectorConfiguration> 833 +* MicroserviceConfiguration 834 +** Version 835 +*** Die jeweilige Version des Microservices 836 +** Type 837 +*** Der Typ des Microservices 838 +** TypeConfiguration 839 +*** Die jeweilige Typ-Konfiguration des Microservices 732 732 733 -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}} 734 734 735 - Type :SnmpConnector855 +== Get-AESBMicroserviceTemplates == 736 736 737 -Version : 1.11.0.895 738 -))) 857 +Dieses Cmdlet fragt die vorhandenen Microservice-Vorlagen ab und listet sie auf. 739 739 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 740 740 864 +=== Beispiele === 741 741 742 - == Export-MicroserviceTemplateConfig==866 +Beispiel 1: Alle vorhandenen Microservice-Vorlagen anzeigen 743 743 744 -== Get-AESBMicroserviceTemplateConfig == 868 +{{code language="PowerShell"}} 869 +Get-AESBMicroserviceTemplates 870 +{{/code}} 745 745 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 der Vorlage 890 +** Id 891 +*** Die Id der Vorlage 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 + 746 746 == Import-AESBMicroserviceTemplateConfig == 747 747 909 +Dieses Cmdlet importiert die Vorlagen-Konfiguration 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: Vorlagen-Konfiguration von //$path// laden 918 + 919 +{{code language="PowerShell"}} 920 +Import-AESBMicroserviceTemplateConfig -Path $path 921 + 922 +{{/code}} 923 + 924 +Dieses Beispiel importiert die Vorlagen-Konfiguration 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 Version 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 + 748 748 == Migrate-AESBMicroserviceTemplate == 749 749 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 Vorlagen 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 Vorlagen, die in //$templateNames// stehen, auf die Version //$templateVersion//. 972 + 973 +=== Rückgabewerte === 974 + 975 +Bei erfolgreicher Anwendung erhalten Sie eine Liste von Vorlagen-Informationen mit den neuen Daten der erfolgreich migrierten Vorlagen: 976 + 977 +* TemplateInfo 978 +** TemplateId 979 +*** Die neu erstellte / gleichbleibende Id der Vorlage 980 +** Configuration 981 +*** Die aktuelle Konfiguration der Vorlage 982 +** Name 983 +*** Der neue Name der Vorlage 984 +** Type 985 +*** Der Typ der Vorlage 986 +** Version 987 +*** Die neue Version der Vorlage 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 + 750 750 == New-AESBMicroserviceTemplateConfig == 751 751 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 Vorlagen-Konfiguration auf Basis des angegebenen Microservice-Pakets. 1022 + 1023 +=== Rückgabewerte === 1024 + 1025 +* MicroserviceConfiguration 1026 +** Version 1027 +*** Die neue Version der Vorlage 1028 +** Type 1029 +*** Der Typ der Vorlage 1030 +** Configuration 1031 +*** Die aktuelle Konfiguration der Vorlage 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 + 752 752 == Remove-AESBMicroserviceTemplate == 753 753 1049 +Mit diesem Cmdlet können Sie Microservice-Vorlagen löschen. 1050 + 1051 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung 1052 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen gelöscht werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet. 1053 +|-TemplateIds|String[]|❌|Keine|Die ID's der Vorlagen, die zu löschen sind. 1054 +|-RemoveReferences|SwitchParameter|✅|Keine|Gibt an ob alle erstellten Referenzen der Vorlagen mitgelöscht werden sollen. 1055 + 1056 +=== Beispiele === 1057 + 1058 +Beispiel 1: Vorlage löschen 1059 + 1060 +{{code language="PowerShell"}} 1061 +Remove-AESBMicroserviceTemplate -TemplateIds 4b016fd1-47fb-4f24-87dd-4e365fe870d3 1062 + 1063 +{{/code}} 1064 + 1065 +Dieses Beispiel löscht eine Microservice-Vorlage auf Basis der angegebenen Id. 1066 + 1067 +Beispiel 2: Vorlagen löschen 1068 + 1069 +{{code language="PowerShell"}} 1070 +Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3", "D1936807-E1B0-4F8B-AB7F-98ECD202CF8F" 1071 +{{/code}} 1072 + 1073 +Dieses Beispiel löscht mehrere Microservice-Vorlagen auf Basis der angegebenen Ids. 1074 + 1075 +Beispiel 3: Vorlagen löschen mitsamt den Referenzen 1076 + 1077 +{{code language="PowerShell"}} 1078 +Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3" -RemoveReferences 1079 + 1080 +{{/code}} 1081 + 1082 +Dieses Beispiel löscht eine Microservice-Vorlage mitsamt den erstellten Referenzen der Vorlage . 1083 + 1084 +=== Rückgabewerte === 1085 + 1086 +* RemoveMicroserviceTemplateStatusData 1087 +** StatusResult 1088 +*** Ergebnis des Resultats des Vorgangs 1089 +** TemplateId 1090 +*** Die erfolgreich gelöschte Id der Vorlage 1091 +** Message 1092 +*** Status Nachricht 1093 + 1094 +{{code language="PowerShell"}} 1095 +StatusResult TemplateId Message 1096 +------------ ---------- ------- 1097 + Success bde8016f-8557-4438-a165-ab05a4a78db4 The template was successfully removed. 1098 +{{/code}} 1099 + 754 754 == Update-AESBMicroserviceTemplate == 1101 + 1102 +Dieses Cmdlet aktualisiert die Microservice-Vorlage mittels der beigefügten Microservice-Vorlagen-Konfiguration. 1103 + 1104 +|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung 1105 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlage aktualisiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet. 1106 +|-TemplateId|String|❌|Keine|Die ID der Vorlage, die aktualisiert werden soll. 1107 +|-TemplateConfig|XmlDocument|❌|Keine|Die neue Microservices-Vorlagen-Konfiguration, die die aktuelle Konfiguration überschreiben soll. 1108 + 1109 +=== Beispiele === 1110 + 1111 +Beispiel 1: Vorlage updaten 1112 + 1113 +{{code language="PowerShell" layout="LINENUMBERS"}} 1114 +$templateConfiguration = <MicroserviceConfiguration Version="1.0.0.0" Type="Test" SessionKey="72962557bb8bbd00b53dcb53d99cea685ed636bf"> 1115 + <Configuration> 1116 + <SchedulingConfig> 1117 + <SchedulingConfig_Scheduling>Enabled</SchedulingConfig_Scheduling> 1118 + </SchedulingConfig> 1119 + </Configuration> 1120 +</MicroserviceConfiguration> 1121 + 1122 + 1123 +Update-AESBMicroserviceTemplate -TemplateId "838fb7e2-e293-4004-9602-7223aaa3854a" -TemplateConfig $templateConfiguration 1124 +{{/code}} 1125 + 1126 +Dieses Beispiel updated die Vorlage mit der beigefügten Konfiguration. 1127 + 1128 +=== Rückgabewerte === 1129 + 1130 +* Templateinfo 1131 +** TemplateId 1132 +** Configuration 1133 +** Name 1134 +** Type 1135 +** Version 1136 + 1137 +{{code language="PowerShell"}} 1138 +TemplateId : 838fb7e2-e293-4004-9602-7223aaa3854a 1139 +Configuration : <Configuration> 1140 + <SchedulingConfig> 1141 + <SchedulingConfig_Scheduling>Enabled</SchedulingConfig_Scheduling> 1142 + </SchedulingConfig> 1143 + </Configuration> 1144 +Name : ASDASDASD 1145 +Type : ASD 1146 +Version : 1.0.0.0 1147 +{{/code}}

