Changes for page Basis-Cmdlets

Last modified by jklein on 2025/06/02 08:17

From 6.1 to 7.1 From 21.1 to 22.1

From version 7.1

edited by jklein
on 2024/11/28 15:17

Change comment: There is no comment for this version

To version 21.1

edited by jklein
on 2025/06/02 08:11

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Basis-Cmdlets
++Basis-Cmdlets

Content

@@ -7,9 +7,16 @@
  Dieses Cmdlet fügt eine neue SICS-Verbindung hinzu. Alle hinzugefügten Verbindungen werden in einem Verzeichnis gesammelt und sind systemweit verfügbar. Daher sind sie in allen AESB Shell-Sessions auf demselben PC verwendbar. Die erste Verbindung, die zu diesem Verzeichnis hinzugefügt wird, wird als Standardverbindung festgelegt. Falls keine Parameter beim Hinzufügen der Verbindung angegeben werden, werden die Werte für diese Parameter interaktiv angefordert und können einzeln eingetragen werden.
++{{showhide showmessage="Zeigen" hidemessage="Verbergen"}}
++{{code language="powershell"}}
++Add-AESBConnection -ConnectionName "MyConnection" -Server "server.example.com" -Port 3950 -Username "user" -Password (ConvertTo-SecureString "password" -AsPlainText -Force)
++
++{{/code}}
++{{/showhide}}
++
  (% style="width:1018px" %)
  |=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
--|(% style="width:170px" %)-ConnectionName|(% style="width:119px" %)String|(% style="width:84px" %)❌|(% style="width:56px" %)Keine|(% style="width:582px" %)Der Name der Verbindung.
++|(% style="width:170px" %)-ConnectionName|(% style="width:119px" %)String|(% style="width:84px" %)❌|(% style="width:56px" %)Keine|(% style="width:582px" %)Der Name der SICS-Verbindung.
  |(% style="width:170px" %)-Server|(% style="width:119px" %)String|(% style="width:84px" %)❌|(% style="width:56px" %)Keine|(% style="width:582px" %)Die IP-Adresse oder der DNS-Name des Zielservers.
  |(% style="width:170px" %)-Port|(% style="width:119px" %)Int|(% style="width:84px" %)❌|(% style="width:56px" %)Keine|(% style="width:582px" %)Der Port, über den die Verbindung hergestellt wird. Der Standardwert ist 3950. Es können Werte im Bereich 1 bis 65535 angegeben werden.
  |(% style="width:170px" %)-Username|(% style="width:119px" %)String|(% style="width:84px" %)❌|(% style="width:56px" %)Keine|(% style="width:582px" %)Der Benutzername für die Authentifizierung.
@@ -42,7 +42,7 @@
  Dieses Cmdlet schließt eine offene SICS-Verbindung. Wenn der //-ConnectionName//-Parameter angegeben wird, wird entsprechend die spezifische Verbindung geschlossen. Anderenfalls wird die Standardverbindung geschlossen. Da der einzige Parameter des Cmdlets optional ist, erfolgt keine interaktive Nachfrage, falls kein Parameter angegeben wird und keine Standardverbindung vorhanden ist.
  |=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
--|-ConnectionName|String|✅|Keine|Der Name der Verbindung, die geschlossen werden soll. Wenn nicht angegeben, wird die Standardverbindung geschlossen.
++|-ConnectionName|String|✅|Keine|Der Name der SICS-Verbindung, die geschlossen werden soll. Wenn nicht angegeben, wird die Standardverbindung geschlossen.
  === **Beispiele** ===
@@ -62,7 +62,6 @@
  = Close-AESBConnections =
--
  Dieses Cmdlet schließt alle offenen SICS-Verbindungen im Connection-Verzeichnis.
  {{code language="powershell"}}
@@ -75,7 +75,7 @@
  Mit diesem Cmdlet können Sie eine bestehende SICS-Verbindung bearbeiten. Es ermöglicht das Aktualisieren von Verbindungseigenschaften wie Serveradresse, Port, Benutzername, Passwort und Beschreibung.
  |=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
--|-ConnectionName|String|✅|Keine|Der Name der Verbindung, die bearbeitet werden soll.
++|-ConnectionName|String|✅|Keine|Der Name der SICS-Verbindung, die bearbeitet werden soll.
  |-Description|String|❌|Keine|Eine neue Beschreibung oder Notiz zur Verbindung.
  |-Password|SecureString|❌|Keine|Das neue Passwort für die Verbindung.
  |-Port|Int|❌|Keine|Der neue Port, über den die Verbindung hergestellt wird.Wertebereich ist 1 bis 65535.
@@ -84,7 +84,7 @@
  === **Beispiele** ===
--Beispiel 1: Vollständiges Bearbeiten der bestehenden SICS-Verbindung "MyConnection" mit der Möglichkeit zur Änderung allen Parameter
++Beispiel 1: Vollständiges Bearbeiten der bestehenden SICS-Verbindung "MyConnection" mit der Möglichkeit zur Änderung aller Parameter
  {{code language="powershell"}}
  Edit-AESBConnection -ConnectionName "MyConnection" -Server "newserver.example.com" -Port 3960 -Username "newuser" -Password (ConvertTo-SecureString "newpassword" -AsPlainText -Force) -Description "Updated connection"
@@ -100,24 +100,338 @@
  = Get-AESBConnection =
++Dieses Cmdlet holt und zeigt die Detail-Informationen der angegebenen SICS-Verbindung an. Wenn der Parameter //-ConnectionName// nicht mit angegeben wird, erhalten Sie die Informationen zur Standardverbindung. Da der einzige Parameter des Cmdlets optional ist, erfolgt keine interaktive Nachfrage, falls kein Parameter angegeben wird und keine Standardverbindung vorhanden ist.
++|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
++|-ConnectionName|String|✅|Keine|Der Name der SICS-Verbindung, deren Details angezeigt werden sollen. Wenn nicht angegeben, wird die Standardverbindung angezeigt.
++=== (% id="cke_bm_25028S" style="display:none" %)** **(%%)**Beispiele** ===
++
++Beispiel 1: Anzeigen von Detail-Informationen der spezifischen SICS-Verbindung "MyConnection"
++
++{{code language="powershell"}}
++Get-AESBConnection -ConnectionName "MyConnection"
++
++{{/code}}
++
++Beispiel 2: Anzeigen von Details der Standardverbindung
++
++{{code language="powershell"}}
++Get-AESBConnection
++
++{{/code}}
++
++**Ausgabe**
++
++Die Ausgabe des Cmdlets würde beispielsweise für die SICS-Verbindung mit dem Namen "test" folgendermaßen aussehen:
++
++{{code language="none" layout="LINENUMBERS"}}
++Endpoint            : wss://localhost:3950
++Name                : test
++Username            : Operator
++Description         :
++IsDefaultConnection : True
++VirtualRouter       : SHELL
++CallbackTargetName  : Aagon.Shell.test.345b8cc1-57de-4dd9-9888-0add6738e9b7
++TargetRoutingKeys   : SHELL:SICS.Aagon.Shell.test.345b8cc1-57de-4dd9-9888-0add6738e9b7
++ConnectionInfo      : Aagon.Sis.Sics.Powershell.Libs.Types.ConnectionInfo
++IsOnline            : True
++{{/code}}
++
  = Get-AESBConnections =
++Dieses Cmdlet gibt eine Liste aller existierenden SICS-Verbindungen aus. Dabei werden die Detail-Informationen jeder Verbindung angezeigt.
++
++=== **Beispiele** ===
++
++Beispiel 1: Anzeigen aller existierenden SICS-Verbindungen.
++
++{{code language="powershell"}}
++Get-AESBConnections
++
++{{/code}}
++
++**Ausgabe**
++
++Die Ausgabe des Cmdlets würde beispielsweise folgendermaßen aussehen:
++
++{{code language="none" layout="LINENUMBERS"}}
++Endpoint            : wss://localhost:3950
++Name                : local
++Username            : operator
++Description         :
++IsDefaultConnection : False
++VirtualRouter       : SHELL
++CallbackTargetName  : Aagon.Shell.local.345b8cc1-57de-4dd9-9888-0add6738e9b7
++TargetRoutingKeys   : ----
++ConnectionInfo      : Aagon.Sis.Sics.Powershell.Libs.Types.ConnectionInfo
++IsOnline            : False
++
++Endpoint            : wss://localhost:3950
++Name                : test
++Username            : Operator
++Description         :
++IsDefaultConnection : True
++VirtualRouter       : SHELL
++CallbackTargetName  : Aagon.Shell.test.345b8cc1-57de-4dd9-9888-0add6738e9b7
++TargetRoutingKeys   : SHELL:SICS.Aagon.Shell.test.345b8cc1-57de-4dd9-9888-0add6738e9b7
++ConnectionInfo      : Aagon.Sis.Sics.Powershell.Libs.Types.ConnectionInfo
++IsOnline            : True
++{{/code}}
++
  = Get-AESBMessageCount =
++Dieses Cmdlet gibt die Anzahl der Nachrichten in der Warteschlange der angegebenen SICS-Verbindung zurück. Wenn der Parameter// -ConnectionName// nicht angegeben wird, erhalten Sie die Informationen zur Standardverbindung.
++
++|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
++|-ConnectionName|String|✅|Keine|Der Name der SICS-Verbindung, für die die Anzahl der Nachrichten ermittelt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++
++=== **Beispiele** ===
++
++Beispiel 1: Anzahl der Nachrichten für die spezifische SICS-Verbindung "MyConnection" anzeigen
++
++{{code language="powershell"}}
++Get-AESBMessageCount -ConnectionName "MyConnection"
++
++{{/code}}
++
++Beispiel 2: Anzahl der Nachrichten in der Standardverbindung "MyConnection" anzeigen
++
++{{code language="powershell"}}
++Get-AESBMessageCount
++{{/code}}
++
  = Import-AESBPublicApiCommands =
++Dieses Cmdlet importiert die PublicAPI-Cmdlets von ACMP in die PowerShell-Sitzung. Die Cmdlets werden über die angegebene SICS-Verbindung von dem SICS-Server heruntergeladen, mit dem die Verbindung besteht. Wenn der Parameter //-ConnectionName// nicht angegeben wird, wird die Standardverbindung für den Import verwendet.
++
++|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
++|-ConnectionName|String|✅|Keine|Der Name der SICS-Verbindung, über welche die PublicAPI-Cmdlets importiert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++|-Prefix|String|✅|Keine|Sofern ein Prefix angegeben wird, wird dies bei allen zu importierenden Cmdlets vor den eigentlichen Cmdlet-Namen hinzugefügt.
++
++=== **Beispiele** ===
++
++Beispiel 1: Importieren der PublicAPI-Cmdlets über die spezifische Verbindung "MyConnection"
++
++{{code language="powershell"}}
++Import-AESBPublicApiCommands -ConnectionName "MyConnection"
++
++{{/code}}
++
++Beispiel 2: Importieren der PublicAPI-Cmdlets über die Standardverbindung
++
++{{code language="powershell"}}
++Import-AESBPublicApiCommands
++{{/code}}
++
  = New-AESBShell =
++Dieses Cmdlet wird verwendet, um eine neue AESB Shell zu initialisieren, wenn die AESB Shell nicht normal gestartet worden ist, sondern die einzelnen Module manuell in einer PowerShell-Sitzung eingebunden werden. Es legt fest, wo Konfigurationen und andere Daten gespeichert werden sollen.
++
++{{aagon.infobox}}
++Dieses Cmdlet ist nicht erforderlich, wenn die AESB Shell als eigene Anwendung gestartet wurde (z.B. über das Desktop-Icon).
++{{/aagon.infobox}}
++
++|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
++|-ConfigurationPath|String|✅|Keine|Der Pfad zum Verzeichnis, in dem die Shell-Konfiguration und andere Elemente gespeichert werden sollen. Wenn nicht angegeben, wird der Standardpfad verwendet.
++
++=== **Beispiele** ===
++
++Beispiel 1: Initialisieren der AESB Shell mit einem spezifischen Speicherort für Konfiguration und andere Elemente
++
++{{code language="powershell"}}
++New-AESBShell -ConfigurationPath "C:\Path\To\Save\Configs"
++
++{{/code}}
++
++Beispiel 2: Initialisieren der AESB Shell mit dem Standard-Speicherort
++
++{{code language="powershell"}}
++New-AESBShell
++{{/code}}
++
  = Open-AESBConnection =
++Mit diesem Cmdlet wird versucht, eine bereits hinzugefügte Verbindung zu einer SICS-Instanz zu öffnen. Wenn der Parameter //-ConnectionName// nicht angegeben wird, wird versucht die Standardverbindung zu öffnen. Da die Parameter des Cmdlets optional sind, erfolgt keine interaktive Nachfrage, falls kein Parameter angegeben wird und keine Standardverbindung vorhanden ist.
++
++|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
++|-ConnectionName|String|✅|Keine|Der Name der Verbindung, die geöffnet werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++|-AsDefaultConnection|-|✅|Keine|Die aktuelle Verbindung wird als Default für die Lebensdauer der Console gesetzt.
++
++=== **Beispiele** ===
++
++Beispiel 1: Öffnen der spezifischen SICS-Verbindung "MyConnection
++
++{{code language="powershell"}}
++Open-AESBConnection -ConnectionName "MyConnection"
++
++{{/code}}
++
++Beispiel 2: Öffnen der Standardverbindung
++
++{{code language="powershell"}}
++Open-AESBConnection
++{{/code}}
++
  = Receive-AESBMessage =
++Mit diesem Cmdlet kann eine Nachricht aus der Queue der verbundenen SICS-Instanz ausgelesen werden. Wenn der Parameter //-ConnectionName// nicht angegeben wird, wird die Standardverbindung verwendet. Der Parameter //-Wait// gibt die Wartezeit an, bevor das Cmdlet aufhört, nach einer Nachricht zu suchen.
++
++|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
++|-ConnectionName|String|✅|Keine|Der Name der Verbindung, von der die Nachricht gelesen werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++|-Wait|String|✅|Keine|Die Zeitdauer, in der auf eine Nachricht gewartet wird. Kann in Sekunden (s oder sec oder second(s)), Minuten (m oder min oder minute(s)) oder Stunden (h oder hour(s)) oder Tage (d oder day(s)) angegeben werden.
++
++=== **Beispiele** ===
++
++Beispiel 1: Eine Nachricht von der spezifischen Verbindung "MyConnection" lesen und 5 Sekunden warten
++
++{{code language="powershell"}}
++Receive-AESBMessage -ConnectionName "MyConnection" -Wait 5s
++{{/code}}
++
++Beispiel 2: Eine Nachricht von der Standardverbindung lesen und 10 Sekunden warten
++
++{{code language="powershell"}}
++Receive-AESBMessage -Wait 10s
++{{/code}}
++
++Beispiel 3: Eine Nachricht von der Standardverbindung lesen und 1 Minute warten
++
++{{code language="powershell"}}
++Receive-AESBMessage -Wait 1min
++{{/code}}
++
++Beispiel 4: Eine Nachricht von der Standardverbindung lesen und 5 Stunden warten
++
++{{code language="powershell"}}
++Receive-AESBMessage -Wait 5h
++{{/code}}
++
  = Receive-AESBMessages =
++Mit diesem Cmdlet können mehrere Nachrichten aus der Queue der verbundenen SICS-Instanz ausgelesen werden. Die Anzahl der Nachrichten, die empfangen werden sollen, kann im Parameter festgelegt werden.
++
++|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
++|-MessageCount|int|✅|-|Die Anzahl der Nachrichten, die empfangen werden sollen. Wenn nicht angegeben, wird standardmäßig eine Nachricht empfangen.
++|-Wait|string|✅|-|Die Zeitdauer, in der auf eine Nachricht gewartet wird. Kann in Sekunden (s oder sec oder second(s)), Minuten (m oder min oder minute(s)) oder Stunden (h oder hour(s)) oder Tage (d oder day(s)) angegeben werden.
++|-Timeout|string|✅|-|Die Zeitdauer, bis ein Timeout Fehler erscheint. Kann in Sekunden (s oder sec oder second(s)), Minuten (m oder min oder minute(s)) oder Stunden (h oder hour(s)) oder Tage (d oder day(s)) angegeben werden.
++
++=== (% id="cke_bm_167708S" style="display:none" %)** **(%%)Parameter-Sets ===
++
++Für die Parameter dieses Cmdlets wurden eigene Parameter-Sets definiert, die Sie verwenden können:
++
++* (((
++WaitParameterSet - Wait
++)))
++* (((
++MessageCountParameterSet - MessageCount, Timeout
++)))
++
++=== **Beispiele** ===
++
++Beispiel 1: Eine Nachricht von der Standardverbindung empfangen
++
++{{code language="powershell"}}
++Receive-AESBMessages
++{{/code}}
++
++Beispiel 2: Drei Nachrichten von der Standardverbindung empfangen
++
++{{code language="powershell"}}
++Receive-AESBMessages -MessageCount 3
++{{/code}}
++
++Beispiel 3: Nachrichten von der spezifischen Verbindung "TestConnection" empfangen
++
++{{code language="powershell"}}
++Receive-AESBMessages -ConnectionName "TestConnection"
++{{/code}}
++
++Beispiel 4: Fünf Nachrichten von der spezifischen Verbindung "TestConnection" empfangen
++
++{{code language="powershell"}}
++Receive-AESBMessages -ConnectionName "TestConnection" -MessageCount 5
++
++{{/code}}
++
  = Remove-AESBConnection =
++Dieses Cmdlet löscht eine SICS-Verbindung aus dem Verzeichnis aller Verbindungen. Dabei muss im Parameter //-ConnectionName// angegebenen werden, welche SICS-Verbindung konkret entfernt werden soll.
++
++|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
++|-ConnectionName|String|❌|Keine|Der Name der SICS-Verbindung, die aus dem Verzeichnis aller Verbindungen entfernt werden soll.
++
++=== **Beispiele** ===
++
++Beispiel 1: Entfernen der spezifischen Verbindung "MyConnection"
++
++{{code language="powershell"}}
++Remove-AESBConnection -ConnectionName "MyConnection"
++{{/code}}
++
  = Set-AESBDefaultConnection =
++Mit diesem Cmdlet kann der Benutzer eine neue Standardverbindung für die AESB Shell festlegen. Die angegebene Verbindung wird zur Standardverbindung für alle zukünftigen Cmdlet-Aufrufe, bei denen keine andere Verbindung angegeben ist.
++
++|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
++|-ConnectionName|String|❌|Keine|Der Name der SICS-Verbindung, die als neue Standardverbindung gesetzt werden soll.
++
++=== **Beispiele** ===
++
++Beispiel 1: Festlegen einer neuen Standardverbindung
++
++{{code language="powershell"}}
++Remove-AESBConnection -ConnectionName "MyConnection"
++{{/code}}
++
  = Show-AESBInfrastructure =
++
++Dieses Cmdlet zeigt die aktuelle Infrastruktur des AESB Systems an, einschließlich der virtuellen Router und weiterer konfigurierter Elemente. Es ermöglicht eine detaillierte Ansicht der Systemkonfiguration.
++
++|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
++|-ConnectionName|string|✅|None|Der Name der Verbindung, für die die Infrastruktur angezeigt wird.
++|-ExcludeVirtualRouters|string[]|✅|None|Eine Liste von virtuellen Routern, die von der Anzeige ausgeschlossen werden sollen.
++|-IncludeVirtualRouters|string[]|✅|None|Eine Liste von virtuellen Routern, die in die Anzeige eingeschlossen werden sollen.
++
++=== Parameter-Sets ===
++
++Für die Parameter dieses Cmdlets wurden eigene Parameter-Sets definiert, die Sie verwenden können:
++
++(((
++* IncludeVirtualRoutersParameterSet- IncludeVirtualRouters
++* ExcludeVirtualRoutersParameterSet- ExcludeVirtualRouters
++)))
++
++=== **Beispiele** ===
++
++Beispiel 1:** **Infrastruktur ohne die virtuellen Router "Router1" und "Router2" anzeigen
++
++{{code language="powershell"}}
++Show-AESBInfrastructure -ExcludeVirtualRouters "Router1", "Router2"
++{{/code}}
++
++Beispiel 2: Infrastruktur der spezifischen Verbindung "MyConnection" anzeigen
++
++{{code language="powershell"}}
++Show-AESBInfrastructure -ConnectionName "MyConnection"
++
++{{/code}}
++
++Beispiel 3: Infrastruktur mit eingeschlossenem virtuellen Router "Router3" anzeigen
++
++{{code language="powershell"}}
++Show-AESBInfrastructure -IncludeVirtualRouters "Router3"
++
++{{/code}}
++
++= Stop-AESBScript =
++
++Mit diesem Cmdlet wird das Script oder der Microservice gestoppt, in dem das Cmdlet aufgerufen wird. Bei einem Fehlerfall wird der Fehler ausgegeben. Ruft man das Cmdlet in der AESB-Shell-Console auf, schließt sich die Console.
++
++=== **Beispiele** ===
++
++Beispiel 1: Stoppen des AESBScripts
++
++{{code language="powershell"}}
++Stop-AESBScript
++{{/code}}