- 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
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 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 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 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 allen 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 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 zeigt 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