Wiki-Quellcode von Basis-Cmdlets

Version 7.3 von jklein am 2024/12/02 13:18
Zeige letzte Bearbeiter
1 {{aagon.floatingbox/}}
2
3 (% class="wikigeneratedid" %)
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
6 = Add-AESBConnection =
7
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
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.
18
19 === **Beispiele** ===
20
21 Beispiel 1: Hinzufügen einer Verbindung mit Standardport 3950
22
23 {{code language="powershell"}}
24 Add-AESBConnection -ConnectionName "MyConnection" -Server "server.example.com" -Port 3950 -Username "user" -Password (ConvertTo-SecureString "password" -AsPlainText -Force)
25
26 {{/code}}
27
28 Beispiel 2: Hinzufügen einer Verbindung// //zu einem Server über den Port 8080 mit benutzerdefiniertem Port und Beschreibung
29
30 {{code language="powershell"}}
31 Add-AESBConnection -ConnectionName "MyConnection" -Server "192.168.1.1" -Port 8080 -Username "user" -Password (ConvertTo-SecureString "password" -AsPlainText -Force) -Description "Test connection"
32 {{/code}}
33
34 Beispiel 3: Hinzufügen einer Verbindung mit Nutzung der interaktiven Eingabe
35
36 {{code language="powershell"}}
37 Add-AESBConnection
38 {{/code}}
39
40 = Close-AESBConnection =
41
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
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.
46
47 === **Beispiele** ===
48
49 Beispiel 1: Schließen der spezifischen Verbindung "MyConnection"
50
51 {{code language="powershell"}}
52 Close-AESBConnection -ConnectionName "MyConnection"
53
54 {{/code}}
55
56 Beispiel 2: Schließen der Standardverbindung, //da //kein //-ConnectionName//-Parameter angegeben ist.
57
58 {{code language="powershell"}}
59 Close-AESBConnection
60
61 {{/code}}
62
63 = Close-AESBConnections =
64
65 Dieses Cmdlet schließt alle offenen SICS-Verbindungen im Connection-Verzeichnis.
66
67 {{code language="powershell"}}
68 Close-AESBConnections
69
70 {{/code}}
71
72 = Edit-AESBConnection =
73
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
100 = Get-AESBConnection =
101
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
140 = Get-AESBConnections =
141
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
181 = Get-AESBMessageCount =
182
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
203 = Import-AESBPublicApiCommands =
204
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
225 = New-AESBShell =
226
227 = Open-AESBConnection =
228
229 = Receive-AESBMessage =
230
231 = Receive-AESBMessages =
232
233 = Remove-AESBConnection =
234
235 = Set-AESBDefaultConnection =
236
237 = Show-AESBInfrastructure =
© Aagon GmbH 2025
Besuchen Sie unsere neue Aagon-Community