Changes for page Operative Cmdlets

Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Parent

...	...	@@ -1,1 +1,1 @@
1		-AESB.111.AESB Shell.Cmdlet-Dokumentation.WebHome
	1	+AESB.110.AESB Shell.Cmdlet-Dokumentation.WebHome

Content

...	...	@@ -3,10 +3,6 @@
3	3	(% class="wikigeneratedid" %)
4	4	Bei den operativen Cmdlets handelt es sich um Shell-Befehle, die für die Steuerung und das weiterführende Arbeiten in AESB verwendet werden können.
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		-
10	10	= Add-AESBAlias =
11	11
12	12	Mit diesem Cmdlet wird ein neuer Alias für eine SICS-Verbindung im Qualified Name Service (QNS) hinzugefügt. Wenn der Parameter //-ConnectionName// nicht angegeben wird, wird der Alias für die Standardverbindung hinzugefügt.
...	...	@@ -258,7 +258,7 @@
258	258	ConnectionName : MyConnection
259	259	{{/code}}
260	260
261		-Beispiel 2: Kodieren eines PSCustomObjects in eine Icql-Zeichenfolge und anschließendes Dekodieren zurück in ein PSCustomObject. Die resultierenden Daten entsprechen den ursprünglichen Eingabewerten
	257	+Beispiel 2: Kodieren eines PSCustomObjects in eine Icql-Zeichenfolge und anschließendes dekodieren zurück in ein PSCustomObject. Die resultierenden Daten entsprechen den ursprünglichen Eingabewerten
262	262
263	263	{{code language="powershell" layout="LINENUMBERS"}}
264	264	# Erstellen eines PSCustomObject mit Beispieldaten
...	...	@@ -334,8 +334,6 @@
334	334
335	335	|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
336	336	|-InputObject|psobject|❌|InObj|Das PSCustomObject, das in eine AESB Icql-Zeichenfolge konvertiert werden soll.
337		-|-Sequence|string|✅| |Setzt die Sequence einer ICQL Message
338		-|-Action|string|✅| |Setzt die Action einer ICQL Message
339	339
340	340	=== **Beispiele** ===
341	341
...	...	@@ -356,6 +356,23 @@
356	356	$icqlString
357	357	{{/code}}
358	358
	353	+Beispiel 2: Konvertiert das PSCustomObject, das in der Variable $exampleObject gespeichert ist, in eine AESB Icql-Zeichenfolge und gibt die resultierende Icql-Zeichenfolge in der Variable $icqlString zurück.
	354	+
	355	+{{code language="powershell" layout="LINENUMBERS"}}
	356	+# Erstellen eines PSCustomObject mit Beispieldaten
	357	+$exampleObject = [PSCustomObject]@{
	358	+ TargetName = "MyTarget"
	359	+ TargetType = "Queue"
	360	+ RoutingKey = "MyRoutingKey"
	361	+ VirtualRouter = "MyRouter"
	362	+ ConnectionName = "MyConnection"
	363	+}
	364	+
	365	+# Konvertieren des Objekts in eine Icql-Zeichenfolge
	366	+$icqlString = ConvertTo-AESBIcql -InputObject $exampleObject
	367	+$icqlString
	368	+{{/code}}
	369	+
359	359	= Get-AESBActivityLogItemById =
360	360
361	361	Gibt den Activity Log-Eintrag anhand einer ID zurück.
...	...	@@ -656,10 +656,10 @@
656	656	Mit diesem Cmdlet können Sie einen Routing Key von einem bestimmten Ziel in einem Virtual Router im AESB entfernen. Der Routing Key wird aus der Konfiguration entfernt, die mit dem angegebenen Ziel und Virtual Router verknüpft ist.
657	657
658	658	|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
659		-|-ConnectionName|string|✅|C|Der Name der Verbindung, die verwendet werden soll.
660		-|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, von dem der Routing Key entfernt werden soll.
661		-|-TargetName|string|❌|TName|Der Name des Ziels, von dem der Routing Key entfernt werden soll.
662		-|-RoutingKey|string|❌|RK|Der Routing Key, der entfernt werden soll.
	670	+|ConnectionName|string|✅|C|Der Name der Verbindung, die verwendet werden soll.
	671	+|VirtualRouter|string|❌|VR|Der Name des Virtual Routers, von dem der Routing Key entfernt werden soll.
	672	+|TargetName|string|❌|TName|Der Name des Ziels, von dem der Routing Key entfernt werden soll.
	673	+|RoutingKey|string|❌|RK|Der Routing Key, der entfernt werden soll.
663	663
664	664	=== **Beispiele** ===
665	665
...	...	@@ -679,166 +679,14 @@
679	679
680	680	= Remove-AESBTarget =
681	681
682		-Mit diesem Cmdlet können Sie ein Ziel aus dem Virtual Router des AESB entfernen.
683	683
684		-|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
685		-|-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
686		-|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, von dem das Ziel entfernt werden soll.
687		-|-TargetName|string|❌|TName|Der Name des Ziels, das entfernt werden soll.
688	688
689		-=== **Beispiele** ===
690		-
691		-Beispiel 1: Entfernen vom Ziel "MyTarget" vom Virtual Router "MyRouter"
692		-
693		-{{code language="powershell"}}
694		-Remove-AESBTarget -VirtualRouter "MyRouter" -TargetName "MyTarget"
695		-{{/code}}
696		-
697		-Beispiel 2: Entfernen vom Ziel "MyTarget" vom Virtual Router "MyRouter" unter Verwendung der Verbindung "MyConnection"
698		-
699		-{{code language="powershell"}}
700		-Remove-AESBTarget -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -TargetName "MyTarget"
701		-{{/code}}
702		-
703	703	= Remove-AESBVirtualRouter =
704	704
705		-Mit diesem Cmdlet können Sie einen angegebenen Virtual Router entfernen.
706		-
707		-|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
708		-|ConnectionName|string|✅|C|Gibt den Namen der Verbindung an.
709		-|VirtualRouter|string|❌|VR|Gibt den Namen des zu entfernenden Virtual Router an.
710		-
711		-=== **Beispiele** ===
712		-
713		-Beispiel 1: Entfernen vom Virtual Router mit dem Namen "MyRouter"
714		-
715		-{{code language="powershell"}}
716		-Remove-AESBVirtualRouter -VirtualRouter "MyRouter"
717		-
718		-{{/code}}
719		-
720		-Beispiel 2: Entfernen vom Virtual Router mit dem Namen "MyRouter" unter der Verbindung "MyConnection"
721		-
722		-{{code language="powershell"}}
723		-Remove-AESBVirtualRouter -ConnectionName "MyConnection" -VirtualRouter "MyRouter"
724		-{{/code}}
725		-
726	726	= Set-AESBBSelfAsAlias =
727	727
728		-Bei diesem Cmdlet wird ein existierender Alias verwendet, um einen neuen Alias hinzuzufügen. Durch Verwendung des bereits existierenden Alias, müssen so nicht der Routing Key und Virtual Router verwendet werden.
729		-
730		-{{aagon.warnungsbox}}
731		-Die Parameter RemoveExistingAlias und AddToExistingAlias dürfen nicht gleichzeitig verwendet werden!
732		-{{/aagon.warnungsbox}}
733		-
734		-**Parameter**
735		-
736		-|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
737		-|-Alias|string|❌| |Gibt den Namen vom Alias an
738		-|-RemoveExistingAlias|bool|✅| |Der bestehende Alias wird ersetzt.
739		-|-AddToExistingAlias|bool|✅| |Der Virtual Router und Routing Key wird zu dem angegebenen Alias hinzugefügt
740		-
741		-=== **Beispiele** ===
742		-
743		-Beispiel 1: Überschreiben vom existierenden Alias „AliasName“. Wenn z.B. der vorherige Alias mehrere Virtual Router und Routing Keys hatte, werden diese gelöscht
744		-
745		-{{code language="powershell"}}
746		-Set-AESBSelfAsAlias -Alias "AliasName" -RemoveExistingAlias $true
747		-
748		-{{/code}}
749		-
750		-Beispiel 2: Hinzufügen der Virtual Router und Routing Keys vom Alias „AliasName“ zum angegebenen Alias "SelfAliasTest".
751		-
752		-{{code language="powershell"}}
753		-Set-AESBSelfAsAlias -Alias "AliasName" -AddToExistingAlias "SelfAliasTest"
754		-{{/code}}
755		-
756	756	= Show-AESBRoutingTable =
757	757
758		-Dieses Cmdlet zeigt die Routing-Tabelle für den angegebenen Virtual Router an. Mit den Parametern ist es möglich, die angezeigten Daten weiter einzuschränken.
759		-
760		-**Parameter**
761		-
762		-|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
763		-|-ConnectionName|string|✅|C|Der Name der Verbindung, die für das Abrufen der Routing-Tabelle verwendet wird.
764		-|-ExchangeType|ExchangeTypes|✅|ET|Der Typ des Exchanges, der angezeigt werden soll. Mögliche Werte sind DIRECT oder ROUTING.
765		-|-VirtualRouter|string|❌|VR|Der Name des Virtual Routers, für den die Routing-Tabelle angezeigt wird.
766		-
767		-=== **Beispiele** ===
768		-
769		-Beispiel 1: Anzeigen der Routing-Tabelle für den Virtual Router „MyRouter“
770		-
771		-{{code language="powershell"}}
772		-Show-AESBRoutingTable -VirtualRouter "MyRouter"
773		-
774		-{{/code}}
775		-
776		-Beispiel 2: Anzeigen der Routing-Tabelle für den Virtual Router „MyRouter“ an, wobei nur Einträge vom Typ „DIRECT“ angezeigt werden. Die Verbindung „MyConnection“ wird verwendet.
777		-
778		-{{code language="powershell"}}
779		-Show-AESBRoutingTable -ConnectionName "MyConnection" -VirtualRouter "MyRouter" -ExchangeType DIRECT
780		-
781		-{{/code}}
782		-
783	783	= Write-AESBActivityLog =
784	784
785		-Mit diesem Cmdlet wird ein Eintrag in das ActivityLog des AESB geschrieben. Wenn keine ID angegeben wird, wird ein neuer Log-Eintrag erstellt. Falls eine ID angegeben wird, wird der vorhandene Log-Eintrag mit dieser ID aktualisiert.
786		-
787		-**Parameter**
788		-
789		-|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
790		-|-ConnectionName|string|✅|C|Der Name der Verbindung, die für die Kommunikation verwendet wird.
791		-|-Id|string|✅|None|Die ID des Log-Eintrags, der aktualisiert werden soll. Wird ein neuer Eintrag erstellt, kann dieser Parameter weggelassen werden.
792		-|-Name|string|❌|N|Der Name des Log-Eintrags.
793		-|-Description|string|❌|D|Die Beschreibung des Log-Eintrags.
794		-|-Status|JobFeedbackResultCode|❌|ST|Der Status des Logs, z.B. "Warning", "Created", "Started", "Running", "Stopping", "Stopped", "Failed" oder "Finished".
795		-|-ComponentName|string|✅|ComName|Der Name der Komponente, die den Log-Eintrag erstellt hat.
796		-
797		-=== **Beispiele** ===
798		-
799		-Beispiel 1: Erstellen eines neuen Log-Eintrags. Der Eintrag erhält den Namen "ProcessStart", die Beschreibung "Der Prozess wurde gestartet" und den Status "Started". Da keine ID angegeben ist, wird ein neuer Log-Eintrag erstellt.
800		-
801		-{{code language="powershell"}}
802		-Write-AESBActivityLog -Name "ProcessStart" -Description "Der Prozess wurde gestartet." -Status Started
803		-{{/code}}
804		-
805		-Beispiel 2: Aktualisieren eines vorhandenen Log-Eintrags mit der ID "12345". Der Log-Eintrag wird auf den Namen "ProcessUpdate", die Beschreibung "Der Prozessstatus wurde aktualisiert" und den Status "Running" gesetzt. Die ID wird verwendet, um den spezifischen Eintrag zu finden und zu aktualisieren.
806		-
807		-{{code language="powershell"}}
808		-Write-AESBActivityLog -Id "12345" -Name "ProcessUpdate" -Description "Der Prozessstatus wurde aktualisiert." -Status Running
809		-
810		-{{/code}}
811		-
812	812	= Write-AESBBusinessLog =
813		-
814		-Mit diesem Cmdlet wird eine Nachricht in das Business-Log des AESB geschrieben. Jeder Aufruf des Cmdlets erzeugt immer einen neuen Log-Eintrag
815		-
816		-**Parameter**
817		-
818		-|=(% style="width: 199px;" %)Parameter |=(% style="width: 160px;" %)Datentyp|=(% style="width: 119px;" %)Optional|=(% style="width: 168px;" %)Alias|=(% style="width: 827px;" %)Beschreibung
819		-|-ConnectionName|string|✅|C|Der Name der Verbindung zum AESB.
820		-|-IsError|bool|✅|IsErr|Gibt an, ob die Nachricht als Fehler protokolliert wird.
821		-|-Message|string|❌|M|Die zu protokollierende Nachricht.
822		-|-ComponentId|string|✅|CId|Die ID des Komponenten.
823		-|-ComponentName|string|✅|ComName|Der Name des Komponenten.
824		-|-ComponentPart|string|✅|ComPart|Der Teil des Komponenten.
825		-|-HostId|string|✅|HId|Die ID des Hosts.
826		-|-HostName|string|✅|HN|Der Name des Hosts.
827		-|-Context|string|✅|CT|Der Kontext der Nachricht.
828		-
829		-=== **Beispiele** ===
830		-
831		-Beispiel 1: Erstellen eines neuen Log-Eintrags im Business-Log mit der Nachricht "System started successfully". Der Log-Eintrag wird dem Komponenten-Namen "MyComponent" und dem Kontext "Initialization" zugeordnet.
832		-
833		-{{code language="powershell"}}
834		-Write-AESBBusinessLog -Message "System started successfully" -ComponentName "MyComponent" -Context "Initialization"
835		-
836		-{{/code}}
837		-
838		-Beispiel 2: Erstellen eines neuen Log-Eintrag im Business-Log, der als Fehler gekennzeichnet ist. Die Nachricht "Error connecting to database" wird dem Komponenten-ID "DBComponent" und dem Host-Namen "Server01" zugeordnet.
839		-
840		-{{code language="powershell"}}
841		-Write-AESBBusinessLog -IsError $true -Message "Error connecting to database" -ComponentId "DBComponent" -HostName "Server01"
842		-{{/code}}
843		-
844		-