Changes for page Basis-Cmdlets

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

From version 6.1
edited by jklein
on 2024/11/28 14:58
Change comment: There is no comment for this version
To version 8.1
edited by jklein
on 2024/12/02 14:24
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -9,7 +9,7 @@
9 9  
10 10  (% style="width:1018px" %)
11 11  |=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
12 -|(% style="width:170px" %)-ConnectionName|(% style="width:119px" %)String|(% style="width:84px" %)❌|(% style="width:56px" %)Keine|(% style="width:582px" %)Der Name der Verbindung.
12 +|(% style="width:170px" %)-ConnectionName|(% style="width:119px" %)String|(% style="width:84px" %)❌|(% style="width:56px" %)Keine|(% style="width:582px" %)Der Name der SICS-Verbindung.
13 13  |(% 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.
14 14  |(% 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.
15 15  |(% 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 @@
42 42  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.
43 43  
44 44  |=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
45 -|-ConnectionName|String|✅|Keine|Der Name der Verbindung, die geschlossen werden soll. Wenn nicht angegeben, wird die Standardverbindung geschlossen.
45 +|-ConnectionName|String|✅|Keine|Der Name der SICS-Verbindung, die geschlossen werden soll. Wenn nicht angegeben, wird die Standardverbindung geschlossen.
46 46  
47 47  === **Beispiele** ===
48 48  
... ... @@ -62,7 +62,6 @@
62 62  
63 63  = Close-AESBConnections =
64 64  
65 -
66 66  Dieses Cmdlet schließt alle offenen SICS-Verbindungen im Connection-Verzeichnis.
67 67  
68 68  {{code language="powershell"}}
... ... @@ -72,20 +72,242 @@
72 72  
73 73  = Edit-AESBConnection =
74 74  
74 +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.
75 +
76 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
77 +|-ConnectionName|String|✅|Keine|Der Name der SICS-Verbindung, die bearbeitet werden soll.
78 +|-Description|String|❌|Keine|Eine neue Beschreibung oder Notiz zur Verbindung.
79 +|-Password|SecureString|❌|Keine|Das neue Passwort für die Verbindung.
80 +|-Port|Int|❌|Keine|Der neue Port, über den die Verbindung hergestellt wird.Wertebereich ist 1 bis 65535.
81 +|-Server|String|❌|Keine|Die neue IP-Adresse oder der DNS-Name des Zielservers.
82 +|-Username|String|❌|Keine|Der neue Benutzername für die Authentifizierung.
83 +
84 +=== **Beispiele** ===
85 +
86 +Beispiel 1: Vollständiges Bearbeiten der bestehenden SICS-Verbindung "MyConnection" mit der Möglichkeit zur Änderung aller Parameter
87 +
88 +{{code language="powershell"}}
89 +Edit-AESBConnection -ConnectionName "MyConnection" -Server "newserver.example.com" -Port 3960 -Username "newuser" -Password (ConvertTo-SecureString "newpassword" -AsPlainText -Force) -Description "Updated connection"
90 +
91 +{{/code}}
92 +
93 +Beispiel 2: Explizite Änderung der Serveradresse und des Ports der SICS-Verbindung "MyConnection"
94 +
95 +{{code language="powershell"}}
96 +Edit-AESBConnection -ConnectionName "MyConnection" -Server "another.server.com" -Port 8080
97 +
98 +{{/code}}
99 +
75 75  = Get-AESBConnection =
76 76  
102 +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.
103 +
104 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
105 +|-ConnectionName|String|✅|Keine|Der Name der SICS-Verbindung, deren Details angezeigt werden sollen. Wenn nicht angegeben, wird die Standardverbindung angezeigt.
106 +
107 +=== (% id="cke_bm_25028S" style="display:none" %)** **(%%)**Beispiele** ===
108 +
109 +Beispiel 1: Anzeigen von Detail-Informationen der spezifischen SICS-Verbindung "MyConnection"
110 +
111 +{{code language="powershell"}}
112 +Get-AESBConnection -ConnectionName "MyConnection"
113 +
114 +{{/code}}
115 +
116 +Beispiel 2: Anzeigen von Details der Standardverbindung
117 +
118 +{{code language="powershell"}}
119 +Get-AESBConnection
120 +
121 +{{/code}}
122 +
123 +**Ausgabe**
124 +
125 +Die Ausgabe des Cmdlets würde beispielsweise für die SICS-Verbindung mit dem Namen "test" folgendermaßen aussehen:
126 +
127 +{{code language="none" layout="LINENUMBERS"}}
128 +Endpoint : wss://localhost:3950
129 +Name : test
130 +Username : Operator
131 +Description :
132 +IsDefaultConnection : True
133 +VirtualRouter : SHELL
134 +CallbackTargetName : Aagon.Shell.test.345b8cc1-57de-4dd9-9888-0add6738e9b7
135 +TargetRoutingKeys : SHELL:SICS.Aagon.Shell.test.345b8cc1-57de-4dd9-9888-0add6738e9b7
136 +ConnectionInfo : Aagon.Sis.Sics.Powershell.Libs.Types.ConnectionInfo
137 +IsOnline : True
138 +{{/code}}
139 +
77 77  = Get-AESBConnections =
78 78  
142 +Dieses Cmdlet gibt eine Liste aller existierenden SICS-Verbindungen aus. Dabei werden die zeigt die Detail-Informationen jeder Verbindung angezeigt.
143 +
144 +=== **Beispiele** ===
145 +
146 +Beispiel 1: Anzeigen aller existierenden SICS-Verbindungen.
147 +
148 +{{code language="powershell"}}
149 +Get-AESBConnections
150 +
151 +{{/code}}
152 +
153 +**Ausgabe**
154 +
155 +Die Ausgabe des Cmdlets würde beispielsweise folgendermaßen aussehen:
156 +
157 +{{code language="none" layout="LINENUMBERS"}}
158 +Endpoint : wss://localhost:3950
159 +Name : local
160 +Username : operator
161 +Description :
162 +IsDefaultConnection : False
163 +VirtualRouter : SHELL
164 +CallbackTargetName : Aagon.Shell.local.345b8cc1-57de-4dd9-9888-0add6738e9b7
165 +TargetRoutingKeys : ----
166 +ConnectionInfo : Aagon.Sis.Sics.Powershell.Libs.Types.ConnectionInfo
167 +IsOnline : False
168 +
169 +Endpoint : wss://localhost:3950
170 +Name : test
171 +Username : Operator
172 +Description :
173 +IsDefaultConnection : True
174 +VirtualRouter : SHELL
175 +CallbackTargetName : Aagon.Shell.test.345b8cc1-57de-4dd9-9888-0add6738e9b7
176 +TargetRoutingKeys : SHELL:SICS.Aagon.Shell.test.345b8cc1-57de-4dd9-9888-0add6738e9b7
177 +ConnectionInfo : Aagon.Sis.Sics.Powershell.Libs.Types.ConnectionInfo
178 +IsOnline : True
179 +{{/code}}
180 +
79 79  = Get-AESBMessageCount =
80 80  
183 +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.
184 +
185 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
186 +|-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.
187 +
188 +=== **Beispiele** ===
189 +
190 +Beispiel 1: Anzahl der Nachrichten für die spezifische SICS-Verbindung "MyConnection" anzeigen
191 +
192 +{{code language="powershell"}}
193 +Get-AESBMessageCount -ConnectionName "MyConnection"
194 +
195 +{{/code}}
196 +
197 +Beispiel 2: Anzahl der Nachrichten in der Standardverbindung "MyConnection" anzeigen
198 +
199 +{{code language="powershell"}}
200 +Get-AESBMessageCount
201 +{{/code}}
202 +
81 81  = Import-AESBPublicApiCommands =
82 82  
205 +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.
206 +
207 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
208 +|-ConnectionName|String|✅|Keine|Der Name der SICS-Verbindung, über welche die PublicAPI-Cmdlets importiert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
209 +
210 +=== **Beispiele** ===
211 +
212 +Beispiel 1: Importieren der PublicAPI-Cmdlets über die spezifische Verbindung "MyConnection"
213 +
214 +{{code language="powershell"}}
215 +Import-AESBPublicApiCommands -ConnectionName "MyConnection"
216 +
217 +{{/code}}
218 +
219 +Beispiel 2: Importieren der PublicAPI-Cmdlets über die Standardverbindung
220 +
221 +{{code language="powershell"}}
222 +Import-AESBPublicApiCommands
223 +{{/code}}
224 +
83 83  = New-AESBShell =
84 84  
227 +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.
228 +
229 +{{aagon.infobox}}
230 +Dieses Cmdlet ist nicht erforderlich, wenn die AESB Shell als eigene Anwendung gestartet wurde (z.B. über das Desktop-Icon).
231 +{{/aagon.infobox}}
232 +
233 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
234 +|-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.
235 +
236 +=== **Beispiele** ===
237 +
238 +Beispiel 1: Initialisieren der AESB Shell mit einem spezifischen Speicherort für Konfiguration und andere Elemente
239 +
240 +{{code language="powershell"}}
241 +New-AESBShell -ConfigurationPath "C:\Path\To\Save\Configs"
242 +
243 +{{/code}}
244 +
245 +Beispiel 2: Initialisieren der AESB Shell mit dem Standard-Speicherort
246 +
247 +{{code language="powershell"}}
248 +New-AESBShell
249 +{{/code}}
250 +
85 85  = Open-AESBConnection =
86 86  
253 +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.
254 +
255 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
256 +|-ConnectionName|String|✅|Keine|Der Name der Verbindung, die geöffnet werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
257 +|-AsDefaultConnection|-|✅|Keine|Die aktuelle Verbindung wird als Default für die Lebensdauer der Console gesetzt.
258 +
259 +=== **Beispiele** ===
260 +
261 +Beispiel 1: Öffnen der spezifischen SICS-Verbindung "MyConnection
262 +
263 +{{code language="powershell"}}
264 +Open-AESBConnection -ConnectionName "MyConnection"
265 +
266 +{{/code}}
267 +
268 +Beispiel 2: Öffnen der Standardverbindung
269 +
270 +{{code language="powershell"}}
271 +Open-AESBConnection
272 +{{/code}}
273 +
87 87  = Receive-AESBMessage =
88 88  
276 +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.
277 +
278 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
279 +|-ConnectionName|String|✅|Keine|Der Name der Verbindung, von der die Nachricht gelesen werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
280 +|-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.
281 +
282 +=== **Beispiele** ===
283 +
284 +Beispiel 1: Eine Nachricht von der spezifischen Verbindung "MyConnection" lesen und 5 Sekunden warten
285 +
286 +{{code language="powershell"}}
287 +Receive-AESBMessage -ConnectionName "MyConnection" -Wait 5s
288 +{{/code}}
289 +
290 +Beispiel 2: Eine Nachricht von der Standardverbindung lesen und 10 Sekunden warten
291 +
292 +{{code language="powershell"}}
293 +Receive-AESBMessage -Wait 10s
294 +{{/code}}
295 +
296 +
297 +Beispiel 3: Eine Nachricht von der Standardverbindung lesen und 1 Minute warten
298 +
299 +{{code language="powershell"}}
300 +Receive-AESBMessage -Wait 1min
301 +{{/code}}
302 +
303 +Beispiel 4: Eine Nachricht von der Standardverbindung lesen und 5 Stunden warten
304 +
305 +{{code language="powershell"}}
306 +Receive-AESBMessage -Wait 5h
307 +{{/code}}
308 +
309 +
89 89  = Receive-AESBMessages =
90 90  
91 91  = Remove-AESBConnection =
© Aagon GmbH 2025
Besuchen Sie unsere neue Aagon-Community