Changes for page Basis-Cmdlets

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

From 7.2 to 7.3 From 9.1 to 10.1

From version 7.3

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

Change comment: There is no comment for this version

To version 9.1

edited by jklein
on 2024/12/02 16:11

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -224,12 +224,97 @@
  = 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.
++
  = Remove-AESBConnection =
  = Set-AESBDefaultConnection =