Änderungen von Dokument Eigene Autoconf-Rolle erstellen

Zuletzt geändert von Tom Altenbrunn am 2023/03/17 08:03

Von Version 27.1
bearbeitet von Jonas Mayer
am 2023/03/16 07:48
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 29.2
bearbeitet von Tom Altenbrunn
am 2023/03/16 10:24
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.jonasmayer@sbede
1 +XWiki.TomAltenbrunn@sbede
Inhalt
... ... @@ -96,17 +96,9 @@
96 96  ----
97 97  
98 98  
99 += (% style="font-size:22px" %)__**Funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
99 99  
100 100  
101 -
102 -
103 -
104 -
105 -
106 -
107 -= (% style="font-size:22px" %)__**Weiteres, funktionsfertiges Beispiel: Rolle „WLAN Profil mit PSK anlegen“**__(%%) =
108 -
109 -
110 110  Zum besseren Verständnis wird nachfolgend eine feste Autoconf-Rolle zur Konfiguration eines WLAN-Profils (SSID inkl. PSK) an Clients näher beleuchtet.
111 111  
112 112  (% class="box" %)
... ... @@ -126,7 +126,7 @@
126 126   license: SBE
127 127  (% style="color:#8e44ad" %) uuid:(%%) 52318636-c4f5-11ea-baf9-0bff00c66ff4
128 128   visible: true
129 - (% style="color:#19177c" %)priority:(%%) 0
121 +(% style="color:#19177c" %) priority:(%%) 0
130 130   applyAlways: false
131 131  (% style="color:#f1c40f" %) tags:(%%)
132 132   - CUSTOM
... ... @@ -166,16 +166,17 @@
166 166  
167 167  == (% style="font-size:16px" %)**Inhalt des PowerShell-Skripts main.ps1, das die Variablen entgegennimmt**(%%) ==
168 168  
169 -Im Unterverzeichnis {{box}} win/ {{/box}} oder {{box}} lin/ {{/box}} der Autoconf-Rolle können sich unterschiedliche PowerShell-Skripte zur Ausführung in den Phasen befinden. In dieser Rolle liegt das allgemeingültige Skript {{box}}main.ps1{{/box}} vor, welches die Variablen als Parameter ##$ssid## und ##$psk## intern verwendet.
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.
170 170  
171 -(% class="box" %)
172 -(((
173 -(% style="color:#27ae60" %)# Windows Variante(%%)
174 -root@ctrl-g1:~~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
175 -)))
176 176  
165 +(% style="color:#19177c" %)**Windows Variante**
177 177  
178 -{{code width="50%"}}
167 +{{code language="text" width="50%"}}
168 +root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/win/main.ps1
169 +{{/code}}
170 +
171 +{{code width="50%" language="powershell"}}
179 179  Param
180 180  (
181 181   [parameter(Mandatory=$false)]
... ... @@ -230,18 +230,140 @@
230 230  }
231 231  {{/code}}
232 232  
233 -==== ====
234 234  
235 -==== ====
227 +(% style="color:#19177c" %)**Linux Variante (Network Manager)**
236 236  
237 -==== ====
229 +{{code language="text" width="50%"}}
230 +root@ctrl-g1:~ # cat /usr/lib/ld-autoconf/logodidact/roles/ld_wlan_psk/lin/main.ps1
231 +{{/code}}
238 238  
239 -==== ====
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 +)
240 240  
241 -==== ====
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"
242 242  
243 -==== ====
261 + if (Test-Path -Path $config) {
262 + Write-Verbose "Removing '$config'"
263 + Remove-Item -Path $config -Recurse -Force
264 + }
244 244  
245 -==== ====
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"""
246 246  
247 -==== ====
274 + if ($LASTEXITCODE -ne 0) {
275 + Write-Verbose "Error: Credentials wrong?"
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 + }
287 +
288 + Write-Verbose "No suitable implementation found"
289 + exit 1
290 +}
291 +{{/code}}
292 +
293 +----
294 +
295 += (% style="font-size:22px" %)__**Beispiel: eigene AutoConf-Rolle zur "Deaktivierung der Suchhervorhebung in Windows"**__(%%)
296 + =
297 +
298 +(((
299 +Im nachfolgenden Beispiel wird eine einfache Rolle zur Deaktivierung der Suchvorhebung in Windows deklariert. 
300 +\\[[image:attach:windowSearchHiglight-PNG.PNG||height="487" width="1051" class="img-thumbnail"]]
301 +
302 +
303 +== (% style="font-size:16px" %)**Aufbau der Logodidact.yml:**(%%) ==
304 +
305 +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
306 +"**{{code language="bash"}}disableSearchHighlight{{/code}}**".
307 +
308 +{{code language="yaml" width="45%"}}
309 +#logodidact.yml
310 +
311 +ld_info:
312 + authors:
313 + - Olav Krapp
314 + - Marcel Petersen
315 + - Kerim Ekin
316 + company: SBE network solutions GmbH
317 + description: | #Beschreibung
318 + Die Suchhervorhebung in der Windows Suchleiste wird deaktiviert
319 + display_name: Windows Suchhervorhebung #Anzeigename im LD Control Center
320 + license: SBE
321 + uuid: fec4ff30-b2a6-407f-a6b3-0a621cd7eaf7 #einmalige UUID
322 + vars: #Deklaration der Variablen
323 + disableSearchHighlight: #Name der Variable
324 + display_name: Suchhervorhebung im Suchfeld deaktivieren #Anzeigename im LD Control Center
325 + optional: true #Auswahl optional
326 + type: BOOLEAN #Variablentyp Boolean = True/False
327 + value: false #Standardwert false
328 + visible: true #Sichtbarkeit der Variable im LD Control Center
329 + priority: 0 #Abarbeitungspriorität
330 + applyAlways: false #Rolle immer ausführen oder einmalig
331 + tags:
332 + - CUSTOM #Ausführungszeitpunkt während der/den Phase(n)
333 + systems:
334 + - WINDOWS #Betriebssystem
335 +{{/code}}
336 +
337 +(% style="font-size:16px" %)**Aufbau der main.ps1:**(%%)
338 +\\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.
339 +\\{{code language="powershell"}}#main.ps1
340 +
341 +Param
342 +(
343 + [parameter(Mandatory=$false)] #Variable zwingend erforderlich?
344 + [bool] #Variablentyp
345 + $disableSearchHighlight #Name der def. Variable aus logodidact.yml
346 +)
347 +
348 +$SystemVersion=[System.Environment]::OSVersion.Version #Hole Windows Systemversion
349 +
350 +if ($SystemVersion.Major -eq 10 -and $SystemVersion.Build -ge 19044) {
351 + $val = [int]!$disableSearchHighlight
352 + Write-Verbose "Setting EnableDynamicContentInWSB to '$val'"
353 + [Microsoft.Win32.Registry]::SetValue("HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows\Windows Search","EnableDynamicContentInWSB",$val,[Microsoft.Win32.RegistryValueKind]::DWord)
354 +} else {
355 + Write-Host "Feature ist erst ab dem Release 21H2 verfügbar."
356 +}{{/code}}
357 +
358 +\\\\(% style="font-size:16px" %)**Einlesen der AutoConf-Rollen am Server:**(%%)
359 +[[image:image-20230316102252-3.png||height="122" width="1167"]]
360 +\\Ansicht im LD Control Center nach erfolgreichem Import der AutoConf-Rolle:
361 +\\[[image:image-20230316095106-2.png||class="img-thumbnail"]]
362 +)))
image-20230316094933-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +43.3 KB
Inhalt
image-20230316095106-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +47.8 KB
Inhalt
image-20230316102252-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +166.3 KB
Inhalt
image-20230316102302-4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.TomAltenbrunn@sbede
Größe
... ... @@ -1,0 +1,1 @@
1 +166.3 KB
Inhalt