Microservice Cmdlets

Dieses Beispiel fügt eine neue Instanz mithilfe der Template-Id hinzu und setzt den //StartupType// auf //Manuell//. Die Standardverbindung wird verwendet.

45

46

Beispiel 4: Microservice mit SupervisorId setzen

47

48

49

Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff"

Dieses Beispiel fügt eine neue Instanz einen bestimmten Supervisor hinzu, der über die Supervisor-Id angegeben wird. Die Standardverbindung wird verwendet.

54

55

Beispiel 5: Microservice mit StoppedAfterCreation setze

56

57

58

Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StoppedAfterCreation false

Dieses Beispiel fügt eine neue Instanz hinzu und setzt den Wert von //StoppedAfterCreation// auf //false,// womit der Start nach dem Hinzufügen des Microservices verhindert wird. Die Standardverbindung wird verwendet.

63

64

Beispiel 6: Microservice mit vielen Parametern

65

66

67

Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StartupType Manual -StoppedAfterCreation false

68

69

70

Dieses Beispiel fügt eine neue Instanz zu einem angegebenen Supervisor hinzu, setzt den //StartupType// auf //Manuell und //den Wert von //StoppedAfterCreation// auf //false//. Die Standardverbindung wird verwendet

71

72

(% style="color:inherit; font-family:inherit; font-size:25px; font-weight:bold" %)**Get-AESBMicroservice**

73

74

Mit diesem Cmdlet erhalten Sie eine Liste mit allen installierten und registrierten Microservices des AESB. In dieser Liste finden Sie detaillierte Informationen zu jedem Microservice, einschließlich seines Namens, des zugehörigen Pakets, der Version, des aktuellen Zustands und der Ressourcennutzung.

75

Diese Informationen sind nützlich für die Überwachung, Fehlerbehebung und Verwaltung der Microservice-Infrastruktur.

76

77

Mit den optionalen Parametern können Sie die Ausgabe filtern und spezifische Microservices oder Instanzen abrufen.

|-InstanceNames|String[]|✅❌| |Gibt die Namen der Microservice-Instanzen an, die abgerufen werden sollen. Du kannst einen oder mehrere Instanznamen als String-Array übergeben.

82

|-SupervisorIds|String[]|✅❌| |Filtert Microservices basierend auf den IDs ihrer übergeordneten Supervisoren. Du musst eine oder mehrere Supervisor-IDs als String-Array übergeben.

83

|-ShowAllInstances|SwitchParameter|✅| |Wenn dieser Parameter angegeben wird, zeigt das Cmdlet alle Instanzen von Microservices an, einschließlich derer, die normalerweise ausgeblendet oder als inaktiv betrachtet werden könnten.

84

85

=== Parameter-Sets ===

86

87

Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:

88

89

* **InstanceNamesParameterSetName**: Ermöglicht das Abrufen von Microservices, basierend auf ihren Instanznamen.

90

* **SupervisorsParameterSetName**: Ermöglicht das Abrufen von Microservices, die bestimmten Supervisor-IDs zugeordnet sind.

91

* **NotRequiredParameterSetName**: Dient hauptsächlich dazu, die ShowAllInstances-Option zu ermöglichen.

92

93

Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.

94

95

=== **Beispiele** ===

96

97

Beispiel 1: Alle Microservices auflisten

98

99

100

Get-AESBMicroservices

101

102

103

Dieser Befehl ruft alle registrierten AESB Microservices ab und zeigt deren detaillierte Informationen an. Ohne explizite Parameterauswahl fällt dies in das //NotRequiredParameterSetName//.

104

105

Beispiel 2: Einen spezifischen Microservice nach Namen abrufen

106

107

108

Get-AESBMicroservices -InstanceNames "TestMicroservice"

Dieser Befehl ruft Informationen nur für die Microservice-Instanz mit dem Namen "TestMicroservice" ab. Hier wird das //InstanceNamesParameterSetName// verwendet.

113

114

Beispiel 3: Mehrere Microservices nach Namen abrufen

115

116

117

Get-AESBMicroservices -InstanceNames "TestMicroservice1", "TestMicroservice2"

Dieser Befehl ruft Informationen für die Microservice-Instanzen "TestMicroservice1" und "TestMicroservice2" ab, ebenfalls unter Verwendung des //InstanceNamesParameterSetName.//

122

123

Beispiel 4: Alle Microservices inklusive inaktiver Instanzen anzeigen

124

125

126

Get-AESBMicroservices -ShowAllInstances

127

128

129

Dieser Befehl zeigt alle Microservice-Instanzen an, auch diejenigen, die normalerweise ausgeblendet würden. Dies nutzt das //NotRequiredParameterSetName//.

130

131

Beispiel 5: Microservices nach Supervisor-ID Filtern (GUID

132

133

134

Get-AESBMicroservices -SupervisorIds "ffffffff-ffff-ffff-ffff-ffffffffffff"

=== **Rückgabewerte** ===

139

140

Das Cmdlet gibt eine Sammlung von Objekten zurück, die jeweils die folgenden Eigenschaften für einen Microservice enthalten:

141

142

* **Name**: Der eindeutige Name der Microservice-Instanz.

143

* **Package**: Der Name des Pakets, zu dem der Microservice gehört.

144

* **PackageVersion**: Die Version des zugehörigen Pakets.

145

* **TemplateName**: Der Name der Vorlage, die zum Erstellen dieser Microservice-Instanz verwendet wurde.

146

* **InstanceId**: Eine eindeutige ID der Microservice-Instanz (GUID).

147

* **Routing**: Informationen zum Routing des Microservices (in der Regel ein leeres Array, wenn keine spezifischen Routing-Regeln konfiguriert sind).

148

* **IndividualSicsCredentials**: Zeigt an, ob der Microservice individuelle SICS-Anmeldeinformationen verwendet (True/False).

149

* **LoggingEnabled**: Zeigt an, ob die Protokollierung für den Microservice aktiviert ist (True/False).

150

* **StartupType**: Der Starttyp des Microservices (z.B. Manuell oder Automatisch).

151

* **Scheduling**: Informationen zur Zeitplanung des Microservices (z.B. NotAvailable, wenn keine Zeitplanung konfiguriert ist).

152

* **ServiceState**: Der aktuelle Zustand des Microservices (z.B. Stopped, Running).

153

* **ProcessId**: Die Prozess-ID des Microservices, wenn er ausgeführt wird.

154

* **SicsUsername**: Der SICS-Benutzername, der vom Microservice verwendet wird.

155

* **CpuUsage**: Die aktuelle CPU-Auslastung des Microservices in Prozent.

156

* **MemoryUsage**: Die aktuelle Speicherauslastung des Microservices in Bytes.

157

158

== Edit-AESBMicroservices ==

159

160

Dieses Cmdlet ermöglicht die Bearbeitung der Konfiguration eines spezifischen Microservice. Derzeit unterstützt es die Änderung des Starttyps (StartupType) und optional die Konfiguration von Anmeldeinformationen (Credentials) für den Microservice. Dies ist besonders nützlich, um das Startverhalten von Microservices zu steuern oder SICS-Anmeldeinformationen zu aktualisieren.

161

162

163

|-ConnectionName| |String|✅|Der Name der Verbindung, über die Microservice-Instanzen bearbeitet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.

164

|-InstanceName|NoCredentialParameterSetName,

165

CredentialParameterSetName|String|❌|Gibt den eindeutigen Namen der Microservice-Instanz an, deren Konfiguration geändert werden soll. Dieser Parameter ist in beiden Parametersets obligatorisch.

166

|-UseCredentials|CredentialParameterSetName|SwitchParameter|✅❌|Gibt an, dass Anmeldeinformationen für den Microservice konfiguriert werden sollen. Dieser Parameter gehört zum CredentialParameterSetName und ist obligatorisch, wenn dieses Set verwendet wird.

167

|-UserName|CredentialParameterSetName|String|✅❌|Gibt den Benutzernamen an, der verwendet werden soll, wenn UseCredentials aktiviert ist. Dieser Parameter gehört zum CredentialParameterSetName und ist obligatorisch, wenn dieses Set verwendet wird.

168

|-Password|CredentialParameterSetName|SecureString|✅❌|Gibt das Passwort für den angegebenen Benutzernamen an. Das Passwort muss als SecureString-Objekt übergeben werden. Dieser Parameter gehört zum CredentialParameterSetName und ist obligatorisch, wenn dieses Set verwendet wird.

169

|-StartupType|NoCredentialParameterSetName,

170

CredentialParameterSetName|Enum|❌|Legt fest, wie der Microservice beim Systemstart verhalten soll. Dies ist ein Enum-Wert vom Typ InstanceStartType. Gängige Werte sind Automatic (startet automatisch mit dem System) und Manual (muss manuell gestartet werden).

171

172

=== Parameter-Sets ===

173

174

Das Cmdlet verwendet Parameter-Sets, um zwei Hauptszenarien zu unterstützen:

175

176

* **NoCredentialParameterSetName**: Ermöglicht die Bearbeitung des Starttyps ohne die Angabe von Anmeldeinformationen.

177

* **CredentialParameterSetName**: Ermöglicht die Bearbeitung des Starttyps //und// die Konfiguration von Anmeldeinformationen für den Microservice.

178

179

Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.

=== Beispiele ===

Beispiel 1: Starttyp eines Microservice auf "Automatisch" ändern

184

185

186

Edit-AESBMicroservice -InstanceName "TestMicroservice1" -StartupType Automatic

Dieser Befehl ändert den Starttyp des Microservice mit dem Namen "TestMicroservice" auf "Automatisch". Hier wird das //NoCredentialParameterSetName// verwendet.

191

192

Beispiel 2: Starttyp ändern und individuelle Anmeldeinformationen festlegen

193

194

195

$password = ConvertTo-SecureString "YourSecurePassword" -AsPlainText -Force

196

Edit-AESBMicroservice -InstanceName "TestMicroservice" -UseCredentials -Username "MySicsUser" -Password $password -StartupType Automatic

197

198

199

Dieser Befehl ändert den Starttyp des Microservice "TestMicroservice" auf "Automatisch" und konfiguriert individuelle SICS-Anmeldeinformationen mit dem angegebenen Benutzernamen und Passwort. Hier wird das //CredentialParameterSetName// verwendet.

200

201

== Kill-AESBMicroservices ==

202

203

Mit diesem Cmdlet können Sie laufende Microservices gezielt beenden. Dies ist nützlich für die Wartung, Fehlerbehebung oder das Herunterfahren bestimmter Microservice-Instanzen. Das Cmdlet bietet zwei Methoden zum Ansprechen der zu beendenden Microservices: entweder direkt über deren Instanz-IDs oder indirekt über die ID ihres Supervisoren, wodurch alle zugehörigen Microservices beendet werden.

204

205

206

|-ConnectionName| |String|✅|Der Name der Verbindung, über welche die Ausführung von Microservice-Instanzen abgebrochen werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.

207

208

|-SupervisorId|UseSupervisorIdParameterSet|String|✅❌|Der **SupervisorId**-Parameter gibt die eindeutige ID (GUID als String) des Supervisors an. Alle Microservices, die von diesem spezifischen Supervisor verwaltet werden, werden beendet.

209

210

=== Parameter-Sets ===

211

212

Das Cmdlet verwendet Parameter-Sets, um diese beiden Betriebsmodi zu unterscheiden:

213

214

* **UseMicroservicesIdListParameterSet**: Ermöglicht das Ansprechen von Microservices über eine Liste ihrer eindeutigen Instanz-IDs.

215

* **UseSupervisorIdParameterSet**: Ermöglicht das Ansprechen von Microservices durch Angabe der ID ihres Supervisoren. Alle Microservices, die diesem Supervisor zugeordnet sind, werden beendet.

216

217

Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.

=== Beispiele ===

Beispiel 1: Einen spezifischen Microservice mit seiner Instanz-ID beenden

222

223

224

Kill-AESBMicroservices -InstanceIds "ffffffff-ffff-ffff-ffff-ffffffffffff"

Dieser Befehl versucht, den Microservice mit der angegebenen Instanz-ID zu beenden. Die Beispielausgabe zeigt, dass der Microservice bereits gestoppt war. Hier wird das //UseMicroservicesIdListParameterSet// verwendet.

229

230

Beispiel 2: Mehrere Microservices mit ihren Instanz-IDs beenden

231

232

233

Kill-AESBMicroservices -InstanceIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2"

Dieser Befehl versucht, die Microservices mit den angegebenen Instanz-IDs zu beenden.

238

239

Beispiel 3: Alle Microservices beenden, die einem bestimmten Supervisor zugeordnet sin

240

241

242

Kill-AESBMicroservices -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff"

243

244

245

Dieser Befehl beendet alle Microservices, die dem Supervisor mit der angegebenen ID zugeordnet sind. Hier wird das //UseSupervisorIdParameterSet// verwendet.

246

247

=== Rückgabewerte ===

248

249

Das Cmdlet gibt eine Sammlung von Objekten zurück, die den Status der Beendigung für jeden angesprochenen Microservice anzeigen. Die Ausgabe im Beispiel zeigt folgende Eigenschaften:

250

251

* **Status**: Der Status der Beendigungsoperation (z.B. //Unchanged// wenn bereits gestoppt, //Stopped// wenn erfolgreich beendet).

252

* **InstanceId**: Die eindeutige ID der betroffenen Microservice-Instanz.

253

* **InstanceState**: Der Zustand des Microservice nach der Operation (z.B. Already stopped).

254

* **Error**: Eine Fehlermeldung, falls die Operation nicht erfolgreich war oder ein Problem aufgetreten ist.

255

256

== Move-AESBMicroservices ==

257

258

Mit diesem Cmdlet können Sie eine oder mehrere Microservice-Instanzen auf einen anderen Supervisor verschieben. Es unterstützt optionale Parameter für Timeout und asynchrone Ausführung.

=== Beispiele ===

Beispiel 1: Einen Microservice zu einem neuen Supervisor verschieben

271

272

273

Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa"

274

275

276

Dieser Befehl verschiebt den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-ffffffffffff" zu dem Supervisor mit der ID "ffffffff-ffff-ffff-ffff-aaaaaaaa".

277

278

Das Cmdlet wartet, bis der Vorgang abgeschlossen ist (Standard-Timeout von 30 Sekunden).

279

280

Beispiel 2: Mehrere Microservices zu einem neuen Supervisor verschieben und nicht auf Abschluss warten.

281

282

283

Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -NoWait

Dieser Befehl initiiert die Verschiebung der Microservices mit den Instanz-IDs "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" und "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" zu "ffffffff-ffff-ffff-ffff-aaaaaaaa" und kehrt sofort zurück, ohne auf den Abschluss des Vorgangs zu warten.

288

289

Beispiel 3: Einen Microservice verschieben mit längerem Timeout

290

291

292

Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -Timeout "5m"

293

294

295

Dieser Befehl versucht, "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" zu "ffffffff-ffff-ffff-ffff-aaaaaaaa" zu verschieben und wartet bis zu 5 Minuten auf den Abschluss des Vorgangs.

296

297

=== Rückgabewerte ===

298

299

Das Cmdlet gibt für jede verschobene Instanz ein Objekt mit folgenden Eigenschaften zurück:

300

301

* **InstanceId**: Die ID der verschobenen Microservice-Instanz

302

* **SicsUsername**: Der zugehörige Benutzername (z. B. für die Verbindung)

303

* **IsIdentified**: Gibt an, ob die Instanz eindeutig identifiziert wurde

304

* **ProcessState**: Aktueller Prozessstatus der Instanz (z. B. Stopped)

305

* **LastUpdate**: Zeitpunkt der letzten Statusänderung

306

* **Timestamp**: Zeitstempel der letzten Änderung

307

* **ProcessId**: (Optional) Prozess-ID der Instanz

308

* **CpuUsage**: (Optional) CPU-Auslastung der Instanz

309

* **RamUsage**: (Optional) RAM-Auslastung der Instanz

310

311

== Remove-AESBMicroservices ==

312

313

Dieses Cmdlet entfernt die angegebenen Microservice-Instanzen. Die zu entfernenden Microservices können entweder über ihre Instanz-Namen oder ihre Instanz-IDs identifiziert werden. Es muss einer der Parameter -//InstanceNames// oder -//InstanceIds// angegeben werden. Die Parameter können nicht zusammen verwendet werden.

|-InstanceNames|String[]|❌|Keine|Gibt die Namen der Microservices an, die entfernt werden sollen. Es kann ein einzelner Name oder ein Array von Namen übergeben werden. Obligatorisch für den Parameter-Satz //ByInstanceName//.

318

|-InstanceIds|String[]|❌|Keine|Gibt die eindeutigen Instanz-IDs (GUIDs) der Microservices an, die entfernt werden sollen. Es kann eine einzelne ID oder ein Array von IDs übergeben werden. Obligatorisch für den Parameter-Satz //ByInstanceId//.

=== Beispiele ===

Beispiel 1: Einen Microservice anhand seiner Instanz-ID entfernen

323

324

325

Remove-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"

326

327

328

Dieser Befehl entfernt den Microservice mit der Instanz-ID "b6cb7044-b6b2-4a64-9997-29f0ea5283db". Die Ausgabe zeigt die Instanz und das Ergebnis "Success".

329

330

Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs entfernen

331

332

333

Remove-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"

334

335

336

Dieser Befehl entfernt zwei Microservices, die durch ihre jeweiligen Instanz-IDs identifiziert werden.

337

338

Beispiel 3: Einen Microservice anhand seines Namens entfernen

339

340

341

Remove-AESBMicroservice -InstanceNames "MeinService"

Dieser Befehl entfernt den Microservice mit dem Namen "MeinService".

346

347

Beispiel 4: Mehrere Microservices anhand ihrer Namen entfernen und Bestätigung anfordern

348

349

350

Remove-AESBMicroservice -InstanceNames "Service1", "Service2" -Confirm

351

352

353

Dieser Befehl versucht, die Microservices "Service1" und "Service2" zu entfernen. Vor dem eigentlichen Entfernen wird der Benutzer um Bestätigung gebeten.

354

355

Beispiel 5: Microservices über die Pipeline anhand von Instanz-IDs entfernen

356

357

358

"aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" | Remove-AESBMicroservice -InstanceIds

Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Remove-Microservice`, um die entsprechenden Microservices zu entfernen.