Changes for page Microservice Cmdlets

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

From 4.2 to 4.3 From 6.2 to 6.3

From version 4.3

edited by jklein
on 2025/06/24 10:54

Change comment: There is no comment for this version

To version 6.2

edited by jklein
on 2025/07/16 07:38

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.
@@ -621,8 +621,8 @@
  |=(% 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
++|-TemplateName|String|❌|Keine|Der Name für die Vorlage.
++|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration der Vorlage.
  === **Beispiele** ===
@@ -635,11 +635,52 @@
  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** ===
@@ -660,73 +660,74 @@
  ** Version
  *** Die Versionierung des Templates
--{{apimacro title="Rcükgabewerte der Template-Konfiguration"}}
++{{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}}
--**Beispiel Template Konfiguration**
++== Export-MicroserviceTemplateConfig ==
--|(((
--1
++Dieses Cmdlet ermöglicht es, die Konfiguration einer Microservice-Vorlagen zu exportieren.
--2
++|=(% 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.
--3
++=== **Beispiele** ===
--4
++Beispiel 1: MicroserviceTemplate exportieren
--5
++{{code language="PowerShell"}}
++Export-AESBMicroserviceTemplateConfig -TemplateConfig $templateConfig -Path $path
--6
++{{/code}}
--7
++In diesem Beispiel wird die $templateConfig am Speicherort "C:\Test.xml" exportiert.
--8
++{{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}}
--9
++{{apimacro title="Beispielhafte XML-Datei nach dem Exportieren"}}
++
++{{/apimacro}}
--10
++=== Rückgabewerte ===
--11
++Nach erfolgreichem Exportieren bekommen Sie eine Statusmeldung zurück.
--12
++{{code language="none"}}
++Writing the file was successful.
--13
++{{/code}}
--14
--)))|(((
--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
--)))
--
--
--
--== Export-MicroserviceTemplateConfig ==
--
  == Get-AESBMicroserviceTemplateConfig ==
  == Import-AESBMicroserviceTemplateConfig ==