Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zusammenfassung

• Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)
• Anhänge (0 geändert, 0 hinzugefügt, 4 gelöscht)
  • image-20230316094933-1.png
  • image-20230316095106-2.png
  • image-20230316102252-3.png
  • image-20230316102302-4.png

Details

Seiteneigenschaften

Dokument-Autor

...	...	@@ -1,1 +1,1 @@
1		-XWiki.TomAltenbrunn@sbede
	1	+XWiki.jonasmayer@sbede

Inhalt

...	...	@@ -1,8 +1,6 @@
1	1	{{toc depth="3"/}}
2	2
3		-----
4	4
5		-
6	6	= (% style="font-size:22px" %)__**Allgemeines**__(%%) =
7	7
8	8
...	...	@@ -41,9 +41,9 @@
41	41	(% style="font-size:12px" %)**Hinweis: **Skripte, die durch ihren Dateinamen auf einzelne Phasen eingeschränkt sind ((% style="color:#8e44ad; font-size:12px" %)lila eingefärbt(% style="font-size:12px" %)), dürfen sich inhaltlich zueinander unterscheiden. Dadurch kann eine Autoconf-Rolle sehr flexibel gestaltet werden und in den verschiedenen Phasen des Deployments unterschiedliche Aktionen ausführen.
42	42	)))
43	43
	42	+
44	44	----
45	45
46		-
47	47	= (% style="font-size:22px" %)__**Beispielaufbau einer logodidact.yml**__(%%) =
48	48
49	49
...	...	@@ -74,9 +74,9 @@
74	74	**Tipp:** Der Variablentyp ENUM aus dem Beispiel ergibt ein Dropdown-Menü, in dem man aus den vordefinierten 4 Werten (none / compact / detailed / verbose) auswählen kann.
75	75	)))
76	76
	75	+
77	77	----
78	78
79		-
80	80	= (% style="font-size:22px" %)__**Neue AutoConf-Rollen nach Fertigstellung freigeben**__(%%) =
81	81
82	82
...	...	@@ -93,12 +93,12 @@
93	93	[[image:attach:autoconf.png||data-xwiki-image-style-border="true" class="img-thumbnail"]]
94	94
95	95
	94	+
96	96	----
97	97
	97	+= (% style="font-size:22px" %)__**Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
98	98
99		-= (% style="font-size:22px" %)__**Funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
100	100
101		-
102	102	Zum besseren Verständnis wird nachfolgend eine feste Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
103	103
104	104	(% class="box" %)
...	...	@@ -118,7 +118,7 @@
118	118	license: SBE
119	119	(% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
120	120	visible: true
121		-(% style="color:#19177c" %) priority:(%%) 0
	119	+ priority: 0
122	122	applyAlways: false
123	123	(% style="color:#f1c40f" %) tags:(%%)
124	124	- CUSTOM
...	...	@@ -140,8 +140,6 @@
140	140
141	141	(% style="color:#8e44ad" %)**uuid**(%%) = ID der Autoconf-Regel. Muss einmalig sein. Bei einer eigenen Autoconf-Rolle sollte der Wert am besten neu generiert werden. [[https:~~/~~/www.uuidgenerator.net/>>url:https://www.uuidgenerator.net/]]
142	142
143		-(% style="color:#19177c" %)**priority**(% style="color:#2980b9" %)** **(%%)= Legt die Verarbeitungsreihenfolge der Autoconf-Rolle gegenüber weiteren Rollen fest, die in derselben Phase ausgeführt werden. Bei gleicher Priorität findet die Abarbeitung alphabetisch statt. Eine höhere Priorität führt zu früherer Ausführung.
144		-
145	145	(% style="color:#f1c40f" %)**tags**(%%) = beschreibt, in welchen Phasen die Autoconf-Regel ausgeführt wird.
146	146
147	147	(% style="color:#e74c3c" %)**vars**(%%)** **= definiert mögliche Variablen, die den Skripten übergeben werden
...	...	@@ -151,24 +151,19 @@
151	151	* type = bestimmt den Typ der Variable. Gültige Typen sind: STRING, PASSWORD, BOOLEAN, ENUM, ARRAY, INTEGER
152	152	* example = Zeigt einen grau eingefärbten Beispieltext innerhalb der definierten Variable an, ohne dass dieser als Wert festgelegt ist (Hilfsmittel für Anwender).
153	153
154		-(% style="color:#2980b9" %)**systems **(%%)= Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind WINDOWS / LINUX. Die Rolle aus dem Beispiel unterstützt beide Betriebssysteme gleichzeitig.
	150	+(% style="color:#2980b9" %) **systems **(%%)= Legt fest, welche Betriebssystem-Typen durch die Autoconf-Rolle unterstützt werden. Gültige Systeme sind WINDOWS / LINUX. Die Rolle aus dem Beispiel unterstützt beide Betriebssysteme gleichzeitig.
155	155
	152	+
156	156	----
157	157
158		-
159	159	== (% style="font-size:16px" %)**Inhalt des PowerShell-Skripts main.ps1, das die Variablen entgegennimmt**(%%) ==
160	160
161		-Im Unterverzeichnis {{box}} win/ {{/box}} oder {{box}} lin/ {{/box}} der Autoconf-Rolle können sich wie erläutert unterschiedliche PowerShell-Skripte zur Ausführung in den verschiedenen Phasen befinden.
162		-In dieser Rolle liegt konkret das allgemeingültige Skript {{box}}main.ps1{{/box}} vor, welches die Variablen als Parameter ##$ssid## und ##$psk## intern verwendet.
163	163
	158	+Im Verzeichnis {{box}} win/ {{/box}} können sich unterschiedliche Powershell-Skripte befinden. In dieser Rolle liegt das allgemeingültige Skript main.ps1 vor, welches die Variablen als Parameter ##$ssid## und ##$psk## intern verwendet.
164	164
165		-(% style="color:#19177c" %)**Windows Variante**
166		-
167		-{{code language="text" width="50%"}}
	160	+{{code width="50%"}}
168	168	root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
169		-{{/code}}
170	170
171		-{{code width="50%" language="powershell"}}
172	172	Param
173	173	(
174	174	[parameter(Mandatory=$false)]
...	...	@@ -221,146 +221,22 @@
221	221
222	222	Remove-Item -Path $file -Force
223	223	}
224		-{{/code}}
225	225
226		-
227		-(% style="color:#19177c" %)**Linux Variante (Network Manager)**
228		-
229		-{{code language="text" width="50%"}}
230		-root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/lin/main.ps1
	216	+Param() = hier werden die übergebenen Parameter von meta/logodidact.yml zu lokalen Variablen.
231	231	{{/code}}
232	232
233		-{{code language="powershell" width="50%"}}
234		-Param
235		-(
236		- [parameter(Mandatory=$false)]
237		- [String]
238		- $ssid,
239		- [parameter(Mandatory=$false)]
240		- [String]
241		- $psk
242		-)
	219	+==== ====
243	243
244		-if ($ssid -ne '' -and $psk -ne '') {
245		- if (Get-Command "nmcli" -ErrorAction SilentlyContinue) {
246		- # Check if kernel modules are up
247		- nmcli dev wifi rescan
248		- if ($LASTEXITCODE -ne 0) {
249		- Start-Sleep -Seconds 30
250		- }
251		-
252		- # Check again
253		- nmcli dev wifi rescan
254		- if ($LASTEXITCODE -ne 0) {
255		- Write-Verbose "Skipping role. There might be no WiFi device installed."
256		- exit 0
257		- }
258		-
259		- $config = "/etc/NetworkManager/system-connections/$ssid"
	221	+==== ====
260	260
261		- if (Test-Path -Path $config) {
262		- Write-Verbose "Removing '$config'"
263		- Remove-Item -Path $config -Recurse -Force
264		- }
	223	+==== ====
265	265
266		- Write-Verbose "Connecting to '$ssid'"
267		-
268		- nmcli device wifi connect """$ssid""" password """$psk"""
269		-
270		- if ($LASTEXITCODE -eq 0) {
271		- Start-Sleep -Seconds 5
272		- nmcli con up """$ssid"""
	225	+==== ====
273	273
274		- if ($LASTEXITCODE -ne 0) {
275		- Write-Verbose "Error: Credentials wrong?"
	227	+==== ====
276	276
277		- if (Test-Path -Path $config) {
278		- Write-Verbose "Removing '$config'"
279		- Remove-Item -Path $config -Recurse -Force
280		- }
281		- }
282		- }
283		-
284		- Write-Verbose "Exiting with code: $LASTEXITCODE"
285		- exit $LASTEXITCODE
286		- }
	229	+==== ====
287	287
288		- Write-Verbose "No suitable implementation found"
289		- exit 1
290		-}
291		-{{/code}}
	231	+==== ====
292	292
293		-----
294		-
295		-= (% style="font-size:22px" %)__**Beispiel: eigene AutoConf-Rolle zur "Deaktivierung der Suchhervorhebung in Windows"**__(%%) =
296		-
297		-= =
298		-
299		-(((
300		-Im nachfolgenden Beispiel wird eine einfache Rolle zur Deaktivierung der Suchvorhebung in Windows deklariert.
301		-\\[[image:attach:windowSearchHiglight-PNG.PNG||height="487" width="1051" class="img-thumbnail"]]
302		-
303		-
304		-== (% style="font-size:16px" %)**Aufbau der Logodidact.yml:**(%%) ==
305		-
306		-Neben den allgemeinen Informationen über die Autoren (authors), Unternehmen (company), einer Beschreibung (description), dem Anzeigenamen (display_name) im LD Control Center, usw, beginnt im Abschnitt {{code language="bash"}}vars{{/code}} die eigentliche Definition der Variable
307		-"**{{code language="bash"}}disableSearchHighlight{{/code}}**".
308		-
309		-{{code language="yaml" width="45%"}}
310		-#logodidact.yml
311		-
312		-ld_info:
313		- authors:
314		- - Olav Krapp
315		- - Marcel Petersen
316		- - Kerim Ekin
317		- company: SBE network solutions GmbH
318		- description: | #Beschreibung
319		- Die Suchhervorhebung in der Windows Suchleiste wird deaktiviert
320		- display_name: Windows Suchhervorhebung #Anzeigename im LD Control Center
321		- license: SBE
322		- uuid: fec4ff30-b2a6-407f-a6b3-0a621cd7eaf7 #einmalige UUID
323		- vars: #Deklaration der Variablen
324		- disableSearchHighlight: #Name der Variable
325		- display_name: Suchhervorhebung im Suchfeld deaktivieren #Anzeigename im LD Control Center
326		- optional: true #Auswahl optional
327		- type: BOOLEAN #Variablentyp Boolean = True/False
328		- value: false #Standardwert false
329		- visible: true #Sichtbarkeit der Variable im LD Control Center
330		- priority: 0 #Abarbeitungspriorität
331		- applyAlways: false #Rolle immer ausführen oder einmalig
332		- tags:
333		- - CUSTOM #Ausführungszeitpunkt während der/den Phase(n)
334		- systems:
335		- - WINDOWS #Betriebssystem
336		-{{/code}}
337		-
338		-
339		-
340		-(% style="font-size:16px" %)**Aufbau der main.ps1:**(%%)
341		-\\Danach erfolgt die Erstellung des ausführbaren Codes per Powershell. Im ersten Abschnitt Param werden die in der im vorigen Abschnitt definierten Variaben "vars" aus der logodidact.yml aufgeführt und definiert. Bei der Variable "disableSearchHighlight" handelt es sich um ein Boolean (True/False). Die Bedingung "[parameter(Mandatory=$false)]" setzt das Vorhandensein der Variable während dem Ablauf des Skriptes nicht als zwingend notwendig voraus, sodass bei einem darauffolgenden Verarbeitungsfehler o.ä. die Abarbeitung weiter erfolgt.
342		-\\{{code language="powershell"}}#main.ps1
343		-
344		-Param
345		-(
346		- [parameter(Mandatory=$false)] #Variable zwingend erforderlich?
347		- [bool] #Variablentyp
348		- $disableSearchHighlight #Name der def. Variable aus logodidact.yml
349		-)
350		-
351		-$SystemVersion=[System.Environment]::OSVersion.Version #Hole Windows Systemversion
352		-
353		-if ($SystemVersion.Major -eq 10 -and $SystemVersion.Build -ge 19044) {
354		- $val = [int]!$disableSearchHighlight
355		- Write-Verbose "Setting EnableDynamicContentInWSB to '$val'"
356		- [Microsoft.Win32.Registry]::SetValue("HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows\Windows Search","EnableDynamicContentInWSB",$val,[Microsoft.Win32.RegistryValueKind]::DWord)
357		-} else {
358		- Write-Host "Feature ist erst ab dem Release 21H2 verfügbar."
359		-}{{/code}}
360		-
361		-
362		-\\(% style="font-size:16px" %)**Einlesen der AutoConf-Rollen am Server:**(%%)
363		-\\[[image:image-20230316102252-3.png||height="122" width="1167"]]
364		-\\Ansicht im LD Control Center nach erfolgreichem Import der AutoConf-Rolle:
365		-\\[[image:image-20230316095106-2.png||class="img-thumbnail"]]
366		-)))
	233	+==== ====

image-20230316094933-1.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.TomAltenbrunn@sbede

Größe

...	...	@@ -1,1 +1,0 @@
1		-43.3 KB

Inhalt

image-20230316095106-2.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.TomAltenbrunn@sbede

Größe

...	...	@@ -1,1 +1,0 @@
1		-47.8 KB

Inhalt

image-20230316102252-3.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.TomAltenbrunn@sbede

Größe

...	...	@@ -1,1 +1,0 @@
1		-166.3 KB

Inhalt

image-20230316102302-4.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.TomAltenbrunn@sbede

Größe

...	...	@@ -1,1 +1,0 @@
1		-166.3 KB

Inhalt