Wiki-Quellcode von Basis-Cmdlets

Version 7.1 von jklein am 2024/11/28 15:17

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
	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.
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
	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
2.1	63	= Close-AESBConnections =
	64
6.1	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
2.1	73	= Edit-AESBConnection =
	74
7.1	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
2.1	101	= Get-AESBConnection =
	102
7.1	103
	104
2.1	105	= Get-AESBConnections =
	106
	107	= Get-AESBMessageCount =
	108
	109	= Import-AESBPublicApiCommands =
	110
	111	= New-AESBShell =
	112
	113	= Open-AESBConnection =
	114
	115	= Receive-AESBMessage =
	116
	117	= Receive-AESBMessages =
	118
	119	= Remove-AESBConnection =
	120
	121	= Set-AESBDefaultConnection =
	122
	123	= Show-AESBInfrastructure =