Basis-Cmdlets
- Add-AESBConnection
- Close-AESBConnection
- Close-AESBConnections
- Edit-AESBConnection
- Get-AESBConnection
- Get-AESBConnections
- Get-AESBMessageCount
- Import-AESBPublicApiCommands
- New-AESBShell
- Open-AESBConnection
- Receive-AESBMessage
- Receive-AESBMessages
- Remove-AESBConnection
- Set-AESBDefaultConnection
- Show-AESBInfrastructure
- Stop-AESBScript
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.
| Parameter | Datentyp | Optional | Alias | Beschreibung |
|---|---|---|---|---|
| -ConnectionName | String | ❌ | Keine | Der Name der SICS-Verbindung. |
| -Server | String | ❌ | Keine | Die IP-Adresse oder der DNS-Name des Zielservers. |
| -Port | Int | ❌ | Keine | Der Port, über den die Verbindung hergestellt wird. Der Standardwert ist 3950. Es können Werte im Bereich 1 bis 65535 angegeben werden. |
| -Username | String | ❌ | Keine | Der Benutzername für die Authentifizierung. |
| -Password | SecureString | ❌ | Keine | Das Passwort für die Verbindung. |
| -Description | String | ✅ | Keine | Eine Beschreibung oder Notiz zur Verbindung. |
Beispiele
Beispiel 1: Hinzufügen einer Verbindung mit Standardport 3950
Beispiel 2: Hinzufügen einer Verbindung zu einem Server über den Port 8080 mit benutzerdefiniertem Port und Beschreibung
Beispiel 3: Hinzufügen einer Verbindung mit Nutzung der interaktiven Eingabe
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.
| Parameter | Datentyp | Optional | Alias | 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"
Beispiel 2: Schließen der Standardverbindung, da kein -ConnectionName-Parameter angegeben ist.
Close-AESBConnections
Dieses Cmdlet schließt alle offenen SICS-Verbindungen im Connection-Verzeichnis.
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.
| Parameter | Datentyp | Optional | Alias | 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
Beispiel 2: Explizite Änderung der Serveradresse und des Ports der SICS-Verbindung "MyConnection"
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.
| Parameter | Datentyp | Optional | Alias | Beschreibung |
|---|---|---|---|---|
| -ConnectionName | String | ✅ | Keine | Der Name der SICS-Verbindung, deren Details angezeigt werden sollen. Wenn nicht angegeben, wird die Standardverbindung angezeigt. |
Beispiele
Beispiel 1: Anzeigen von Detail-Informationen der spezifischen SICS-Verbindung "MyConnection"
Beispiel 2: Anzeigen von Details der Standardverbindung
Ausgabe
Die Ausgabe des Cmdlets würde beispielsweise für die SICS-Verbindung mit dem Namen "test" folgendermaßen aussehen:
2
3
4
5
6
7
8
9
10
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
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.
Ausgabe
Die Ausgabe des Cmdlets würde beispielsweise folgendermaßen aussehen:
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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
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.
| Parameter | Datentyp | Optional | Alias | 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
Beispiel 2: Anzahl der Nachrichten in der Standardverbindung "MyConnection" anzeigen
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.
| Parameter | Datentyp | Optional | Alias | 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"
Beispiel 2: Importieren der PublicAPI-Cmdlets über die Standardverbindung
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.
Note:
Dieses Cmdlet ist nicht erforderlich, wenn die AESB Shell als eigene Anwendung gestartet wurde (z.B. über das Desktop-Icon).
| Parameter | Datentyp | Optional | Alias | 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
Beispiel 2: Initialisieren der AESB Shell mit dem Standard-Speicherort
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.
| Parameter | Datentyp | Optional | Alias | 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
Beispiel 2: Öffnen der Standardverbindung
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.
| Parameter | Datentyp | Optional | Alias | 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
Beispiel 2: Eine Nachricht von der Standardverbindung lesen und 10 Sekunden warten
Beispiel 3: Eine Nachricht von der Standardverbindung lesen und 1 Minute warten
Beispiel 4: Eine Nachricht von der Standardverbindung lesen und 5 Stunden warten
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.
| Parameter | Datentyp | Optional | Alias | 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. |
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
Beispiel 2: Drei Nachrichten von der Standardverbindung empfangen
Beispiel 3: Nachrichten von der spezifischen Verbindung "TestConnection" empfangen
Beispiel 4: Fünf Nachrichten von der spezifischen Verbindung "TestConnection" empfangen
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.
| Parameter | Datentyp | Optional | Alias | 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"
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.
| Parameter | Datentyp | Optional | Alias | Beschreibung |
|---|---|---|---|---|
| -ConnectionName | String | ❌ | Keine | Der Name der SICS-Verbindung, die als neue Standardverbindung gesetzt werden soll. |
Beispiele
Beispiel 1: Festlegen einer neuen Standardverbindung
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.
| Parameter | Datentyp | Optional | Alias | 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
Beispiel 2: Infrastruktur der spezifischen Verbindung "MyConnection" anzeigen
Beispiel 3: Infrastruktur mit eingeschlossenem virtuellen Router "Router3" anzeigen
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