Wiki source code of Basis-Cmdlets

Version 8.1 by jklein on 2024/12/02 14:24

version	line-number	content
1.1	1	{{aagon.floatingbox/}}
2.1	2
6.1	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
3.1	6	= Add-AESBConnection =
2.1	7
6.1	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.
2.1	9
5.1	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
7.3	12	\|(% style="width:170px" %)-ConnectionName\|(% style="width:119px" %)String\|(% style="width:84px" %)❌\|(% style="width:56px" %)Keine\|(% style="width:582px" %)Der Name der SICS-Verbindung.
5.1	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.
2.1	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
6.1	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
7.3	45	\|-ConnectionName\|String\|✅\|Keine\|Der Name der SICS-Verbindung, die geschlossen werden soll. Wenn nicht angegeben, wird die Standardverbindung geschlossen.
6.1	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
2.1	63	= Close-AESBConnections =
	64
6.1	65	Dieses Cmdlet schließt alle offenen SICS-Verbindungen im Connection-Verzeichnis.
	66
	67	{{code language="powershell"}}
	68	Close-AESBConnections
	69
	70	{{/code}}
	71
2.1	72	= Edit-AESBConnection =
	73
7.1	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
7.3	77	\|-ConnectionName\|String\|✅\|Keine\|Der Name der SICS-Verbindung, die bearbeitet werden soll.
7.1	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
7.3	86	Beispiel 1: Vollständiges Bearbeiten der bestehenden SICS-Verbindung "MyConnection" mit der Möglichkeit zur Änderung aller Parameter
7.1	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
2.1	100	= Get-AESBConnection =
	101
7.2	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.
7.1	103
7.2	104	\|=(% style="width: 170px;" %)Parameter \|=(% style="width: 119px;" %)Datentyp\|=(% style="width: 84px;" %)Optional\|=(% style="width: 56px;" %)Alias\|=(% style="width: 582px;" %)Beschreibung
7.3	105	\|-ConnectionName\|String\|✅\|Keine\|Der Name der SICS-Verbindung, deren Details angezeigt werden sollen. Wenn nicht angegeben, wird die Standardverbindung angezeigt.
7.1	106
7.2	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
2.1	140	= Get-AESBConnections =
	141
7.2	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
2.1	181	= Get-AESBMessageCount =
	182
7.3	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.
7.2	184
7.3	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.
7.2	187
7.3	188	=== Beispiele ===
7.2	189
7.3	190	Beispiel 1: Anzahl der Nachrichten für die spezifische SICS-Verbindung "MyConnection" anzeigen
7.2	191
7.3	192	{{code language="powershell"}}
	193	Get-AESBMessageCount -ConnectionName "MyConnection"
7.2	194
7.3	195	{{/code}}
7.2	196
7.3	197	Beispiel 2: Anzahl der Nachrichten in der Standardverbindung "MyConnection" anzeigen
7.2	198
7.3	199	{{code language="powershell"}}
	200	Get-AESBMessageCount
	201	{{/code}}
7.2	202
7.3	203	= Import-AESBPublicApiCommands =
7.2	204
7.3	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.
7.2	206
7.3	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.
2.1	209
7.3	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
2.1	225	= New-AESBShell =
	226
7.4	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
2.1	251	= Open-AESBConnection =
	252
7.4	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
2.1	274	= Receive-AESBMessage =
	275
7.4	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
8.1	282	=== Beispiele ===
7.4	283
8.1	284	Beispiel 1: Eine Nachricht von der spezifischen Verbindung "MyConnection" lesen und 5 Sekunden warten
7.4	285
8.1	286	{{code language="powershell"}}
	287	Receive-AESBMessage -ConnectionName "MyConnection" -Wait 5s
	288	{{/code}}
7.4	289
8.1	290	Beispiel 2: Eine Nachricht von der Standardverbindung lesen und 10 Sekunden warten
7.4	291
8.1	292	{{code language="powershell"}}
	293	Receive-AESBMessage -Wait 10s
	294	{{/code}}
7.4	295
	296
8.1	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
2.1	310	= Receive-AESBMessages =
	311
	312	= Remove-AESBConnection =
	313
	314	= Set-AESBDefaultConnection =
	315
	316	= Show-AESBInfrastructure =