Changes for page Microservice Cmdlets

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

From 3.2 to 4.1 From 6.3 to 7.1

From version 4.1

edited by jklein
on 2025/06/23 10:40

Change comment: There is no comment for this version

To version 6.3

edited by jklein
on 2025/07/16 08:30

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -155,7 +155,7 @@
  * **CpuUsage**: Die aktuelle CPU-Auslastung des Microservices in Prozent.
  * **MemoryUsage**: Die aktuelle Speicherauslastung des Microservices in Bytes.
--== Edit-AESBMicroservices ==
++== Edit-AESBMicroservice ==
  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.
@@ -533,7 +533,6 @@
  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.
--
  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
  |-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestoppt werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
  |-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestoppt werden sollen. Obligatorisch für Parametersatz `UseSupervisorIdParameterSet`.
@@ -591,20 +591,371 @@
  == Get-AESBMicroservicePackages ==
++Dieses Cmdlet ruft eine Liste aller verfügbaren Microservice-Pakete und deren Versionen ab. Es sind keine spezifischen Parameter erforderlich.
++
++|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
++|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Informationen zu Microservice-Paketen abgerufen werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
++
++=== **Beispiele** ===
++
++Beispiel 1: Alle verfügbaren Microservice-Pakete auflisten
++
++{{code language="PowerShell"}}
++Get-AESBMicroservicePackages
++
++{{/code}}
++
++Dieser Befehl ruft alle verfügbaren Microservice-Pakete und die zugehörigen Versionen ab.
++
++=== **Rückgabewert** ===
++
++Das Cmdlet gibt für jedes gefundene Microservice-Paket ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
++
++* **PackageName**: Der Name des Microservice-Pakets.
++* **PackageVersions**: Eine Liste der verfügbaren Versionen für dieses Paket.
++
  = Templates =
  == Add-AESBMicroserviceTemplate ==
++Dieses Cmdlet fügt eine Microservice-Vorlage auf Basis der beigefügten Vorlagen-Konfiguration hinzu.
++
++|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
++|-ConnectionName|String|✅|C|Der Name der Verbindung, über die eine Vorlage hinzugefügt werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
++|-TemplateName|String|❌|Keine|Der Name für die Vorlage.
++|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration der Vorlage.
++
++=== **Beispiele** ===
++
++Beispiel 1: Fügt ein neues Microservice-Template hinzu
++
++{{code language="PowerShell"}}
++Add-AESBMicroserviceTemplate -TemplateName "Test" -TemplateConfig $templateConfig
++{{/code}}
++
++Dieses Beispiel fügt eine neue Templatekonfiguration mit dem Namen "Test" auf Basis des $templateConfig-Objekts hinzu. Die Standardverbindung wird verwendet.
++
++{{apimacro title="Beispiel der Funktion in PowerShell"}}
++{{code language="PowerShell" layout="LINENUMBERS"}}
++function Add-MicroserviceTemplate {
++    param (
++        [string]$Name
++    )
++
++    $packages = Get-AESBMicroservicePackages
++
++    $microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packages[0].PackageName -PackageVersion $packages[0].PackageVersions[0]
++
++    $addMicroserviceResult = Add-AESBMicroserviceTemplate -TemplateName $Name -TemplateConfig $microserviceTemplateConfig
++
++    return $addMicroserviceResult
++}
++{{/code}}
++{{/apimacro}}
++
++{{apimacro title="Beispiel der Template-Konfiguration"}}
++{{code language="PowerShell" layout="LINENUMBERS"}}
++$templateConfig = "<MicroserviceConfiguration Version=`"1.11.0.895`" Type=`"SnmpConnector`" SessionKey=`"bcafdb4e94f2572eed78525430ad0e0275229f98`">
++  <SnmpConnectorConfiguration>
++    <SnmpReader>
++      <ParallelRequests>10</ParallelRequests>
++      <SchedulingConfig>
++        <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
++        <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
++        <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
++      </SchedulingConfig>
++      <Groups />
++      <GlobalCredentialLists>
++        <GlobalCredentials />
++        <GlobalCredentialsNoPriv />
++        <GlobalCredentialsNoAuthNoPriv />
++      </GlobalCredentialLists>
++    </SnmpReader>
++    <SnmpWriters>
++      <DescriptionWriteMode>Keep</DescriptionWriteMode>
++      <LocationWriteMode>Ignore</LocationWriteMode>
++      <ContactWriteMode>Ignore</ContactWriteMode>
++      <ProcessorWriter />
++      <DispatcherStarter />
++      <FileDumper />
++    </SnmpWriters>
++  </SnmpConnectorConfiguration>
++</MicroserviceConfiguration>"
++{{/code}}
++{{/apimacro}}
++
++=== **Rückgabewerte** ===
++
++Bei erfolgreicher Anwendung erhalten Sie zwei Objekte zurück.
++
++* String
++** Erfolgreiche Statusmeldung
++* TemplateInfo
++** TemplateId
++*** ID des Templates
++** Configuration
++*** Aktuelle Konfiguration des Templates
++** Name
++*** Name des Templates
++** Type
++*** Der Typ des Templates
++** Version
++*** Die Versionierung des Templates
++
++{{apimacro title="Rückgabewerte der Template-Konfiguration"}}
++{{code language="PowerShell" layout="LINENUMBERS"}}
++Successfully added template 'Test'.
++
++TemplateId    : 119398aa-8108-43bd-811b-bd3e703e7f5c
++Configuration : <SnmpConnectorConfiguration><SnmpReader><ParallelRequests>10</ParallelRequests><SchedulingConfig><Sched
++                ulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling><SchedulingConfig_Interval>P1D</Scheduling
++                Config_Interval><SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTi
++                me></SchedulingConfig><Groups /><GlobalCredentialLists><GlobalCredentials /><GlobalCredentialsNoPriv
++                /><GlobalCredentialsNoAuthNoPriv /></GlobalCredentialLists></SnmpReader><SnmpWriters><DescriptionWriteM
++                ode>Keep</DescriptionWriteMode><LocationWriteMode>Ignore</LocationWriteMode><ContactWriteMode>Ignore</C
++                ontactWriteMode><ProcessorWriter /><DispatcherStarter /><FileDumper
++                /></SnmpWriters></SnmpConnectorConfiguration>
++Name          : Test
++Type          : SnmpConnector
++Version       : 1.11.0.895
++{{/code}}
++{{/apimacro}}
++
  == Export-MicroserviceTemplateConfig ==
++Dieses Cmdlet ermöglicht es, die Konfiguration einer Microservice-Vorlagen zu exportieren.
++
++|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
++|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
++|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration, die exportiert werden soll.
++|-Path|String|❌|Keine|Der Pfad, unter dem die Microservice-Vorlagen-Konfiguration gespeichert werden soll.
++
++=== **Beispiele** ===
++
++Beispiel 1: MicroserviceTemplate exportieren
++
++{{code language="PowerShell"}}
++Export-AESBMicroserviceTemplateConfig -TemplateConfig $templateConfig -Path $path
++
++{{/code}}
++
++In diesem Beispiel wird die $templateConfig am Speicherort "C:\Test.xml" exportiert.
++
++{{code language="PowerShell" layout="LINENUMBERS"}}
++function Export-MicroserviceTemplateConfig {
++    param (
++        [string]$Path
++    )
++
++    $microserviceTemplates = Get-AESBMicroserviceTemplates
++
++    $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $microserviceTemplates[0].Name
++
++    $exportMicroserviceTemplateConfigResult = Export-AESBMicroserviceTemplateConfig -TemplateConfig $microserviceTemplateConfig -Path $Path
++
++    return $exportMicroserviceTemplateConfigResult
++}
++{{/code}}
++
++{{apimacro title="Beispielhafte XML-Datei nach dem Exportieren"}}
++{{code language="XML" layout="LINENUMBERS"}}
++<MicroserviceConfiguration Version="1.11.0.895" Type="SnmpConnector" SessionKey="bcafdb4e94f2572eed78525430ad0e0275229f98">
++  <SnmpConnectorConfiguration>
++    <SnmpReader>
++      <ParallelRequests>10</ParallelRequests>
++      <SchedulingConfig>
++        <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
++        <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
++        <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
++      </SchedulingConfig>
++      <Groups />
++      <GlobalCredentialLists>
++        <GlobalCredentials />
++        <GlobalCredentialsNoPriv />
++        <GlobalCredentialsNoAuthNoPriv />
++      </GlobalCredentialLists>
++    </SnmpReader>
++    <SnmpWriters>
++      <DescriptionWriteMode>Keep</DescriptionWriteMode>
++      <LocationWriteMode>Ignore</LocationWriteMode>
++      <ContactWriteMode>Ignore</ContactWriteMode>
++      <ProcessorWriter />
++      <DispatcherStarter />
++      <FileDumper />
++    </SnmpWriters>
++  </SnmpConnectorConfiguration>
++</MicroserviceConfiguration>
++{{/code}}
++{{/apimacro}}
++
++=== Rückgabewerte ===
++
++Nach erfolgreichem Exportieren erhalten Sie eine Statusmeldung zurück.
++
++{{code language="none"}}
++Writing the file was successful.
++
++{{/code}}
++
  == Get-AESBMicroserviceTemplateConfig ==
++Dieses Cmdlet fragt die TemplateConfig einer bestimmten Microservice-Vorlage ab.
++
++|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
++|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
++|-TemplateName|String|❌|Keine|Der Name der Vorlage für die gewünschte Konfiguration.
++
++=== Beispiele ===
++
++Beispiel 1: MicroserviceTemplateConfig von $templateName anfragen
++
++{{code language="PowerShell"}}
++Get-AESBMicroserviceTemplateConfig -TemplateName $templateName
++{{/code}}
++
++Dieses Beispiel fragt die Templatekonfiguration mit dem Namen $templateName an. Die Standardverbindung wird verwendet.
++
++{{code language="PowerShell" layout="LINENUMBERS"}}
++function Get-MicroserviceTemplateConfig {
++
++    $aesbMicroserviceTemplates = Get-AESBMicroserviceTemplates
++
++    $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $aesbMicroserviceTemplates[0].Name
++
++    return $microserviceTemplateConfig
++}
++{{/code}}
++
++=== Rückgabewerte ===
++
++Bei erfolgreicher Anwendung erhalten Sie die gewünschte Microservice-Konfiguration zurück:
++
++* MicroserviceConfiguration
++** Version
++*** Die jeweilige Versionierung des Microservices
++** Type
++*** Der Typ des Microservices
++** TypeConfiguration
++*** Die jeweilige Typ-Konfiguration des Microservices
++
++{{code language="PowerShell"}}
++$microserviceTemplateConfig
++
++MicroserviceConfiguration
++-------------------------
++MicroserviceConfiguration
++
++$microserviceTemplateConfig.MicroserviceConfiguration
++
++Version    Type          SnmpConnectorConfiguration
++-------    ----          --------------------------
++1.11.0.895 SnmpConnector SnmpConnectorConfiguration
++{{/code}}
++
  == Import-AESBMicroserviceTemplateConfig ==
++Dieses Cmdlet importiert die Templatekonfiguration vom angegebenen Pfad.
++
++|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
++|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservices-Vorlagen-Konfiguration importiert werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
++|-Path|String|❌|Keine|Der Pfad, von dem die Konfiguration importiert werden soll.
++
++=== Beispiele ===
++
++Beispiel 1: Templatekonfiguration von $path laden
++
++{{code language="PowerShell"}}
++Import-AESBMicroserviceTemplateConfig -Path $path
++
++{{/code}}
++
++Dieses Beispiel importiert die Templatekonfiguration beim hinterlegten Pfad. Die Standardverbindung wird verwendet.
++
++=== Rückgabewerte ===
++
++Bei erfolgreicher Anwendung erhalten Sie die gewünschte MicroserviceConfiguration zurück:
++
++* MicroserviceConfiguration
++** Version
++*** Die jeweilige Versionierung des Microservices
++** Type
++*** Der Typ des Microservices
++** TypeConfiguration
++*** Die jeweilige Typ-Konfiguration des Microservices
++
++{{code language="PowerShell"}}
++$microserviceTemplateConfig
++
++MicroserviceConfiguration
++-------------------------
++MicroserviceConfiguration
++
++$microserviceTemplateConfig.MicroserviceConfiguration
++
++Version    Type          SnmpConnectorConfiguration
++-------    ----          --------------------------
++1.11.0.895 SnmpConnector SnmpConnectorConfiguration
++{{/code}}
++
  == Migrate-AESBMicroserviceTemplate ==
++Mit diesem Cmdlet werden bestehende Vorlagen auf die gewünschte Zielversion übertragen.
++
++|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
++|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Vorlagen migriert werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
++|-TemplateNames|String[]|❌|Keine|Hier sind die Namen der Vorlagen, die übertragen werden sollen.
++|-TargetVersion|String|❌|Keine|Die Zielversion, auf die die Vorlagen migriert werden sollen.
++|-KeepTemplateIds|SwitchParameter|✅|Keine|Hier wird festgelegt, ob die bestehenden Template-IDs gleich bleiben oder beim Migrieren neu erstellt werden sollen.
++
++=== Beispiele ===
++
++Beispiel 1: Mehrere Templates auf Version $templateVersion migrieren
++
++{{code language="PowerShell"}}
++Migrate-AESBMicroserviceTemplates -TemplateNames $templateNames -TargetVersion $templateVersion
++
++{{/code}}
++
++Dieses Beispiel migriert alle Templates die in $templateNames stehen auf die Version $templateVersion
++
++=== Rückgabewerte ===
++
++Bei erfolgreicher Anwendung erhalten Sie eine Liste von Template-Informationen mit den neuen Daten der erfolgreich migrierten Templates:
++
++* TemplateInfo
++** TemplateId
++*** Die neu erstellte / gleichbleibende Id des Templates
++** Configuration
++*** Die aktuelle Konfiguration des Templates
++** Name
++*** Der neue Name des Template
++** Type
++*** Der Typ des Templates
++** Version
++*** Die neue Version des Templates
++
++{{code language="PowerShell"}}
++TemplateId    : ffffffff-ffff-ffff-ffff-ffffffffffff"
++Configuration : <Configuration>
++                  <SchedulingConfig>
++                    <SchedulingConfig_Scheduling>Disabled</SchedulingConfig_Scheduling>
++                  </SchedulingConfig>
++                </Configuration>
++Name          : TestTest_1_0_0_1
++Type          : Test
++Version       : 1.0.0.1
++{{/code}}
++
  == New-AESBMicroserviceTemplateConfig ==
++
++
++
++
++
++
++
++
  == Remove-AESBMicroserviceTemplate ==
  == Update-AESBMicroserviceTemplate ==