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. W enn nicht angegeben, wird die Standardverbindung verwendet.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 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. W enn nicht angegeben, wird die Standardverbindung verwendet.80 +|-ConnectionName|String|✅|C|Der Name der Verbindung, Informationen zu Microservice-Instanzen abgerufen werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben. 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 == 158 +== Edit-AESBMicroservices == 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. W enn nicht angegeben, wird die Standardverbindung verwendet.163 +|-ConnectionName| |String|✅|Der Name der Verbindung, über die Microservice-Instanzen bearbeitet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben. 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. W enn nicht angegeben, wird die Standardverbindung verwendet.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 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. W enn nicht angegeben, wird die Standardverbindung verwendet.262 +|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen verschoben werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben. 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") ... ... @@ -370,726 +370,30 @@ 370 370 371 371 == Restart-AESBMicroservices == 372 372 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 - 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. Wenn nicht angegeben, wird die Standardverbindung verwendet. 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 -|-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 -|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Neustartvorgang an (z.B. "30s", "1m"). Standardwert: "30s". 380 -|-NoWait|SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Neustartvorgangs, sondern kehrt sofort zurück. 381 - 382 -==== **Beispiele** ==== 383 - 384 -Beispiel 1: Einen Microservice anhand seiner Instanz-ID neu starten 385 - 386 -{{code language="PowerShell"}} 387 -Restart-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" 388 -{{/code}} 389 - 390 -Dieser Befehl startet den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" neu und wartet auf das Ergebnis. 391 - 392 -Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs neu starten mit Timeout 393 - 394 -{{code language="PowerShell"}} 395 -Restart-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -Timeout "1m" 396 - 397 -{{/code}} 398 - 399 -Dieser Befehl startet zwei Microservices neu und setzt das Timeout für den Vorgang auf eine Minute. 400 - 401 -Beispiel 3: Alle Microservices eines Supervisors neu starten, ohne auf den Abschluss zu warten 402 - 403 -{{code language="PowerShell"}} 404 -Restart-AESBMicroservices -SupervisorId "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -NoWait 405 -{{/code}} 406 - 407 -Dieser Befehl initiiert den Neustart aller Microservices, die vom Supervisor "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" verwaltet werden, und kehrt sofort zurück. 408 - 409 -Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs neu starten 410 - 411 -{{code language="PowerShell"}} 412 -"aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" | Restart-AESBMicroservices 413 -{{/code}} 414 - 415 -Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Restart-Microservices`, um die entsprechenden Microservices neu zu starten. 416 - 417 -=== Rückgabewert === 418 - 419 -Das Cmdlet gibt für jeden versuchten Neustartvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen: 420 - 421 -* **Name**: Der Name des Microservices. 422 -* **InstanceId**: Die Instanz-ID des Microservices. 423 -* **RestartRequested**: Zeitstempel, wann der Neustart angefordert wurde. 424 -* **RestartSucceeded**: Zeitstempel, wann der Neustart erfolgreich war (oder leer/Fehlerdatum bei Misserfolg). 425 -* **Status**: Das Ergebnis des Neustartvorgangs (z.B. "Success", "Failed", "InProgress"). 426 - 427 427 == Set-AESBMicroserviceLogging == 428 428 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 - 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. Wenn nicht angegeben, wird die Standardverbindung verwendet. 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 -|-Enable|SwitchParameter|✅❌|Keine|Aktiviert das Logging für die angegebenen Microservices. Obligatorisch für Parametersatz `SwitchEnable`. Kann nicht zusammen mit `-Disable` verwendet werden. 435 -|-Disable|SwitchParameter|✅❌|Keine|Deaktiviert das Logging für die angegebenen Microservices. Obligatorisch für Parametersatz `SwitchDisable`. Kann nicht zusammen mit `-Enable` verwendet werden. 436 - 437 -=== **Beispiele** === 438 - 439 -Beispiel 1: Logging für einen Microservice aktivieren 440 - 441 -{{code language="PowerShell"}} 442 -Set-AESBMicroserviceLogging -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -Enable 443 -{{/code}} 444 - 445 -Dieser Befehl aktiviert das Logging für den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffffffff1". 446 - 447 -Beispiel 2: Logging für mehrere Microservices deaktivieren 448 - 449 -{{code language="PowerShell"}} 450 -Set-AESBMicroserviceLogging -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -Disable 451 - 452 -{{/code}} 453 - 454 -Dieser Befehl deaktiviert das Logging für die Microservices mit den angegebenen Instanz-IDs. 455 - 456 -Beispiel 3: Logging für einen Microservice über die Pipeline aktivieren 457 - 458 -{{code language="PowerShell"}} 459 -"aaaaaaaa-ffff-ffff-ffff-fffffffffff1" | Set-AESBMicroserviceLogging -Enable 460 - 461 -{{/code}} 462 - 463 -Dieser Befehl übergibt eine Instanz-ID über die Pipeline an `Set-MicroserviceLogging`, um das Logging für den entsprechenden Microservice zu aktivieren. 464 - 465 -=== Rückgabewerte === 466 - 467 -Das Cmdlet gibt für jede Instanz, deren Logging-Status geändert wurde, ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen: 468 - 469 -* **Status**: Der Status der Operation (z.B. "Changed", "Unchanged", "Failed"). 470 -* **MicroserviceId**: Die Instanz-ID des Microservices. 471 -* **MicroserviceName**: Der Name des Microservices. 472 -* **Logging**: Der neue Logging-Status (True oder False). 473 - 474 474 == Start-AESBMicroservices == 475 475 476 -Mit diesem Cmdlet starten Sie die angegebenen, zuvor gestoppten Microservice-Instanzen. Die zu startenden Microservices können entweder über ihre `InstanceIds` oder über eine `SupervisorId` (die alle zugehörigen Instanzen startet) identifiziert werden. Es muss einer der Parameter `-InstanceIds` oder `-SupervisorId` angegeben werden. 477 - 478 - 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. Wenn nicht angegeben, wird die Standardverbindung verwendet. 481 -|-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestartet werden sollen. Obligatorisch für Parametersatz `SupervisorParametersetName`. 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 -|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Startvorgang an (z.B. "30s", "1m"). Standardwert: "30s". 484 -|-NoWait |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Startvorgangs, sondern kehrt sofort zurück. 485 - 486 -=== **Beispiele** === 487 - 488 -Beispiel 1: Einen Microservice anhand seiner Instanz-ID starten 489 - 490 -{{code language="PowerShell"}} 491 -Start-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffff1" 492 - 493 -{{/code}} 494 - 495 -Dieser Befehl startet den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffff1" und wartet auf das Ergebnis. 496 - 497 -Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs starten mit Timeout 498 - 499 -{{code language="PowerShell"}} 500 -Start-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffff2" -Timeout "1m" 501 - 502 -{{/code}} 503 - 504 -Dieser Befehl startet zwei Microservices und setzt das Timeout für den Vorgang auf eine Minute. 505 - 506 -Beispiel 3: Alle Microservices eines Supervisors starten, ohne auf den Abschluss zu warten 507 - 508 -{{code language="PowerShell"}} 509 -Start-AESBMicroservices -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -NoWait 510 - 511 -{{/code}} 512 - 513 -Dieser Befehl initiiert den Start aller Microservices, die vom Supervisor "ffffffff-ffff-ffff-ffff-aaaaaaaa" verwaltet werden, und kehrt sofort zurück. 514 - 515 -Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs starten 516 - 517 -{{code language="PowerShell"}} 518 -"aaaaaaaa-ffff-ffff-ffff-fffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffff2" | Start-AESBMicroservices 519 - 520 -{{/code}} 521 - 522 -Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Start-Microservices`, um die entsprechenden Microservices zu starten. 523 - 524 -=== **Rückgabewert** === 525 - 526 -Das Cmdlet gibt für jeden versuchten Startvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen: 527 - 528 -* **InstanceName**: Der Name des Microservices. 529 -* **InstanceId:** Die Instanz-ID des Microservices. 530 -* **Status**: Das Ergebnis des Startvorgangs (z.B. "Started", "Failed", "AlreadyRunning"). 531 - 532 532 == Stop-AESBMicroservices == 533 533 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 - 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. Wenn nicht angegeben, wird die Standardverbindung verwendet. 538 -|-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestoppt werden sollen. Obligatorisch für Parametersatz `UseSupervisorIdParameterSet`. 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 -|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Stoppvorgang an (z.B. "5s", "1m"). Standardwert: "5s". 541 -|-NoWait |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Stoppvorgangs, sondern kehrt sofort zurück. 542 - 543 -=== **Beispiele** === 544 - 545 -Beispiel 1: Einen Microservice anhand seiner Instanz-ID stoppen 546 - 547 -{{code language="PowerShell"}} 548 -Stop-AESBMicroservices -InstanceIds "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1" 549 -{{/code}} 550 - 551 -Dieser Befehl stoppt den Microservice mit der Instanz-ID "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1" und wartet auf das Ergebnis. 552 - 553 -Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs stoppen mit Timeout 554 - 555 -{{code language="PowerShell"}} 556 -Stop-AESBMicroservices -InstanceIds "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" -Timeout "10s" 557 - 558 -{{/code}} 559 - 560 -Dieser Befehl stoppt zwei Microservices und setzt das Timeout für den Vorgang auf zehn Sekunden. 561 - 562 -Beispiel 3: Alle Microservices eines Supervisors stoppen, ohne auf den Abschluss zu warten 563 - 564 -{{code language="PowerShell"}} 565 -Stop-AESBMicroservices -SupervisorId "FinanceSupervisor" -NoWait 566 - 567 -{{/code}} 568 - 569 -Dieser Befehl initiiert den Stoppvorgang aller Microservices, die vom Supervisor "FinanceSupervisor" verwaltet werden, und kehrt sofort zurück. 570 - 571 -Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs stoppen 572 - 573 -{{code language="PowerShell"}} 574 -"c7e323e9-abc1-4150-a4a3-afb4e57e9cb1", "another-guid-for-stop" | Stop-AESBMicroservices 575 - 576 -{{/code}} 577 - 578 -Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Stop-AESBMicroservices`, um die entsprechenden Microservices zu stoppen. 579 - 580 -=== **Rückgabewert** === 581 - 582 -Das Cmdlet gibt für jeden versuchten Stoppvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen: 583 - 584 -* **Status**: Der Status der Operation (z.B. "Changed", "Unchanged", "Failed") 585 -* **InstanceId**: Die Instanz-ID des Microservices. 586 -* **InstanceState**: Der Zustand des Microservices nach dem versuchten Stoppvorgang (z.B. "Stopped", "Running"). 587 -* **Error**: Fehlermeldungen, falls der Stoppvorgang nicht erfolgreich war. 588 - 589 589 = Packages = 590 590 591 591 == Get-AESBMicroservicePackages == 592 592 593 -Dieses Cmdlet ruft eine Liste aller verfügbaren Microservice-Pakete und deren Versionen ab. Es sind keine spezifischen Parameter erforderlich. 594 - 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. Wenn nicht angegeben, wird die Standardverbindung verwendet. 597 - 598 -=== **Beispiele** === 599 - 600 -Beispiel 1: Alle verfügbaren Microservice-Pakete auflisten 601 - 602 -{{code language="PowerShell"}} 603 -Get-AESBMicroservicePackages 604 - 605 -{{/code}} 606 - 607 -Dieser Befehl ruft alle verfügbaren Microservice-Pakete und die zugehörigen Versionen ab. 608 - 609 -=== **Rückgabewert** === 610 - 611 -Das Cmdlet gibt für jedes gefundene Microservice-Paket ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen: 612 - 613 -* **PackageName**: Der Name des Microservice-Pakets. 614 -* **PackageVersions**: Eine Liste der verfügbaren Versionen für dieses Paket. 615 - 616 616 = Templates = 617 617 618 618 == Add-AESBMicroserviceTemplate == 619 619 620 -Dieses Cmdlet fügt eine Microservice-Vorlage auf Basis der beigefügten Vorlagen-Konfiguration hinzu. 621 - 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. 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 - 627 -=== **Beispiele** === 628 - 629 -Beispiel 1: Fügt ein neues Microservice-Template hinzu 630 - 631 -{{code language="PowerShell"}} 632 -Add-AESBMicroserviceTemplate -TemplateName "Test" -TemplateConfig $templateConfig 633 -{{/code}} 634 - 635 -Dieses Beispiel fügt eine neue Templatekonfiguration mit dem Namen "Test" auf Basis des $templateConfig-Objekts hinzu. Die Standardverbindung wird verwendet. 636 - 637 -{{apimacro title="Beispiel der Funktion in PowerShell"}} 638 -{{code language="PowerShell" layout="LINENUMBERS"}} 639 -function Add-MicroserviceTemplate { 640 - param ( 641 - [string]$Name 642 - ) 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 651 -} 652 -{{/code}} 653 -{{/apimacro}} 654 - 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}} 685 - 686 -=== **Rückgabewerte** === 687 - 688 -Bei erfolgreicher Anwendung erhalten Sie zwei Objekte zurück. 689 - 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 703 - 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}} 722 - 723 723 == Export-MicroserviceTemplateConfig == 724 724 725 -Dieses Cmdlet ermöglicht es, die Konfiguration einer Microservice-Vorlagen zu exportieren. 726 - 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. 731 - 732 -=== **Beispiele** === 733 - 734 -Beispiel 1: MicroserviceTemplate exportieren 735 - 736 -{{code language="PowerShell"}} 737 -Export-AESBMicroserviceTemplateConfig -TemplateConfig $templateConfig -Path $path 738 - 739 -{{/code}} 740 - 741 -In diesem Beispiel wird die //$templateConfig// am Speicherort "C:\Test.xml" exportiert. 742 - 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}} 758 - 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}} 789 - 790 -=== Rückgabewerte === 791 - 792 -Nach erfolgreichem Exportieren erhalten Sie eine Statusmeldung zurück. 793 - 794 -{{code language="none"}} 795 -Writing the file was successful. 796 - 797 -{{/code}} 798 - 799 799 == Get-AESBMicroserviceTemplateConfig == 800 800 801 -Dieses Cmdlet fragt die TemplateConfig einer bestimmten Microservice-Vorlage ab. 802 - 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. 806 - 807 -=== Beispiele === 808 - 809 -Beispiel 1: MicroserviceTemplateConfig von //$templateName// anfragen 810 - 811 -{{code language="PowerShell"}} 812 -Get-AESBMicroserviceTemplateConfig -TemplateName $templateName 813 -{{/code}} 814 - 815 -Dieses Beispiel fragt die Templatekonfiguration mit dem Namen //$templateName// an. Die Standardverbindung wird verwendet. 816 - 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}} 827 - 828 -=== Rückgabewerte === 829 - 830 -Bei erfolgreicher Anwendung erhalten Sie die gewünschte Microservice-Konfiguration zurück: 831 - 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 839 - 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}} 853 - 854 854 == Import-AESBMicroserviceTemplateConfig == 855 855 856 -Dieses Cmdlet importiert die Templatekonfiguration vom angegebenen Pfad. 857 - 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. 861 - 862 -=== Beispiele === 863 - 864 -Beispiel 1: Templatekonfiguration von //$path// laden 865 - 866 -{{code language="PowerShell"}} 867 -Import-AESBMicroserviceTemplateConfig -Path $path 868 - 869 -{{/code}} 870 - 871 -Dieses Beispiel importiert die Templatekonfiguration beim hinterlegten Pfad. Die Standardverbindung wird verwendet. 872 - 873 -=== Rückgabewerte === 874 - 875 -Bei erfolgreicher Anwendung erhalten Sie die gewünschte MicroserviceConfiguration zurück: 876 - 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 884 - 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}} 898 - 899 899 == Migrate-AESBMicroserviceTemplate == 900 900 901 -Mit diesem Cmdlet werden bestehende Vorlagen auf die gewünschte Zielversion übertragen. 902 - 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. 908 - 909 -=== Beispiele === 910 - 911 -Beispiel 1: Mehrere Templates auf Version //$templateVersion// migrieren 912 - 913 -{{code language="PowerShell"}} 914 -Migrate-AESBMicroserviceTemplates -TemplateNames $templateNames -TargetVersion $templateVersion 915 - 916 -{{/code}} 917 - 918 -Dieses Beispiel migriert alle Templates die in //$templateNames// stehen auf die Version //$templateVersion//. 919 - 920 -=== Rückgabewerte === 921 - 922 -Bei erfolgreicher Anwendung erhalten Sie eine Liste von Template-Informationen mit den neuen Daten der erfolgreich migrierten Templates: 923 - 924 -* TemplateInfo 925 -** TemplateId 926 -*** Die neu erstellte / gleichbleibende Id des Templates 927 -** Configuration 928 -*** Die aktuelle Konfiguration des Templates 929 -** Name 930 -*** Der neue Name des Template 931 -** Type 932 -*** Der Typ des Templates 933 -** Version 934 -*** Die neue Version des Templates 935 - 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}} 947 - 948 948 == New-AESBMicroserviceTemplateConfig == 949 949 950 -Mit diesem Cmdlet wird eine neue Vorlagen-Konfiguration auf Basis des Pakets erstellt. 951 - 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. 956 - 957 -=== Beispiele === 958 - 959 -Beispiel 1: MicroserviceTemplateConfig erstellen 960 - 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}} 967 - 968 -Dieses Beispiel erstellt eine Template-Konfiguration auf Basis des angegebenen Microservicepackage. 969 - 970 -=== Rückgabewerte === 971 - 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 979 - 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}} 993 - 994 994 == Remove-AESBMicroserviceTemplate == 995 995 996 -Mit diesem Cmdlet können Sie Microservice-Vorlagen löschen. 997 - 998 - 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. 1003 - 1004 -=== Beispiele === 1005 - 1006 -Beispiel 1: Template löschen 1007 - 1008 -{{code language="PowerShell"}} 1009 -Remove-AESBMicroserviceTemplate -TemplateIds 4b016fd1-47fb-4f24-87dd-4e365fe870d3 1010 - 1011 -{{/code}} 1012 - 1013 -Dieses Beispiel löscht ein Microservice Template auf Basis der angegebenen Id. 1014 - 1015 -Beispiel 2: Templates löschen 1016 - 1017 -{{code language="PowerShell"}} 1018 -Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3", "D1936807-E1B0-4F8B-AB7F-98ECD202CF8F" 1019 -{{/code}} 1020 - 1021 -Dieses Beispiel löscht mehrere Microservice Templates auf Basis der angegebenen Ids. 1022 - 1023 -Beispiel 3: Templates löschen mitsamt den Referenzen 1024 - 1025 -{{code language="PowerShell"}} 1026 -Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3" -RemoveReferences 1027 - 1028 -{{/code}} 1029 - 1030 -Dieses Beispiel löscht ein Microservice Template misamt den erstellten Referenzen des Templates. 1031 - 1032 -=== Rückgabewerte === 1033 - 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 1041 - 1042 -{{code language="PowerShell"}} 1043 -StatusResult TemplateId Message 1044 ------------- ---------- ------- 1045 - Success bde8016f-8557-4438-a165-ab05a4a78db4 The template was successfully removed. 1046 -{{/code}} 1047 - 1048 1048 == Update-AESBMicroserviceTemplate == 1049 - 1050 -Dieses Cmdlet aktualisiert die Microservice-Vorlage mittels der beigefügten Microservice-Vorlagen-Konfiguration. 1051 - 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. 1056 - 1057 -=== Beispiele === 1058 - 1059 -Beispiel 1: Template updaten 1060 - 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}} 1073 - 1074 -Dieses Beispiel updated das Template mit der beigefügten Konfiguration. 1075 - 1076 -=== Rückgabewerte === 1077 - 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}}