Changes for page Basis Cmdlets

Last modified by jklein on 2025/09/03 07:20

From version 20.1
edited by jklein
on 2025/06/11 09:11
Change comment: There is no comment for this version
To version 23.1
edited by jklein
on 2025/08/06 12:20
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Basis-Cmdlets
1 +Basis Cmdlets
Content
... ... @@ -3,18 +3,22 @@
3 3  (% class="wikigeneratedid" %)
4 4  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.
5 5  
6 +{{aagon.infobox}}
7 +Falls bei der Ausführung eines Cmdlets mit ausschließlich optionalen Parametern keine Parameter angegeben werden, wird immer die Standardverbindung mit dem standardmäßigen Parameter-Set genutzt.
8 +{{/aagon.infobox}}
9 +
6 6  = Add-AESBConnection =
7 7  
8 8  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.
9 9  
10 10  (% style="width:1018px" %)
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 SICS-Verbindung.
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 -|(% 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 -|(% style="width:170px" %)-Username|(% style="width:119px" %)String|(% style="width:84px" %)|(% style="width:56px" %)Keine|(% style="width:582px" %)Der Benutzername für die Authentifizierung.
16 -|(% style="width:170px" %)-Password|(% style="width:119px" %)SecureString|(% style="width:84px" %)|(% style="width:56px" %)Keine|(% style="width:582px" %)Das Passwort für die Verbindung.
17 -|(% style="width:170px" %)-Description|(% style="width:119px" %)String|(% style="width:84px" %)|(% style="width:56px" %)Keine|(% style="width:582px" %)Eine Beschreibung oder Notiz zur Verbindung.
15 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Erforderlich|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
16 +|(% style="width:170px" %)-ConnectionName|(% style="width:119px" %)String|(% style="width:84px" %)|(% style="width:56px" %)Keine|(% style="width:582px" %)Der Name der SICS-Verbindung.
17 +|(% 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.
18 +|(% 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.
19 +|(% style="width:170px" %)-Username|(% style="width:119px" %)String|(% style="width:84px" %)|(% style="width:56px" %)Keine|(% style="width:582px" %)Der Benutzername für die Authentifizierung.
20 +|(% style="width:170px" %)-Password|(% style="width:119px" %)SecureString|(% style="width:84px" %)|(% style="width:56px" %)Keine|(% style="width:582px" %)Das Passwort für die Verbindung.
21 +|(% style="width:170px" %)-Description|(% style="width:119px" %)String|(% style="width:84px" %)|(% style="width:56px" %)Keine|(% style="width:582px" %)Eine Beschreibung oder Notiz zur Verbindung.
18 18  
19 19  === **Beispiele** ===
20 20  
... ... @@ -41,8 +41,8 @@
41 41  
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 -|=(% 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 SICS-Verbindung, die geschlossen werden soll. Wenn nicht angegeben, wird die Standardverbindung geschlossen.
48 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Erforderlich|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
49 +|-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  
... ... @@ -73,13 +73,13 @@
73 73  
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 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.
80 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Erforderlich|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
81 +|-ConnectionName|String||Keine|Der Name der SICS-Verbindung, die bearbeitet werden soll.
82 +|-Description|String||Keine|Eine neue Beschreibung oder Notiz zur Verbindung.
83 +|-Password|SecureString||Keine|Das neue Passwort für die Verbindung.
84 +|-Port|Int||Keine|Der neue Port, über den die Verbindung hergestellt wird.Wertebereich ist 1 bis 65535.
85 +|-Server|String||Keine|Die neue IP-Adresse oder der DNS-Name des Zielservers.
86 +|-Username|String||Keine|Der neue Benutzername für die Authentifizierung.
83 83  
84 84  === **Beispiele** ===
85 85  
... ... @@ -101,8 +101,8 @@
101 101  
102 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 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.
108 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Erforderlich|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
109 +|-ConnectionName|String||Keine|Der Name der SICS-Verbindung, deren Details angezeigt werden sollen. Wenn nicht angegeben, wird die Standardverbindung angezeigt.
106 106  
107 107  === (% id="cke_bm_25028S" style="display:none" %)** **(%%)**Beispiele** ===
108 108  
... ... @@ -182,8 +182,8 @@
182 182  
183 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 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.
189 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Erforderlich|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
190 +|-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 187  
188 188  === **Beispiele** ===
189 189  
... ... @@ -204,9 +204,9 @@
204 204  
205 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 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 -|-Prefix|String||Keine|Sofern ein Prefix angegeben wird, wird dies bei allen zu importierenden Cmdlets vor den eigentlichen Cmdlet-Namen hinzugefügt.
211 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Erforderlich|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
212 +|-ConnectionName|String||Keine|Der Name der SICS-Verbindung, über welche die PublicAPI-Cmdlets importiert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
213 +|-Prefix|String||Keine|Sofern ein Prefix angegeben wird, wird dies bei allen zu importierenden Cmdlets vor den eigentlichen Cmdlet-Namen hinzugefügt.
210 210  
211 211  === **Beispiele** ===
212 212  
... ... @@ -231,8 +231,8 @@
231 231  Dieses Cmdlet ist nicht erforderlich, wenn die AESB Shell als eigene Anwendung gestartet wurde (z.B. über das Desktop-Icon).
232 232  {{/aagon.infobox}}
233 233  
234 -|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
235 -|-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.
238 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Erforderlich|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
239 +|-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.
236 236  
237 237  === **Beispiele** ===
238 238  
... ... @@ -253,9 +253,9 @@
253 253  
254 254  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.
255 255  
256 -|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
257 -|-ConnectionName|String||Keine|Der Name der Verbindung, die geöffnet werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
258 -|-AsDefaultConnection|-||Keine|Die aktuelle Verbindung wird als Default für die Lebensdauer der Console gesetzt.
260 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Erforderlich|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
261 +|-ConnectionName|String||Keine|Der Name der Verbindung, die geöffnet werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
262 +|-AsDefaultConnection|-||Keine|Die aktuelle Verbindung wird als Default für die Lebensdauer der Console gesetzt.
259 259  
260 260  === **Beispiele** ===
261 261  
... ... @@ -276,9 +276,9 @@
276 276  
277 277  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.
278 278  
279 -|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
280 -|-ConnectionName|String||Keine|Der Name der Verbindung, von der die Nachricht gelesen werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
281 -|-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.
283 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Erforderlich|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
284 +|-ConnectionName|String||Keine|Der Name der Verbindung, von der die Nachricht gelesen werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
285 +|-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.
282 282  
283 283  === **Beispiele** ===
284 284  
... ... @@ -310,10 +310,10 @@
310 310  
311 311  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.
312 312  
313 -|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
314 -|-MessageCount|int||-|Die Anzahl der Nachrichten, die empfangen werden sollen. Wenn nicht angegeben, wird standardmäßig eine Nachricht empfangen.
315 -|-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.
316 -|-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.
317 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Erforderlich|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
318 +|-MessageCount|int||-|Die Anzahl der Nachrichten, die empfangen werden sollen. Wenn nicht angegeben, wird standardmäßig eine Nachricht empfangen.
319 +|-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.
320 +|-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.
317 317  
318 318  === (% id="cke_bm_167708S" style="display:none" %)** **(%%)Parameter-Sets ===
319 319  
... ... @@ -357,8 +357,8 @@
357 357  
358 358  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.
359 359  
360 -|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
361 -|-ConnectionName|String||Keine|Der Name der SICS-Verbindung, die aus dem Verzeichnis aller Verbindungen entfernt werden soll.
364 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Erforderlich|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
365 +|-ConnectionName|String||Keine|Der Name der SICS-Verbindung, die aus dem Verzeichnis aller Verbindungen entfernt werden soll.
362 362  
363 363  === **Beispiele** ===
364 364  
... ... @@ -372,8 +372,8 @@
372 372  
373 373  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.
374 374  
375 -|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
376 -|-ConnectionName|String||Keine|Der Name der SICS-Verbindung, die als neue Standardverbindung gesetzt werden soll.
379 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Erforderlich|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
380 +|-ConnectionName|String||Keine|Der Name der SICS-Verbindung, die als neue Standardverbindung gesetzt werden soll.
377 377  
378 378  === **Beispiele** ===
379 379  
... ... @@ -387,10 +387,10 @@
387 387  
388 388  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.
389 389  
390 -|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
391 -|-ConnectionName|string||None|Der Name der Verbindung, für die die Infrastruktur angezeigt wird.
392 -|-ExcludeVirtualRouters|string[]||None|Eine Liste von virtuellen Routern, die von der Anzeige ausgeschlossen werden sollen.
393 -|-IncludeVirtualRouters|string[]||None|Eine Liste von virtuellen Routern, die in die Anzeige eingeschlossen werden sollen.
394 +|=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Erforderlich|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
395 +|-ConnectionName|string||None|Der Name der Verbindung, für die die Infrastruktur angezeigt wird.
396 +|-ExcludeVirtualRouters|string[]||None|Eine Liste von virtuellen Routern, die von der Anzeige ausgeschlossen werden sollen.
397 +|-IncludeVirtualRouters|string[]||None|Eine Liste von virtuellen Routern, die in die Anzeige eingeschlossen werden sollen.
394 394  
395 395  === Parameter-Sets ===
396 396  
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community