Changes for page Basis-Cmdlets

Last modified by jklein on 2025/01/22 15:09

From 7.3 to 7.4

From version 1.1

edited by jklein
on 2024/11/28 10:32

Change comment: There is no comment for this version

To version 7.3

edited by jklein
on 2024/12/02 13:18

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -1,1 +1,237 @@
  {{aagon.floatingbox/}}
++
++(% class="wikigeneratedid" %)
++Bei den Basic-Cmdlets handelt es sich um Shell-Befehle, die primär für das Verbindungsmanagement und das grundsätzliche Arbeiten mit Messages relevant sind.
++
++= Add-AESBConnection =
++
++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.
++
++(% 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 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.
++|(% style="width:170px" %)-Password|(% style="width:119px" %)SecureString|(% style="width:84px" %)❌|(% style="width:56px" %)Keine|(% style="width:582px" %)Das Passwort für die Verbindung.
++|(% style="width:170px" %)-Description|(% style="width:119px" %)String|(% style="width:84px" %)✅|(% style="width:56px" %)Keine|(% style="width:582px" %)Eine Beschreibung oder Notiz zur Verbindung.
++
++=== **Beispiele** ===
++
++Beispiel 1: Hinzufügen einer Verbindung mit Standardport 3950
++
++{{code language="powershell"}}
++Add-AESBConnection -ConnectionName "MyConnection" -Server "server.example.com" -Port 3950 -Username "user" -Password (ConvertTo-SecureString "password" -AsPlainText -Force)
++
++{{/code}}
++
++Beispiel 2: Hinzufügen einer Verbindung// //zu einem Server über den Port 8080 mit benutzerdefiniertem Port und Beschreibung
++
++{{code language="powershell"}}
++Add-AESBConnection -ConnectionName "MyConnection" -Server "192.168.1.1" -Port 8080 -Username "user" -Password (ConvertTo-SecureString "password" -AsPlainText -Force) -Description "Test connection"
++{{/code}}
++
++Beispiel 3: Hinzufügen einer Verbindung mit Nutzung der interaktiven Eingabe
++
++{{code language="powershell"}}
++Add-AESBConnection
++{{/code}}
++
++= Close-AESBConnection =
++
++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 SICS-Verbindung, die geschlossen werden soll. Wenn nicht angegeben, wird die Standardverbindung geschlossen.
++
++=== **Beispiele** ===
++
++Beispiel 1: Schließen der spezifischen Verbindung "MyConnection"
++
++{{code language="powershell"}}
++Close-AESBConnection -ConnectionName "MyConnection"
++
++{{/code}}
++
++Beispiel 2: Schließen der Standardverbindung, //da //kein //-ConnectionName//-Parameter angegeben ist.
++
++{{code language="powershell"}}
++Close-AESBConnection
++
++{{/code}}
++
++= Close-AESBConnections =
++
++Dieses Cmdlet schließt alle offenen SICS-Verbindungen im Connection-Verzeichnis.
++
++{{code language="powershell"}}
++Close-AESBConnections
++
++{{/code}}
++
++= Edit-AESBConnection =
++
++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 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.
++|-Server|String|❌|Keine|Die neue IP-Adresse oder der DNS-Name des Zielservers.
++|-Username|String|❌|Keine|Der neue Benutzername für die Authentifizierung.
++
++=== **Beispiele** ===
++
++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"
++
++{{/code}}
++
++Beispiel 2: Explizite Änderung der Serveradresse und des Ports der SICS-Verbindung "MyConnection"
++
++{{code language="powershell"}}
++Edit-AESBConnection -ConnectionName "MyConnection" -Server "another.server.com" -Port 8080
++
++{{/code}}
++
++= 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 zeigt 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.
++
++=== **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 =
++
++= Open-AESBConnection =
++
++= Receive-AESBMessage =
++
++= Receive-AESBMessages =
++
++= Remove-AESBConnection =
++
++= Set-AESBDefaultConnection =
++
++= Show-AESBInfrastructure =