Tworzenie modułów PowerShell

Tworzenie modułów PowerShell pozwala grupować własne funkcje administracyjne do wielokrotnego użytku.

Moduł PowerShell jako uporządkowany zestaw poleceń

Moduł PowerShell to pakiet przeznaczony do wielokrotnego użycia, który może zawierać funkcje, skrypty, aliasy, zmienne, klasy, pliki formatowania oraz pliki danych. Najczęściej moduł jest przechowywany w osobnym katalogu, a jego główny plik ma rozszerzenie .psm1. Nazwa katalogu modułu powinna odpowiadać nazwie pliku modułu, ponieważ PowerShell wykorzystuje tę strukturę podczas wyszukiwania i ładowania pakietu. Przykładowo moduł o nazwie DiagnostykaPC może znajdować się w katalogu DiagnostykaPC i zawierać plik DiagnostykaPC.psm1.

Wewnątrz modułu można umieścić funkcje wykonujące konkretne czynności, takie jak odczyt informacji o systemie, sprawdzenie wolnego miejsca na dysku, zebranie danych o pamięci RAM albo analiza wybranych wpisów dziennika zdarzeń. Funkcja przeznaczona do użycia poza modułem powinna mieć jasno określone parametry, typy danych i sposób raportowania wyników. Dobrą praktyką jest zwracanie obiektów PowerShell zamiast gotowych komunikatów tekstowych, ponieważ obiekty można dalej filtrować poleceniami Where-Object, sortować przez Sort-Object i eksportować do formatów takich jak CSV.

Struktura plików i udostępnianie funkcji

Moduł może zawierać plik manifestu z rozszerzeniem .psd1. Manifest opisuje między innymi nazwę modułu, jego wersję, autora, wymagane moduły oraz funkcje, cmdlety, zmienne i aliasy eksportowane na zewnątrz. Manifest można utworzyć poleceniem New-ModuleManifest. Jawne określenie elementów eksportowanych przez moduł ogranicza przypadkowe udostępnienie funkcji pomocniczych i ułatwia utrzymanie stabilnego interfejsu.

W pliku .psm1 można użyć polecenia Export-ModuleMember, aby wskazać funkcje lub aliasy dostępne po zaimportowaniu modułu. Funkcje pomocnicze pozostawione poza eksportem nadal mogą być używane wewnątrz modułu, ale nie powinny być traktowane jako publiczne polecenia. Moduł zapisany w jednym z katalogów znajdujących się w zmiennej $env:PSModulePath może zostać znaleziony przez PowerShell automatycznie. Dostępne lokalizacje można sprawdzić poleceniem $env:PSModulePath -split ';' w systemie Windows. Informacje o znalezionych modułach pokazuje Get-Module -ListAvailable, a zaimportowanie konkretnego modułu wykonuje Import-Module DiagnostykaPC.

Parametry, zależności i testowanie modułu

Funkcje modułu powinny walidować dane wejściowe, zwłaszcza ścieżki, nazwy komputerów, zakresy liczbowe i wartości przełączników. Do tego celu służą między innymi atrybuty [Parameter()], [ValidateSet()], [ValidateRange()] oraz [ValidateNotNullOrEmpty()]. Parametr oznaczony jako obowiązkowy może wymusić podanie wartości przed uruchomieniem funkcji. Warto także rozdzielać pobieranie danych, ich przetwarzanie i prezentację, aby ten sam kod można było wykorzystać w konsoli, zadaniu automatycznym lub skrypcie generującym raport.

Jeżeli moduł korzysta z innych modułów, wymagania te można opisać w manifeście. Przed wdrożeniem należy sprawdzić, czy zależności są dostępne w środowisku docelowym oraz czy użytkownik ma uprawnienia potrzebne do wykonania określonych operacji. Podstawowe testy obejmują import modułu, wywołanie funkcji z poprawnymi i niepoprawnymi parametrami, zachowanie przy braku pliku lub urządzenia oraz sprawdzenie typu i zawartości zwracanych obiektów. Do diagnostyki można używać Get-Command -Module DiagnostykaPC, Get-Help i Get-Member. Jeśli moduł ma być dystrybuowany, pomocne jest również nadanie funkcjom komentarzy pomocy w formacie rozpoznawanym przez PowerShell.

Wykorzystanie modułów przy obsłudze komputerów

Moduły PowerShell mogą usprawniać powtarzalne czynności wykonywane na laptopach i komputerach PC. Przykładowy moduł diagnostyczny może zwracać informacje o wersji systemu, modelu urządzenia, stanie baterii, dostępnej przestrzeni dyskowej, aktywnych interfejsach sieciowych i podstawowych usługach. Każda funkcja powinna jasno określać, jakie dane odczytuje i jakie ograniczenia ma jej wynik. Odczyt informacji nie oznacza automatycznie możliwości naprawy problemu, dlatego raport powinien rozróżniać dane diagnostyczne od czynności zmieniających konfigurację.

W praktyce moduł może stanowić część procedury serwisowej używanej do zebrania powtarzalnego zestawu informacji przed naprawą, po wymianie podzespołu albo po reinstalacji systemu. Operacje modyfikujące ustawienia, usuwające pliki lub zatrzymujące usługi powinny być oddzielone od funkcji odczytowych i wymagać jednoznacznego parametru potwierdzającego. Warszawskie Pogotowie Komputerowe zajmuje się profesjonalną naprawą laptopów, komputerów PC i ich podzespołów, a moduły PowerShell mogą wspierać technika w uporządkowanym zbieraniu informacji o stanie diagnozowanego urządzenia.