Wiki-Quellcode von Basis-Cmdlets

Version 7.2 von jklein am 2024/12/02 12:40
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 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 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
66 Dieses Cmdlet schließt alle offenen SICS-Verbindungen im Connection-Verzeichnis.
67
68 {{code language="powershell"}}
69 Close-AESBConnections
70
71 {{/code}}
72
73 = Edit-AESBConnection =
74
75 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.
76
77 |=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
78 |-ConnectionName|String|✅|Keine|Der Name der Verbindung, die bearbeitet werden soll.
79 |-Description|String|❌|Keine|Eine neue Beschreibung oder Notiz zur Verbindung.
80 |-Password|SecureString|❌|Keine|Das neue Passwort für die Verbindung.
81 |-Port|Int|❌|Keine|Der neue Port, über den die Verbindung hergestellt wird.Wertebereich ist 1 bis 65535.
82 |-Server|String|❌|Keine|Die neue IP-Adresse oder der DNS-Name des Zielservers.
83 |-Username|String|❌|Keine|Der neue Benutzername für die Authentifizierung.
84
85 === **Beispiele** ===
86
87 Beispiel 1: Vollständiges Bearbeiten der bestehenden SICS-Verbindung "MyConnection" mit der Möglichkeit zur Änderung allen Parameter
88
89 {{code language="powershell"}}
90 Edit-AESBConnection -ConnectionName "MyConnection" -Server "newserver.example.com" -Port 3960 -Username "newuser" -Password (ConvertTo-SecureString "newpassword" -AsPlainText -Force) -Description "Updated connection"
91
92 {{/code}}
93
94 Beispiel 2: Explizite Änderung der Serveradresse und des Ports der SICS-Verbindung "MyConnection"
95
96 {{code language="powershell"}}
97 Edit-AESBConnection -ConnectionName "MyConnection" -Server "another.server.com" -Port 8080
98
99 {{/code}}
100
101 = Get-AESBConnection =
102
103 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.
104
105 |=(% style="width: 170px;" %)Parameter |=(% style="width: 119px;" %)Datentyp|=(% style="width: 84px;" %)Optional|=(% style="width: 56px;" %)Alias|=(% style="width: 582px;" %)Beschreibung
106 |-ConnectionName|String|✅|Keine|Der Name der Verbindung, deren Details angezeigt werden sollen. Wenn nicht angegeben, wird die Standardverbindung angezeigt.
107
108 === (% id="cke_bm_25028S" style="display:none" %)** **(%%)**Beispiele** ===
109
110 Beispiel 1: Anzeigen von Detail-Informationen der spezifischen SICS-Verbindung "MyConnection"
111
112 {{code language="powershell"}}
113 Get-AESBConnection -ConnectionName "MyConnection"
114
115 {{/code}}
116
117 Beispiel 2: Anzeigen von Details der Standardverbindung
118
119 {{code language="powershell"}}
120 Get-AESBConnection
121
122 {{/code}}
123
124 **Ausgabe**
125
126 Die Ausgabe des Cmdlets würde beispielsweise für die SICS-Verbindung mit dem Namen "test" folgendermaßen aussehen:
127
128 {{code language="none" layout="LINENUMBERS"}}
129 Endpoint : wss://localhost:3950
130 Name : test
131 Username : Operator
132 Description :
133 IsDefaultConnection : True
134 VirtualRouter : SHELL
135 CallbackTargetName : Aagon.Shell.test.345b8cc1-57de-4dd9-9888-0add6738e9b7
136 TargetRoutingKeys : SHELL:SICS.Aagon.Shell.test.345b8cc1-57de-4dd9-9888-0add6738e9b7
137 ConnectionInfo : Aagon.Sis.Sics.Powershell.Libs.Types.ConnectionInfo
138 IsOnline : True
139 {{/code}}
140
141 = Get-AESBConnections =
142
143 Dieses Cmdlet gibt eine Liste aller existierenden SICS-Verbindungen aus. Dabei werden die zeigt die Detail-Informationen jeder Verbindung angezeigt.
144
145 === **Beispiele** ===
146
147 Beispiel 1: Anzeigen aller existierenden SICS-Verbindungen.
148
149 {{code language="powershell"}}
150 Get-AESBConnections
151
152 {{/code}}
153
154 **Ausgabe**
155
156 Die Ausgabe des Cmdlets würde beispielsweise folgendermaßen aussehen:
157
158 {{code language="none" layout="LINENUMBERS"}}
159 Endpoint : wss://localhost:3950
160 Name : local
161 Username : operator
162 Description :
163 IsDefaultConnection : False
164 VirtualRouter : SHELL
165 CallbackTargetName : Aagon.Shell.local.345b8cc1-57de-4dd9-9888-0add6738e9b7
166 TargetRoutingKeys : ----
167 ConnectionInfo : Aagon.Sis.Sics.Powershell.Libs.Types.ConnectionInfo
168 IsOnline : False
169
170 Endpoint : wss://localhost:3950
171 Name : test
172 Username : Operator
173 Description :
174 IsDefaultConnection : True
175 VirtualRouter : SHELL
176 CallbackTargetName : Aagon.Shell.test.345b8cc1-57de-4dd9-9888-0add6738e9b7
177 TargetRoutingKeys : SHELL:SICS.Aagon.Shell.test.345b8cc1-57de-4dd9-9888-0add6738e9b7
178 ConnectionInfo : Aagon.Sis.Sics.Powershell.Libs.Types.ConnectionInfo
179 IsOnline : True
180 {{/code}}
181
182 = Get-AESBMessageCount =
183
184
185
186
187
188
189
190
191
192
193
194 = Import-AESBPublicApiCommands =
195
196 = New-AESBShell =
197
198 = Open-AESBConnection =
199
200 = Receive-AESBMessage =
201
202 = Receive-AESBMessages =
203
204 = Remove-AESBConnection =
205
206 = Set-AESBDefaultConnection =
207
208 = Show-AESBInfrastructure =
© Aagon GmbH 2025
Besuchen Sie unsere neue Aagon-Community