Changes for page Microservice Cmdlets

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

From 3.2 to 3.1 From 4.6 to 4.5

From version 4.5

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

Change comment: There is no comment for this version

To version 3.2

edited by jklein
on 2025/06/23 09:57

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -477,7 +477,7 @@
  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestartet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
++|ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestartet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
  |-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestartet werden sollen. Obligatorisch für Parametersatz `SupervisorParametersetName`.
  |-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`.
  |-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Startvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
@@ -531,241 +531,14 @@
  == Stop-AESBMicroservices ==
--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`.
--|-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`.
--|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Stoppvorgang an (z.B. "5s", "1m"). Standardwert: "5s".
--|-NoWait      |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Stoppvorgangs, sondern kehrt sofort zurück.
--
--=== **Beispiele** ===
--
--Beispiel 1: Einen Microservice anhand seiner Instanz-ID stoppen
--
--{{code language="PowerShell"}}
--Stop-AESBMicroservices -InstanceIds "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1"
--{{/code}}
--
--Dieser Befehl stoppt den Microservice mit der Instanz-ID "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1" und wartet auf das Ergebnis.
--
--Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs stoppen mit Timeout
--
--{{code language="PowerShell"}}
--Stop-AESBMicroservices -InstanceIds "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" -Timeout "10s"
--
--{{/code}}
--
--Dieser Befehl stoppt zwei Microservices und setzt das Timeout für den Vorgang auf zehn Sekunden.
--
--Beispiel 3: Alle Microservices eines Supervisors stoppen, ohne auf den Abschluss zu warten
--
--{{code language="PowerShell"}}
--Stop-AESBMicroservices -SupervisorId "FinanceSupervisor" -NoWait
--
--{{/code}}
--
--Dieser Befehl initiiert den Stoppvorgang aller Microservices, die vom Supervisor "FinanceSupervisor" verwaltet werden, und kehrt sofort zurück.
--
--Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs stoppen
--
--{{code language="PowerShell"}}
--"c7e323e9-abc1-4150-a4a3-afb4e57e9cb1", "another-guid-for-stop" | Stop-AESBMicroservices
--
--{{/code}}
--
--Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Stop-AESBMicroservices`, um die entsprechenden Microservices zu stoppen.
--
--=== **Rückgabewert** ===
--
--Das Cmdlet gibt für jeden versuchten Stoppvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
--
--* **Status**: Der Status der Operation (z.B. "Changed", "Unchanged", "Failed")
--* **InstanceId**: Die Instanz-ID des Microservices.
--* **InstanceState**: Der Zustand des Microservices nach dem versuchten Stoppvorgang (z.B. "Stopped", "Running").
--* **Error**: Fehlermeldungen, falls der Stoppvorgang nicht erfolgreich war.
--
  = Packages =
  == 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 bekommt man 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"}}
--
--{{/apimacro}}
--
--**Beispiel Template Konfiguration**
--
--|(((
--1
--
--2
--
--3
--
--4
--
--5
--
--6
--
--7
--
--8
--
--9
--
--10
--
--11
--
--12
--
--13
--
--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 ==